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 /* try to expire 10 keys/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 static void _redisAssert(char *estr
, char *file
, int line
);
242 /*================================= Data types ============================== */
244 /* A redis object, that is a type able to hold a string / list / set */
246 /* The VM object structure */
247 struct redisObjectVM
{
248 off_t page
; /* the page at witch the object is stored on disk */
249 off_t usedpages
; /* number of pages used on disk */
250 time_t atime
; /* Last access time */
253 /* The actual Redis Object */
254 typedef struct redisObject
{
257 unsigned char encoding
;
258 unsigned char storage
; /* If this object is a key, where is the value?
259 * REDIS_VM_MEMORY, REDIS_VM_SWAPPED, ... */
260 unsigned char vtype
; /* If this object is a key, and value is swapped out,
261 * this is the type of the swapped out object. */
263 /* VM fields, this are only allocated if VM is active, otherwise the
264 * object allocation function will just allocate
265 * sizeof(redisObjct) minus sizeof(redisObjectVM), so using
266 * Redis without VM active will not have any overhead. */
267 struct redisObjectVM vm
;
270 /* Macro used to initalize a Redis object allocated on the stack.
271 * Note that this macro is taken near the structure definition to make sure
272 * we'll update it when the structure is changed, to avoid bugs like
273 * bug #85 introduced exactly in this way. */
274 #define initStaticStringObject(_var,_ptr) do { \
276 _var.type = REDIS_STRING; \
277 _var.encoding = REDIS_ENCODING_RAW; \
279 if (server.vm_enabled) _var.storage = REDIS_VM_MEMORY; \
282 typedef struct redisDb
{
283 dict
*dict
; /* The keyspace for this DB */
284 dict
*expires
; /* Timeout of keys with a timeout set */
285 dict
*blockingkeys
; /* Keys with clients waiting for data (BLPOP) */
286 dict
*io_keys
; /* Keys with clients waiting for VM I/O */
290 /* Client MULTI/EXEC state */
291 typedef struct multiCmd
{
294 struct redisCommand
*cmd
;
297 typedef struct multiState
{
298 multiCmd
*commands
; /* Array of MULTI commands */
299 int count
; /* Total number of MULTI commands */
302 /* With multiplexing we need to take per-clinet state.
303 * Clients are taken in a liked list. */
304 typedef struct redisClient
{
309 robj
**argv
, **mbargv
;
311 int bulklen
; /* bulk read len. -1 if not in bulk read mode */
312 int multibulk
; /* multi bulk command format active */
315 time_t lastinteraction
; /* time of the last interaction, used for timeout */
316 int flags
; /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
317 int slaveseldb
; /* slave selected db, if this client is a slave */
318 int authenticated
; /* when requirepass is non-NULL */
319 int replstate
; /* replication state if this is a slave */
320 int repldbfd
; /* replication DB file descriptor */
321 long repldboff
; /* replication DB file offset */
322 off_t repldbsize
; /* replication DB file size */
323 multiState mstate
; /* MULTI/EXEC state */
324 robj
**blockingkeys
; /* The key we are waiting to terminate a blocking
325 * operation such as BLPOP. Otherwise NULL. */
326 int blockingkeysnum
; /* Number of blocking keys */
327 time_t blockingto
; /* Blocking operation timeout. If UNIX current time
328 * is >= blockingto then the operation timed out. */
329 list
*io_keys
; /* Keys this client is waiting to be loaded from the
330 * swap file in order to continue. */
331 dict
*pubsub_channels
; /* channels a client is interested in (SUBSCRIBE) */
332 list
*pubsub_patterns
; /* patterns a client is interested in (SUBSCRIBE) */
340 /* Global server state structure */
345 dict
*sharingpool
; /* Poll used for object sharing */
346 unsigned int sharingpoolsize
;
347 long long dirty
; /* changes to DB from the last save */
349 list
*slaves
, *monitors
;
350 char neterr
[ANET_ERR_LEN
];
352 int cronloops
; /* number of times the cron function run */
353 list
*objfreelist
; /* A list of freed objects to avoid malloc() */
354 time_t lastsave
; /* Unix time of last save succeeede */
355 /* Fields used only for stats */
356 time_t stat_starttime
; /* server start time */
357 long long stat_numcommands
; /* number of processed commands */
358 long long stat_numconnections
; /* number of connections received */
359 long long stat_expiredkeys
; /* number of expired keys */
372 pid_t bgsavechildpid
;
373 pid_t bgrewritechildpid
;
374 sds bgrewritebuf
; /* buffer taken by parent during oppend only rewrite */
375 struct saveparam
*saveparams
;
380 char *appendfilename
;
384 /* Replication related */
389 redisClient
*master
; /* client that is master for this slave */
391 unsigned int maxclients
;
392 unsigned long long maxmemory
;
393 unsigned int blpop_blocked_clients
;
394 unsigned int vm_blocked_clients
;
395 /* Sort parameters - qsort_r() is only available under BSD so we
396 * have to take this state global, in order to pass it to sortCompare() */
400 /* Virtual memory configuration */
405 unsigned long long vm_max_memory
;
407 size_t hash_max_zipmap_entries
;
408 size_t hash_max_zipmap_value
;
409 /* Virtual memory state */
412 off_t vm_next_page
; /* Next probably empty page */
413 off_t vm_near_pages
; /* Number of pages allocated sequentially */
414 unsigned char *vm_bitmap
; /* Bitmap of free/used pages */
415 time_t unixtime
; /* Unix time sampled every second. */
416 /* Virtual memory I/O threads stuff */
417 /* An I/O thread process an element taken from the io_jobs queue and
418 * put the result of the operation in the io_done list. While the
419 * job is being processed, it's put on io_processing queue. */
420 list
*io_newjobs
; /* List of VM I/O jobs yet to be processed */
421 list
*io_processing
; /* List of VM I/O jobs being processed */
422 list
*io_processed
; /* List of VM I/O jobs already processed */
423 list
*io_ready_clients
; /* Clients ready to be unblocked. All keys loaded */
424 pthread_mutex_t io_mutex
; /* lock to access io_jobs/io_done/io_thread_job */
425 pthread_mutex_t obj_freelist_mutex
; /* safe redis objects creation/free */
426 pthread_mutex_t io_swapfile_mutex
; /* So we can lseek + write */
427 pthread_attr_t io_threads_attr
; /* attributes for threads creation */
428 int io_active_threads
; /* Number of running I/O threads */
429 int vm_max_threads
; /* Max number of I/O threads running at the same time */
430 /* Our main thread is blocked on the event loop, locking for sockets ready
431 * to be read or written, so when a threaded I/O operation is ready to be
432 * processed by the main thread, the I/O thread will use a unix pipe to
433 * awake the main thread. The followings are the two pipe FDs. */
434 int io_ready_pipe_read
;
435 int io_ready_pipe_write
;
436 /* Virtual memory stats */
437 unsigned long long vm_stats_used_pages
;
438 unsigned long long vm_stats_swapped_objects
;
439 unsigned long long vm_stats_swapouts
;
440 unsigned long long vm_stats_swapins
;
442 dict
*pubsub_channels
; /* Map channels to list of subscribed clients */
443 list
*pubsub_patterns
; /* A list of pubsub_patterns */
448 typedef struct pubsubPattern
{
453 typedef void redisCommandProc(redisClient
*c
);
454 struct redisCommand
{
456 redisCommandProc
*proc
;
459 /* Use a function to determine which keys need to be loaded
460 * in the background prior to executing this command. Takes precedence
461 * over vm_firstkey and others, ignored when NULL */
462 redisCommandProc
*vm_preload_proc
;
463 /* What keys should be loaded in background when calling this command? */
464 int vm_firstkey
; /* The first argument that's a key (0 = no keys) */
465 int vm_lastkey
; /* THe last argument that's a key */
466 int vm_keystep
; /* The step between first and last key */
469 struct redisFunctionSym
{
471 unsigned long pointer
;
474 typedef struct _redisSortObject
{
482 typedef struct _redisSortOperation
{
485 } redisSortOperation
;
487 /* ZSETs use a specialized version of Skiplists */
489 typedef struct zskiplistNode
{
490 struct zskiplistNode
**forward
;
491 struct zskiplistNode
*backward
;
497 typedef struct zskiplist
{
498 struct zskiplistNode
*header
, *tail
;
499 unsigned long length
;
503 typedef struct zset
{
508 /* Our shared "common" objects */
510 struct sharedObjectsStruct
{
511 robj
*crlf
, *ok
, *err
, *emptybulk
, *czero
, *cone
, *pong
, *space
,
512 *colon
, *nullbulk
, *nullmultibulk
, *queued
,
513 *emptymultibulk
, *wrongtypeerr
, *nokeyerr
, *syntaxerr
, *sameobjecterr
,
514 *outofrangeerr
, *plus
,
515 *select0
, *select1
, *select2
, *select3
, *select4
,
516 *select5
, *select6
, *select7
, *select8
, *select9
,
517 *messagebulk
, *subscribebulk
, *unsubscribebulk
, *mbulk3
,
518 *psubscribebulk
, *punsubscribebulk
;
521 /* Global vars that are actally used as constants. The following double
522 * values are used for double on-disk serialization, and are initialized
523 * at runtime to avoid strange compiler optimizations. */
525 static double R_Zero
, R_PosInf
, R_NegInf
, R_Nan
;
527 /* VM threaded I/O request message */
528 #define REDIS_IOJOB_LOAD 0 /* Load from disk to memory */
529 #define REDIS_IOJOB_PREPARE_SWAP 1 /* Compute needed pages */
530 #define REDIS_IOJOB_DO_SWAP 2 /* Swap from memory to disk */
531 typedef struct iojob
{
532 int type
; /* Request type, REDIS_IOJOB_* */
533 redisDb
*db
;/* Redis database */
534 robj
*key
; /* This I/O request is about swapping this key */
535 robj
*val
; /* the value to swap for REDIS_IOREQ_*_SWAP, otherwise this
536 * field is populated by the I/O thread for REDIS_IOREQ_LOAD. */
537 off_t page
; /* Swap page where to read/write the object */
538 off_t pages
; /* Swap pages needed to save object. PREPARE_SWAP return val */
539 int canceled
; /* True if this command was canceled by blocking side of VM */
540 pthread_t thread
; /* ID of the thread processing this entry */
543 /*================================ Prototypes =============================== */
545 static void freeStringObject(robj
*o
);
546 static void freeListObject(robj
*o
);
547 static void freeSetObject(robj
*o
);
548 static void decrRefCount(void *o
);
549 static robj
*createObject(int type
, void *ptr
);
550 static void freeClient(redisClient
*c
);
551 static int rdbLoad(char *filename
);
552 static void addReply(redisClient
*c
, robj
*obj
);
553 static void addReplySds(redisClient
*c
, sds s
);
554 static void incrRefCount(robj
*o
);
555 static int rdbSaveBackground(char *filename
);
556 static robj
*createStringObject(char *ptr
, size_t len
);
557 static robj
*dupStringObject(robj
*o
);
558 static void replicationFeedSlaves(list
*slaves
, int dictid
, robj
**argv
, int argc
);
559 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
560 static int syncWithMaster(void);
561 static robj
*tryObjectSharing(robj
*o
);
562 static int tryObjectEncoding(robj
*o
);
563 static robj
*getDecodedObject(robj
*o
);
564 static int removeExpire(redisDb
*db
, robj
*key
);
565 static int expireIfNeeded(redisDb
*db
, robj
*key
);
566 static int deleteIfVolatile(redisDb
*db
, robj
*key
);
567 static int deleteIfSwapped(redisDb
*db
, robj
*key
);
568 static int deleteKey(redisDb
*db
, robj
*key
);
569 static time_t getExpire(redisDb
*db
, robj
*key
);
570 static int setExpire(redisDb
*db
, robj
*key
, time_t when
);
571 static void updateSlavesWaitingBgsave(int bgsaveerr
);
572 static void freeMemoryIfNeeded(void);
573 static int processCommand(redisClient
*c
);
574 static void setupSigSegvAction(void);
575 static void rdbRemoveTempFile(pid_t childpid
);
576 static void aofRemoveTempFile(pid_t childpid
);
577 static size_t stringObjectLen(robj
*o
);
578 static void processInputBuffer(redisClient
*c
);
579 static zskiplist
*zslCreate(void);
580 static void zslFree(zskiplist
*zsl
);
581 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
);
582 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
583 static void initClientMultiState(redisClient
*c
);
584 static void freeClientMultiState(redisClient
*c
);
585 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
);
586 static void unblockClientWaitingData(redisClient
*c
);
587 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
);
588 static void vmInit(void);
589 static void vmMarkPagesFree(off_t page
, off_t count
);
590 static robj
*vmLoadObject(robj
*key
);
591 static robj
*vmPreviewObject(robj
*key
);
592 static int vmSwapOneObjectBlocking(void);
593 static int vmSwapOneObjectThreaded(void);
594 static int vmCanSwapOut(void);
595 static int tryFreeOneObjectFromFreelist(void);
596 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
597 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
598 static void vmCancelThreadedIOJob(robj
*o
);
599 static void lockThreadedIO(void);
600 static void unlockThreadedIO(void);
601 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
);
602 static void freeIOJob(iojob
*j
);
603 static void queueIOJob(iojob
*j
);
604 static int vmWriteObjectOnSwap(robj
*o
, off_t page
);
605 static robj
*vmReadObjectFromSwap(off_t page
, int type
);
606 static void waitEmptyIOJobsQueue(void);
607 static void vmReopenSwapFile(void);
608 static int vmFreePage(off_t page
);
609 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
);
610 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
);
611 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
);
612 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
);
613 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
614 static struct redisCommand
*lookupCommand(char *name
);
615 static void call(redisClient
*c
, struct redisCommand
*cmd
);
616 static void resetClient(redisClient
*c
);
617 static void convertToRealHash(robj
*o
);
618 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
);
619 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
);
620 static void freePubsubPattern(void *p
);
621 static int listMatchPubsubPattern(void *a
, void *b
);
622 static int compareStringObjects(robj
*a
, robj
*b
);
625 static void authCommand(redisClient
*c
);
626 static void pingCommand(redisClient
*c
);
627 static void echoCommand(redisClient
*c
);
628 static void setCommand(redisClient
*c
);
629 static void setnxCommand(redisClient
*c
);
630 static void getCommand(redisClient
*c
);
631 static void delCommand(redisClient
*c
);
632 static void existsCommand(redisClient
*c
);
633 static void incrCommand(redisClient
*c
);
634 static void decrCommand(redisClient
*c
);
635 static void incrbyCommand(redisClient
*c
);
636 static void decrbyCommand(redisClient
*c
);
637 static void selectCommand(redisClient
*c
);
638 static void randomkeyCommand(redisClient
*c
);
639 static void keysCommand(redisClient
*c
);
640 static void dbsizeCommand(redisClient
*c
);
641 static void lastsaveCommand(redisClient
*c
);
642 static void saveCommand(redisClient
*c
);
643 static void bgsaveCommand(redisClient
*c
);
644 static void bgrewriteaofCommand(redisClient
*c
);
645 static void shutdownCommand(redisClient
*c
);
646 static void moveCommand(redisClient
*c
);
647 static void renameCommand(redisClient
*c
);
648 static void renamenxCommand(redisClient
*c
);
649 static void lpushCommand(redisClient
*c
);
650 static void rpushCommand(redisClient
*c
);
651 static void lpopCommand(redisClient
*c
);
652 static void rpopCommand(redisClient
*c
);
653 static void llenCommand(redisClient
*c
);
654 static void lindexCommand(redisClient
*c
);
655 static void lrangeCommand(redisClient
*c
);
656 static void ltrimCommand(redisClient
*c
);
657 static void typeCommand(redisClient
*c
);
658 static void lsetCommand(redisClient
*c
);
659 static void saddCommand(redisClient
*c
);
660 static void sremCommand(redisClient
*c
);
661 static void smoveCommand(redisClient
*c
);
662 static void sismemberCommand(redisClient
*c
);
663 static void scardCommand(redisClient
*c
);
664 static void spopCommand(redisClient
*c
);
665 static void srandmemberCommand(redisClient
*c
);
666 static void sinterCommand(redisClient
*c
);
667 static void sinterstoreCommand(redisClient
*c
);
668 static void sunionCommand(redisClient
*c
);
669 static void sunionstoreCommand(redisClient
*c
);
670 static void sdiffCommand(redisClient
*c
);
671 static void sdiffstoreCommand(redisClient
*c
);
672 static void syncCommand(redisClient
*c
);
673 static void flushdbCommand(redisClient
*c
);
674 static void flushallCommand(redisClient
*c
);
675 static void sortCommand(redisClient
*c
);
676 static void lremCommand(redisClient
*c
);
677 static void rpoplpushcommand(redisClient
*c
);
678 static void infoCommand(redisClient
*c
);
679 static void mgetCommand(redisClient
*c
);
680 static void monitorCommand(redisClient
*c
);
681 static void expireCommand(redisClient
*c
);
682 static void expireatCommand(redisClient
*c
);
683 static void getsetCommand(redisClient
*c
);
684 static void ttlCommand(redisClient
*c
);
685 static void slaveofCommand(redisClient
*c
);
686 static void debugCommand(redisClient
*c
);
687 static void msetCommand(redisClient
*c
);
688 static void msetnxCommand(redisClient
*c
);
689 static void zaddCommand(redisClient
*c
);
690 static void zincrbyCommand(redisClient
*c
);
691 static void zrangeCommand(redisClient
*c
);
692 static void zrangebyscoreCommand(redisClient
*c
);
693 static void zcountCommand(redisClient
*c
);
694 static void zrevrangeCommand(redisClient
*c
);
695 static void zcardCommand(redisClient
*c
);
696 static void zremCommand(redisClient
*c
);
697 static void zscoreCommand(redisClient
*c
);
698 static void zremrangebyscoreCommand(redisClient
*c
);
699 static void multiCommand(redisClient
*c
);
700 static void execCommand(redisClient
*c
);
701 static void discardCommand(redisClient
*c
);
702 static void blpopCommand(redisClient
*c
);
703 static void brpopCommand(redisClient
*c
);
704 static void appendCommand(redisClient
*c
);
705 static void substrCommand(redisClient
*c
);
706 static void zrankCommand(redisClient
*c
);
707 static void zrevrankCommand(redisClient
*c
);
708 static void hsetCommand(redisClient
*c
);
709 static void hgetCommand(redisClient
*c
);
710 static void hdelCommand(redisClient
*c
);
711 static void hlenCommand(redisClient
*c
);
712 static void zremrangebyrankCommand(redisClient
*c
);
713 static void zunionCommand(redisClient
*c
);
714 static void zinterCommand(redisClient
*c
);
715 static void hkeysCommand(redisClient
*c
);
716 static void hvalsCommand(redisClient
*c
);
717 static void hgetallCommand(redisClient
*c
);
718 static void hexistsCommand(redisClient
*c
);
719 static void configCommand(redisClient
*c
);
720 static void hincrbyCommand(redisClient
*c
);
721 static void subscribeCommand(redisClient
*c
);
722 static void unsubscribeCommand(redisClient
*c
);
723 static void psubscribeCommand(redisClient
*c
);
724 static void punsubscribeCommand(redisClient
*c
);
725 static void publishCommand(redisClient
*c
);
727 /*================================= Globals ================================= */
730 static struct redisServer server
; /* server global state */
731 static struct redisCommand cmdTable
[] = {
732 {"get",getCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
733 {"set",setCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
734 {"setnx",setnxCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
735 {"append",appendCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
736 {"substr",substrCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
737 {"del",delCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
738 {"exists",existsCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
739 {"incr",incrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
740 {"decr",decrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
741 {"mget",mgetCommand
,-2,REDIS_CMD_INLINE
,NULL
,1,-1,1},
742 {"rpush",rpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
743 {"lpush",lpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
744 {"rpop",rpopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
745 {"lpop",lpopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
746 {"brpop",brpopCommand
,-3,REDIS_CMD_INLINE
,NULL
,1,1,1},
747 {"blpop",blpopCommand
,-3,REDIS_CMD_INLINE
,NULL
,1,1,1},
748 {"llen",llenCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
749 {"lindex",lindexCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
750 {"lset",lsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
751 {"lrange",lrangeCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
752 {"ltrim",ltrimCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
753 {"lrem",lremCommand
,4,REDIS_CMD_BULK
,NULL
,1,1,1},
754 {"rpoplpush",rpoplpushcommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,2,1},
755 {"sadd",saddCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
756 {"srem",sremCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
757 {"smove",smoveCommand
,4,REDIS_CMD_BULK
,NULL
,1,2,1},
758 {"sismember",sismemberCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
759 {"scard",scardCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
760 {"spop",spopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
761 {"srandmember",srandmemberCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
762 {"sinter",sinterCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
763 {"sinterstore",sinterstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
764 {"sunion",sunionCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
765 {"sunionstore",sunionstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
766 {"sdiff",sdiffCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
767 {"sdiffstore",sdiffstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
768 {"smembers",sinterCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
769 {"zadd",zaddCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
770 {"zincrby",zincrbyCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
771 {"zrem",zremCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
772 {"zremrangebyscore",zremrangebyscoreCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
773 {"zremrangebyrank",zremrangebyrankCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
774 {"zunion",zunionCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,zunionInterBlockClientOnSwappedKeys
,0,0,0},
775 {"zinter",zinterCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,zunionInterBlockClientOnSwappedKeys
,0,0,0},
776 {"zrange",zrangeCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
777 {"zrangebyscore",zrangebyscoreCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
778 {"zcount",zcountCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
779 {"zrevrange",zrevrangeCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
780 {"zcard",zcardCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
781 {"zscore",zscoreCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
782 {"zrank",zrankCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
783 {"zrevrank",zrevrankCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
784 {"hset",hsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
785 {"hincrby",hincrbyCommand
,4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
786 {"hget",hgetCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
787 {"hdel",hdelCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
788 {"hlen",hlenCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
789 {"hkeys",hkeysCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
790 {"hvals",hvalsCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
791 {"hgetall",hgetallCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
792 {"hexists",hexistsCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
793 {"incrby",incrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
794 {"decrby",decrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
795 {"getset",getsetCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
796 {"mset",msetCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,-1,2},
797 {"msetnx",msetnxCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,-1,2},
798 {"randomkey",randomkeyCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
799 {"select",selectCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
800 {"move",moveCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
801 {"rename",renameCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
802 {"renamenx",renamenxCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
803 {"expire",expireCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
804 {"expireat",expireatCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
805 {"keys",keysCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
806 {"dbsize",dbsizeCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
807 {"auth",authCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
808 {"ping",pingCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
809 {"echo",echoCommand
,2,REDIS_CMD_BULK
,NULL
,0,0,0},
810 {"save",saveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
811 {"bgsave",bgsaveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
812 {"bgrewriteaof",bgrewriteaofCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
813 {"shutdown",shutdownCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
814 {"lastsave",lastsaveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
815 {"type",typeCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
816 {"multi",multiCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
817 {"exec",execCommand
,1,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
818 {"discard",discardCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
819 {"sync",syncCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
820 {"flushdb",flushdbCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
821 {"flushall",flushallCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
822 {"sort",sortCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
823 {"info",infoCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
824 {"monitor",monitorCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
825 {"ttl",ttlCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
826 {"slaveof",slaveofCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
827 {"debug",debugCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
828 {"config",configCommand
,-2,REDIS_CMD_BULK
,NULL
,0,0,0},
829 {"subscribe",subscribeCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
830 {"unsubscribe",unsubscribeCommand
,-1,REDIS_CMD_INLINE
,NULL
,0,0,0},
831 {"psubscribe",psubscribeCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
832 {"punsubscribe",punsubscribeCommand
,-1,REDIS_CMD_INLINE
,NULL
,0,0,0},
833 {"publish",publishCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_FORCE_REPLICATION
,NULL
,0,0,0},
834 {NULL
,NULL
,0,0,NULL
,0,0,0}
837 /*============================ Utility functions ============================ */
839 /* Glob-style pattern matching. */
840 static int stringmatchlen(const char *pattern
, int patternLen
,
841 const char *string
, int stringLen
, int nocase
)
846 while (pattern
[1] == '*') {
851 return 1; /* match */
853 if (stringmatchlen(pattern
+1, patternLen
-1,
854 string
, stringLen
, nocase
))
855 return 1; /* match */
859 return 0; /* no match */
863 return 0; /* no match */
873 not = pattern
[0] == '^';
880 if (pattern
[0] == '\\') {
883 if (pattern
[0] == string
[0])
885 } else if (pattern
[0] == ']') {
887 } else if (patternLen
== 0) {
891 } else if (pattern
[1] == '-' && patternLen
>= 3) {
892 int start
= pattern
[0];
893 int end
= pattern
[2];
901 start
= tolower(start
);
907 if (c
>= start
&& c
<= end
)
911 if (pattern
[0] == string
[0])
914 if (tolower((int)pattern
[0]) == tolower((int)string
[0]))
924 return 0; /* no match */
930 if (patternLen
>= 2) {
937 if (pattern
[0] != string
[0])
938 return 0; /* no match */
940 if (tolower((int)pattern
[0]) != tolower((int)string
[0]))
941 return 0; /* no match */
949 if (stringLen
== 0) {
950 while(*pattern
== '*') {
957 if (patternLen
== 0 && stringLen
== 0)
962 static int stringmatch(const char *pattern
, const char *string
, int nocase
) {
963 return stringmatchlen(pattern
,strlen(pattern
),string
,strlen(string
),nocase
);
966 static void redisLog(int level
, const char *fmt
, ...) {
970 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
974 if (level
>= server
.verbosity
) {
980 strftime(buf
,64,"%d %b %H:%M:%S",localtime(&now
));
981 fprintf(fp
,"[%d] %s %c ",(int)getpid(),buf
,c
[level
]);
982 vfprintf(fp
, fmt
, ap
);
988 if (server
.logfile
) fclose(fp
);
991 /*====================== Hash table type implementation ==================== */
993 /* This is an hash table type that uses the SDS dynamic strings libary as
994 * keys and radis objects as values (objects can hold SDS strings,
997 static void dictVanillaFree(void *privdata
, void *val
)
999 DICT_NOTUSED(privdata
);
1003 static void dictListDestructor(void *privdata
, void *val
)
1005 DICT_NOTUSED(privdata
);
1006 listRelease((list
*)val
);
1009 static int sdsDictKeyCompare(void *privdata
, const void *key1
,
1013 DICT_NOTUSED(privdata
);
1015 l1
= sdslen((sds
)key1
);
1016 l2
= sdslen((sds
)key2
);
1017 if (l1
!= l2
) return 0;
1018 return memcmp(key1
, key2
, l1
) == 0;
1021 static void dictRedisObjectDestructor(void *privdata
, void *val
)
1023 DICT_NOTUSED(privdata
);
1025 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
1029 static int dictObjKeyCompare(void *privdata
, const void *key1
,
1032 const robj
*o1
= key1
, *o2
= key2
;
1033 return sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1036 static unsigned int dictObjHash(const void *key
) {
1037 const robj
*o
= key
;
1038 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1041 static int dictEncObjKeyCompare(void *privdata
, const void *key1
,
1044 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
1047 if (o1
->encoding
== REDIS_ENCODING_INT
&&
1048 o2
->encoding
== REDIS_ENCODING_INT
&&
1049 o1
->ptr
== o2
->ptr
) return 1;
1051 o1
= getDecodedObject(o1
);
1052 o2
= getDecodedObject(o2
);
1053 cmp
= sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1059 static unsigned int dictEncObjHash(const void *key
) {
1060 robj
*o
= (robj
*) key
;
1062 if (o
->encoding
== REDIS_ENCODING_RAW
) {
1063 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1065 if (o
->encoding
== REDIS_ENCODING_INT
) {
1069 len
= snprintf(buf
,32,"%ld",(long)o
->ptr
);
1070 return dictGenHashFunction((unsigned char*)buf
, len
);
1074 o
= getDecodedObject(o
);
1075 hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1082 /* Sets type and expires */
1083 static dictType setDictType
= {
1084 dictEncObjHash
, /* hash function */
1087 dictEncObjKeyCompare
, /* key compare */
1088 dictRedisObjectDestructor
, /* key destructor */
1089 NULL
/* val destructor */
1092 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
1093 static dictType zsetDictType
= {
1094 dictEncObjHash
, /* hash function */
1097 dictEncObjKeyCompare
, /* key compare */
1098 dictRedisObjectDestructor
, /* key destructor */
1099 dictVanillaFree
/* val destructor of malloc(sizeof(double)) */
1103 static dictType dbDictType
= {
1104 dictObjHash
, /* hash function */
1107 dictObjKeyCompare
, /* key compare */
1108 dictRedisObjectDestructor
, /* key destructor */
1109 dictRedisObjectDestructor
/* val destructor */
1113 static dictType keyptrDictType
= {
1114 dictObjHash
, /* hash function */
1117 dictObjKeyCompare
, /* key compare */
1118 dictRedisObjectDestructor
, /* key destructor */
1119 NULL
/* val destructor */
1122 /* Hash type hash table (note that small hashes are represented with zimpaps) */
1123 static dictType hashDictType
= {
1124 dictEncObjHash
, /* hash function */
1127 dictEncObjKeyCompare
, /* key compare */
1128 dictRedisObjectDestructor
, /* key destructor */
1129 dictRedisObjectDestructor
/* val destructor */
1132 /* Keylist hash table type has unencoded redis objects as keys and
1133 * lists as values. It's used for blocking operations (BLPOP) and to
1134 * map swapped keys to a list of clients waiting for this keys to be loaded. */
1135 static dictType keylistDictType
= {
1136 dictObjHash
, /* hash function */
1139 dictObjKeyCompare
, /* key compare */
1140 dictRedisObjectDestructor
, /* key destructor */
1141 dictListDestructor
/* val destructor */
1144 static void version();
1146 /* ========================= Random utility functions ======================= */
1148 /* Redis generally does not try to recover from out of memory conditions
1149 * when allocating objects or strings, it is not clear if it will be possible
1150 * to report this condition to the client since the networking layer itself
1151 * is based on heap allocation for send buffers, so we simply abort.
1152 * At least the code will be simpler to read... */
1153 static void oom(const char *msg
) {
1154 redisLog(REDIS_WARNING
, "%s: Out of memory\n",msg
);
1159 /* ====================== Redis server networking stuff ===================== */
1160 static void closeTimedoutClients(void) {
1163 time_t now
= time(NULL
);
1166 listRewind(server
.clients
,&li
);
1167 while ((ln
= listNext(&li
)) != NULL
) {
1168 c
= listNodeValue(ln
);
1169 if (server
.maxidletime
&&
1170 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
1171 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
1172 dictSize(c
->pubsub_channels
) == 0 && /* no timeout for pubsub */
1173 listLength(c
->pubsub_patterns
) == 0 &&
1174 (now
- c
->lastinteraction
> server
.maxidletime
))
1176 redisLog(REDIS_VERBOSE
,"Closing idle client");
1178 } else if (c
->flags
& REDIS_BLOCKED
) {
1179 if (c
->blockingto
!= 0 && c
->blockingto
< now
) {
1180 addReply(c
,shared
.nullmultibulk
);
1181 unblockClientWaitingData(c
);
1187 static int htNeedsResize(dict
*dict
) {
1188 long long size
, used
;
1190 size
= dictSlots(dict
);
1191 used
= dictSize(dict
);
1192 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
1193 (used
*100/size
< REDIS_HT_MINFILL
));
1196 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1197 * we resize the hash table to save memory */
1198 static void tryResizeHashTables(void) {
1201 for (j
= 0; j
< server
.dbnum
; j
++) {
1202 if (htNeedsResize(server
.db
[j
].dict
)) {
1203 redisLog(REDIS_VERBOSE
,"The hash table %d is too sparse, resize it...",j
);
1204 dictResize(server
.db
[j
].dict
);
1205 redisLog(REDIS_VERBOSE
,"Hash table %d resized.",j
);
1207 if (htNeedsResize(server
.db
[j
].expires
))
1208 dictResize(server
.db
[j
].expires
);
1212 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1213 void backgroundSaveDoneHandler(int statloc
) {
1214 int exitcode
= WEXITSTATUS(statloc
);
1215 int bysignal
= WIFSIGNALED(statloc
);
1217 if (!bysignal
&& exitcode
== 0) {
1218 redisLog(REDIS_NOTICE
,
1219 "Background saving terminated with success");
1221 server
.lastsave
= time(NULL
);
1222 } else if (!bysignal
&& exitcode
!= 0) {
1223 redisLog(REDIS_WARNING
, "Background saving error");
1225 redisLog(REDIS_WARNING
,
1226 "Background saving terminated by signal %d", WTERMSIG(statloc
));
1227 rdbRemoveTempFile(server
.bgsavechildpid
);
1229 server
.bgsavechildpid
= -1;
1230 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1231 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1232 updateSlavesWaitingBgsave(exitcode
== 0 ? REDIS_OK
: REDIS_ERR
);
1235 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1237 void backgroundRewriteDoneHandler(int statloc
) {
1238 int exitcode
= WEXITSTATUS(statloc
);
1239 int bysignal
= WIFSIGNALED(statloc
);
1241 if (!bysignal
&& exitcode
== 0) {
1245 redisLog(REDIS_NOTICE
,
1246 "Background append only file rewriting terminated with success");
1247 /* Now it's time to flush the differences accumulated by the parent */
1248 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) server
.bgrewritechildpid
);
1249 fd
= open(tmpfile
,O_WRONLY
|O_APPEND
);
1251 redisLog(REDIS_WARNING
, "Not able to open the temp append only file produced by the child: %s", strerror(errno
));
1254 /* Flush our data... */
1255 if (write(fd
,server
.bgrewritebuf
,sdslen(server
.bgrewritebuf
)) !=
1256 (signed) sdslen(server
.bgrewritebuf
)) {
1257 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
));
1261 redisLog(REDIS_NOTICE
,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server
.bgrewritebuf
));
1262 /* Now our work is to rename the temp file into the stable file. And
1263 * switch the file descriptor used by the server for append only. */
1264 if (rename(tmpfile
,server
.appendfilename
) == -1) {
1265 redisLog(REDIS_WARNING
,"Can't rename the temp append only file into the stable one: %s", strerror(errno
));
1269 /* Mission completed... almost */
1270 redisLog(REDIS_NOTICE
,"Append only file successfully rewritten.");
1271 if (server
.appendfd
!= -1) {
1272 /* If append only is actually enabled... */
1273 close(server
.appendfd
);
1274 server
.appendfd
= fd
;
1276 server
.appendseldb
= -1; /* Make sure it will issue SELECT */
1277 redisLog(REDIS_NOTICE
,"The new append only file was selected for future appends.");
1279 /* If append only is disabled we just generate a dump in this
1280 * format. Why not? */
1283 } else if (!bysignal
&& exitcode
!= 0) {
1284 redisLog(REDIS_WARNING
, "Background append only file rewriting error");
1286 redisLog(REDIS_WARNING
,
1287 "Background append only file rewriting terminated by signal %d",
1291 sdsfree(server
.bgrewritebuf
);
1292 server
.bgrewritebuf
= sdsempty();
1293 aofRemoveTempFile(server
.bgrewritechildpid
);
1294 server
.bgrewritechildpid
= -1;
1297 static int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
1298 int j
, loops
= server
.cronloops
++;
1299 REDIS_NOTUSED(eventLoop
);
1301 REDIS_NOTUSED(clientData
);
1303 /* We take a cached value of the unix time in the global state because
1304 * with virtual memory and aging there is to store the current time
1305 * in objects at every object access, and accuracy is not needed.
1306 * To access a global var is faster than calling time(NULL) */
1307 server
.unixtime
= time(NULL
);
1309 /* Show some info about non-empty databases */
1310 for (j
= 0; j
< server
.dbnum
; j
++) {
1311 long long size
, used
, vkeys
;
1313 size
= dictSlots(server
.db
[j
].dict
);
1314 used
= dictSize(server
.db
[j
].dict
);
1315 vkeys
= dictSize(server
.db
[j
].expires
);
1316 if (!(loops
% 50) && (used
|| vkeys
)) {
1317 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
1318 /* dictPrintStats(server.dict); */
1322 /* We don't want to resize the hash tables while a bacground saving
1323 * is in progress: the saving child is created using fork() that is
1324 * implemented with a copy-on-write semantic in most modern systems, so
1325 * if we resize the HT while there is the saving child at work actually
1326 * a lot of memory movements in the parent will cause a lot of pages
1328 if (server
.bgsavechildpid
== -1 && !(loops
% 10)) tryResizeHashTables();
1330 /* Show information about connected clients */
1331 if (!(loops
% 50)) {
1332 redisLog(REDIS_VERBOSE
,"%d clients connected (%d slaves), %zu bytes in use, %d shared objects",
1333 listLength(server
.clients
)-listLength(server
.slaves
),
1334 listLength(server
.slaves
),
1335 zmalloc_used_memory(),
1336 dictSize(server
.sharingpool
));
1339 /* Close connections of timedout clients */
1340 if ((server
.maxidletime
&& !(loops
% 100)) || server
.blpop_blocked_clients
)
1341 closeTimedoutClients();
1343 /* Check if a background saving or AOF rewrite in progress terminated */
1344 if (server
.bgsavechildpid
!= -1 || server
.bgrewritechildpid
!= -1) {
1348 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
1349 if (pid
== server
.bgsavechildpid
) {
1350 backgroundSaveDoneHandler(statloc
);
1352 backgroundRewriteDoneHandler(statloc
);
1356 /* If there is not a background saving in progress check if
1357 * we have to save now */
1358 time_t now
= time(NULL
);
1359 for (j
= 0; j
< server
.saveparamslen
; j
++) {
1360 struct saveparam
*sp
= server
.saveparams
+j
;
1362 if (server
.dirty
>= sp
->changes
&&
1363 now
-server
.lastsave
> sp
->seconds
) {
1364 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
1365 sp
->changes
, sp
->seconds
);
1366 rdbSaveBackground(server
.dbfilename
);
1372 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1373 * will use few CPU cycles if there are few expiring keys, otherwise
1374 * it will get more aggressive to avoid that too much memory is used by
1375 * keys that can be removed from the keyspace. */
1376 for (j
= 0; j
< server
.dbnum
; j
++) {
1378 redisDb
*db
= server
.db
+j
;
1380 /* Continue to expire if at the end of the cycle more than 25%
1381 * of the keys were expired. */
1383 long num
= dictSize(db
->expires
);
1384 time_t now
= time(NULL
);
1387 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
1388 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
1393 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
1394 t
= (time_t) dictGetEntryVal(de
);
1396 deleteKey(db
,dictGetEntryKey(de
));
1398 server
.stat_expiredkeys
++;
1401 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
1404 /* Swap a few keys on disk if we are over the memory limit and VM
1405 * is enbled. Try to free objects from the free list first. */
1406 if (vmCanSwapOut()) {
1407 while (server
.vm_enabled
&& zmalloc_used_memory() >
1408 server
.vm_max_memory
)
1412 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
1413 retval
= (server
.vm_max_threads
== 0) ?
1414 vmSwapOneObjectBlocking() :
1415 vmSwapOneObjectThreaded();
1416 if (retval
== REDIS_ERR
&& !(loops
% 300) &&
1417 zmalloc_used_memory() >
1418 (server
.vm_max_memory
+server
.vm_max_memory
/10))
1420 redisLog(REDIS_WARNING
,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1422 /* Note that when using threade I/O we free just one object,
1423 * because anyway when the I/O thread in charge to swap this
1424 * object out will finish, the handler of completed jobs
1425 * will try to swap more objects if we are still out of memory. */
1426 if (retval
== REDIS_ERR
|| server
.vm_max_threads
> 0) break;
1430 /* Check if we should connect to a MASTER */
1431 if (server
.replstate
== REDIS_REPL_CONNECT
&& !(loops
% 10)) {
1432 redisLog(REDIS_NOTICE
,"Connecting to MASTER...");
1433 if (syncWithMaster() == REDIS_OK
) {
1434 redisLog(REDIS_NOTICE
,"MASTER <-> SLAVE sync succeeded");
1440 /* This function gets called every time Redis is entering the
1441 * main loop of the event driven library, that is, before to sleep
1442 * for ready file descriptors. */
1443 static void beforeSleep(struct aeEventLoop
*eventLoop
) {
1444 REDIS_NOTUSED(eventLoop
);
1446 if (server
.vm_enabled
&& listLength(server
.io_ready_clients
)) {
1450 listRewind(server
.io_ready_clients
,&li
);
1451 while((ln
= listNext(&li
))) {
1452 redisClient
*c
= ln
->value
;
1453 struct redisCommand
*cmd
;
1455 /* Resume the client. */
1456 listDelNode(server
.io_ready_clients
,ln
);
1457 c
->flags
&= (~REDIS_IO_WAIT
);
1458 server
.vm_blocked_clients
--;
1459 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
1460 readQueryFromClient
, c
);
1461 cmd
= lookupCommand(c
->argv
[0]->ptr
);
1462 assert(cmd
!= NULL
);
1465 /* There may be more data to process in the input buffer. */
1466 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0)
1467 processInputBuffer(c
);
1472 static void createSharedObjects(void) {
1473 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1474 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1475 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1476 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1477 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1478 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1479 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1480 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1481 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1482 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1483 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1484 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1485 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1486 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1487 "-ERR no such key\r\n"));
1488 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1489 "-ERR syntax error\r\n"));
1490 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1491 "-ERR source and destination objects are the same\r\n"));
1492 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1493 "-ERR index out of range\r\n"));
1494 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1495 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1496 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1497 shared
.select0
= createStringObject("select 0\r\n",10);
1498 shared
.select1
= createStringObject("select 1\r\n",10);
1499 shared
.select2
= createStringObject("select 2\r\n",10);
1500 shared
.select3
= createStringObject("select 3\r\n",10);
1501 shared
.select4
= createStringObject("select 4\r\n",10);
1502 shared
.select5
= createStringObject("select 5\r\n",10);
1503 shared
.select6
= createStringObject("select 6\r\n",10);
1504 shared
.select7
= createStringObject("select 7\r\n",10);
1505 shared
.select8
= createStringObject("select 8\r\n",10);
1506 shared
.select9
= createStringObject("select 9\r\n",10);
1507 shared
.messagebulk
= createStringObject("$7\r\nmessage\r\n",13);
1508 shared
.subscribebulk
= createStringObject("$9\r\nsubscribe\r\n",15);
1509 shared
.unsubscribebulk
= createStringObject("$11\r\nunsubscribe\r\n",18);
1510 shared
.psubscribebulk
= createStringObject("$10\r\npsubscribe\r\n",17);
1511 shared
.punsubscribebulk
= createStringObject("$12\r\npunsubscribe\r\n",19);
1512 shared
.mbulk3
= createStringObject("*3\r\n",4);
1515 static void appendServerSaveParams(time_t seconds
, int changes
) {
1516 server
.saveparams
= zrealloc(server
.saveparams
,sizeof(struct saveparam
)*(server
.saveparamslen
+1));
1517 server
.saveparams
[server
.saveparamslen
].seconds
= seconds
;
1518 server
.saveparams
[server
.saveparamslen
].changes
= changes
;
1519 server
.saveparamslen
++;
1522 static void resetServerSaveParams() {
1523 zfree(server
.saveparams
);
1524 server
.saveparams
= NULL
;
1525 server
.saveparamslen
= 0;
1528 static void initServerConfig() {
1529 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1530 server
.port
= REDIS_SERVERPORT
;
1531 server
.verbosity
= REDIS_VERBOSE
;
1532 server
.maxidletime
= REDIS_MAXIDLETIME
;
1533 server
.saveparams
= NULL
;
1534 server
.logfile
= NULL
; /* NULL = log on standard output */
1535 server
.bindaddr
= NULL
;
1536 server
.glueoutputbuf
= 1;
1537 server
.daemonize
= 0;
1538 server
.appendonly
= 0;
1539 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1540 server
.lastfsync
= time(NULL
);
1541 server
.appendfd
= -1;
1542 server
.appendseldb
= -1; /* Make sure the first time will not match */
1543 server
.pidfile
= zstrdup("/var/run/redis.pid");
1544 server
.dbfilename
= zstrdup("dump.rdb");
1545 server
.appendfilename
= zstrdup("appendonly.aof");
1546 server
.requirepass
= NULL
;
1547 server
.shareobjects
= 0;
1548 server
.rdbcompression
= 1;
1549 server
.sharingpoolsize
= 1024;
1550 server
.maxclients
= 0;
1551 server
.blpop_blocked_clients
= 0;
1552 server
.maxmemory
= 0;
1553 server
.vm_enabled
= 0;
1554 server
.vm_swap_file
= zstrdup("/tmp/redis-%p.vm");
1555 server
.vm_page_size
= 256; /* 256 bytes per page */
1556 server
.vm_pages
= 1024*1024*100; /* 104 millions of pages */
1557 server
.vm_max_memory
= 1024LL*1024*1024*1; /* 1 GB of RAM */
1558 server
.vm_max_threads
= 4;
1559 server
.vm_blocked_clients
= 0;
1560 server
.hash_max_zipmap_entries
= REDIS_HASH_MAX_ZIPMAP_ENTRIES
;
1561 server
.hash_max_zipmap_value
= REDIS_HASH_MAX_ZIPMAP_VALUE
;
1563 resetServerSaveParams();
1565 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1566 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1567 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1568 /* Replication related */
1570 server
.masterauth
= NULL
;
1571 server
.masterhost
= NULL
;
1572 server
.masterport
= 6379;
1573 server
.master
= NULL
;
1574 server
.replstate
= REDIS_REPL_NONE
;
1576 /* Double constants initialization */
1578 R_PosInf
= 1.0/R_Zero
;
1579 R_NegInf
= -1.0/R_Zero
;
1580 R_Nan
= R_Zero
/R_Zero
;
1583 static void initServer() {
1586 signal(SIGHUP
, SIG_IGN
);
1587 signal(SIGPIPE
, SIG_IGN
);
1588 setupSigSegvAction();
1590 server
.devnull
= fopen("/dev/null","w");
1591 if (server
.devnull
== NULL
) {
1592 redisLog(REDIS_WARNING
, "Can't open /dev/null: %s", server
.neterr
);
1595 server
.clients
= listCreate();
1596 server
.slaves
= listCreate();
1597 server
.monitors
= listCreate();
1598 server
.objfreelist
= listCreate();
1599 createSharedObjects();
1600 server
.el
= aeCreateEventLoop();
1601 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1602 server
.sharingpool
= dictCreate(&setDictType
,NULL
);
1603 server
.fd
= anetTcpServer(server
.neterr
, server
.port
, server
.bindaddr
);
1604 if (server
.fd
== -1) {
1605 redisLog(REDIS_WARNING
, "Opening TCP port: %s", server
.neterr
);
1608 for (j
= 0; j
< server
.dbnum
; j
++) {
1609 server
.db
[j
].dict
= dictCreate(&dbDictType
,NULL
);
1610 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1611 server
.db
[j
].blockingkeys
= dictCreate(&keylistDictType
,NULL
);
1612 if (server
.vm_enabled
)
1613 server
.db
[j
].io_keys
= dictCreate(&keylistDictType
,NULL
);
1614 server
.db
[j
].id
= j
;
1616 server
.pubsub_channels
= dictCreate(&keylistDictType
,NULL
);
1617 server
.pubsub_patterns
= listCreate();
1618 listSetFreeMethod(server
.pubsub_patterns
,freePubsubPattern
);
1619 listSetMatchMethod(server
.pubsub_patterns
,listMatchPubsubPattern
);
1620 server
.cronloops
= 0;
1621 server
.bgsavechildpid
= -1;
1622 server
.bgrewritechildpid
= -1;
1623 server
.bgrewritebuf
= sdsempty();
1624 server
.lastsave
= time(NULL
);
1626 server
.stat_numcommands
= 0;
1627 server
.stat_numconnections
= 0;
1628 server
.stat_expiredkeys
= 0;
1629 server
.stat_starttime
= time(NULL
);
1630 server
.unixtime
= time(NULL
);
1631 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1632 if (aeCreateFileEvent(server
.el
, server
.fd
, AE_READABLE
,
1633 acceptHandler
, NULL
) == AE_ERR
) oom("creating file event");
1635 if (server
.appendonly
) {
1636 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1637 if (server
.appendfd
== -1) {
1638 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1644 if (server
.vm_enabled
) vmInit();
1647 /* Empty the whole database */
1648 static long long emptyDb() {
1650 long long removed
= 0;
1652 for (j
= 0; j
< server
.dbnum
; j
++) {
1653 removed
+= dictSize(server
.db
[j
].dict
);
1654 dictEmpty(server
.db
[j
].dict
);
1655 dictEmpty(server
.db
[j
].expires
);
1660 static int yesnotoi(char *s
) {
1661 if (!strcasecmp(s
,"yes")) return 1;
1662 else if (!strcasecmp(s
,"no")) return 0;
1666 /* I agree, this is a very rudimental way to load a configuration...
1667 will improve later if the config gets more complex */
1668 static void loadServerConfig(char *filename
) {
1670 char buf
[REDIS_CONFIGLINE_MAX
+1], *err
= NULL
;
1673 char *errormsg
= "Fatal error, can't open config file '%s'";
1674 char *errorbuf
= zmalloc(sizeof(char)*(strlen(errormsg
)+strlen(filename
)));
1675 sprintf(errorbuf
, errormsg
, filename
);
1677 if (filename
[0] == '-' && filename
[1] == '\0')
1680 if ((fp
= fopen(filename
,"r")) == NULL
) {
1681 redisLog(REDIS_WARNING
, errorbuf
);
1686 while(fgets(buf
,REDIS_CONFIGLINE_MAX
+1,fp
) != NULL
) {
1692 line
= sdstrim(line
," \t\r\n");
1694 /* Skip comments and blank lines*/
1695 if (line
[0] == '#' || line
[0] == '\0') {
1700 /* Split into arguments */
1701 argv
= sdssplitlen(line
,sdslen(line
)," ",1,&argc
);
1702 sdstolower(argv
[0]);
1704 /* Execute config directives */
1705 if (!strcasecmp(argv
[0],"timeout") && argc
== 2) {
1706 server
.maxidletime
= atoi(argv
[1]);
1707 if (server
.maxidletime
< 0) {
1708 err
= "Invalid timeout value"; goto loaderr
;
1710 } else if (!strcasecmp(argv
[0],"port") && argc
== 2) {
1711 server
.port
= atoi(argv
[1]);
1712 if (server
.port
< 1 || server
.port
> 65535) {
1713 err
= "Invalid port"; goto loaderr
;
1715 } else if (!strcasecmp(argv
[0],"bind") && argc
== 2) {
1716 server
.bindaddr
= zstrdup(argv
[1]);
1717 } else if (!strcasecmp(argv
[0],"save") && argc
== 3) {
1718 int seconds
= atoi(argv
[1]);
1719 int changes
= atoi(argv
[2]);
1720 if (seconds
< 1 || changes
< 0) {
1721 err
= "Invalid save parameters"; goto loaderr
;
1723 appendServerSaveParams(seconds
,changes
);
1724 } else if (!strcasecmp(argv
[0],"dir") && argc
== 2) {
1725 if (chdir(argv
[1]) == -1) {
1726 redisLog(REDIS_WARNING
,"Can't chdir to '%s': %s",
1727 argv
[1], strerror(errno
));
1730 } else if (!strcasecmp(argv
[0],"loglevel") && argc
== 2) {
1731 if (!strcasecmp(argv
[1],"debug")) server
.verbosity
= REDIS_DEBUG
;
1732 else if (!strcasecmp(argv
[1],"verbose")) server
.verbosity
= REDIS_VERBOSE
;
1733 else if (!strcasecmp(argv
[1],"notice")) server
.verbosity
= REDIS_NOTICE
;
1734 else if (!strcasecmp(argv
[1],"warning")) server
.verbosity
= REDIS_WARNING
;
1736 err
= "Invalid log level. Must be one of debug, notice, warning";
1739 } else if (!strcasecmp(argv
[0],"logfile") && argc
== 2) {
1742 server
.logfile
= zstrdup(argv
[1]);
1743 if (!strcasecmp(server
.logfile
,"stdout")) {
1744 zfree(server
.logfile
);
1745 server
.logfile
= NULL
;
1747 if (server
.logfile
) {
1748 /* Test if we are able to open the file. The server will not
1749 * be able to abort just for this problem later... */
1750 logfp
= fopen(server
.logfile
,"a");
1751 if (logfp
== NULL
) {
1752 err
= sdscatprintf(sdsempty(),
1753 "Can't open the log file: %s", strerror(errno
));
1758 } else if (!strcasecmp(argv
[0],"databases") && argc
== 2) {
1759 server
.dbnum
= atoi(argv
[1]);
1760 if (server
.dbnum
< 1) {
1761 err
= "Invalid number of databases"; goto loaderr
;
1763 } else if (!strcasecmp(argv
[0],"include") && argc
== 2) {
1764 loadServerConfig(argv
[1]);
1765 } else if (!strcasecmp(argv
[0],"maxclients") && argc
== 2) {
1766 server
.maxclients
= atoi(argv
[1]);
1767 } else if (!strcasecmp(argv
[0],"maxmemory") && argc
== 2) {
1768 server
.maxmemory
= strtoll(argv
[1], NULL
, 10);
1769 } else if (!strcasecmp(argv
[0],"slaveof") && argc
== 3) {
1770 server
.masterhost
= sdsnew(argv
[1]);
1771 server
.masterport
= atoi(argv
[2]);
1772 server
.replstate
= REDIS_REPL_CONNECT
;
1773 } else if (!strcasecmp(argv
[0],"masterauth") && argc
== 2) {
1774 server
.masterauth
= zstrdup(argv
[1]);
1775 } else if (!strcasecmp(argv
[0],"glueoutputbuf") && argc
== 2) {
1776 if ((server
.glueoutputbuf
= yesnotoi(argv
[1])) == -1) {
1777 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1779 } else if (!strcasecmp(argv
[0],"shareobjects") && argc
== 2) {
1780 if ((server
.shareobjects
= yesnotoi(argv
[1])) == -1) {
1781 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1783 } else if (!strcasecmp(argv
[0],"rdbcompression") && argc
== 2) {
1784 if ((server
.rdbcompression
= yesnotoi(argv
[1])) == -1) {
1785 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1787 } else if (!strcasecmp(argv
[0],"shareobjectspoolsize") && argc
== 2) {
1788 server
.sharingpoolsize
= atoi(argv
[1]);
1789 if (server
.sharingpoolsize
< 1) {
1790 err
= "invalid object sharing pool size"; goto loaderr
;
1792 } else if (!strcasecmp(argv
[0],"daemonize") && argc
== 2) {
1793 if ((server
.daemonize
= yesnotoi(argv
[1])) == -1) {
1794 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1796 } else if (!strcasecmp(argv
[0],"appendonly") && argc
== 2) {
1797 if ((server
.appendonly
= yesnotoi(argv
[1])) == -1) {
1798 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1800 } else if (!strcasecmp(argv
[0],"appendfsync") && argc
== 2) {
1801 if (!strcasecmp(argv
[1],"no")) {
1802 server
.appendfsync
= APPENDFSYNC_NO
;
1803 } else if (!strcasecmp(argv
[1],"always")) {
1804 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1805 } else if (!strcasecmp(argv
[1],"everysec")) {
1806 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1808 err
= "argument must be 'no', 'always' or 'everysec'";
1811 } else if (!strcasecmp(argv
[0],"requirepass") && argc
== 2) {
1812 server
.requirepass
= zstrdup(argv
[1]);
1813 } else if (!strcasecmp(argv
[0],"pidfile") && argc
== 2) {
1814 zfree(server
.pidfile
);
1815 server
.pidfile
= zstrdup(argv
[1]);
1816 } else if (!strcasecmp(argv
[0],"dbfilename") && argc
== 2) {
1817 zfree(server
.dbfilename
);
1818 server
.dbfilename
= zstrdup(argv
[1]);
1819 } else if (!strcasecmp(argv
[0],"vm-enabled") && argc
== 2) {
1820 if ((server
.vm_enabled
= yesnotoi(argv
[1])) == -1) {
1821 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1823 } else if (!strcasecmp(argv
[0],"vm-swap-file") && argc
== 2) {
1824 zfree(server
.vm_swap_file
);
1825 server
.vm_swap_file
= zstrdup(argv
[1]);
1826 } else if (!strcasecmp(argv
[0],"vm-max-memory") && argc
== 2) {
1827 server
.vm_max_memory
= strtoll(argv
[1], NULL
, 10);
1828 } else if (!strcasecmp(argv
[0],"vm-page-size") && argc
== 2) {
1829 server
.vm_page_size
= strtoll(argv
[1], NULL
, 10);
1830 } else if (!strcasecmp(argv
[0],"vm-pages") && argc
== 2) {
1831 server
.vm_pages
= strtoll(argv
[1], NULL
, 10);
1832 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1833 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1834 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-entries") && argc
== 2){
1835 server
.hash_max_zipmap_entries
= strtol(argv
[1], NULL
, 10);
1836 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-value") && argc
== 2){
1837 server
.hash_max_zipmap_value
= strtol(argv
[1], NULL
, 10);
1838 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1839 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1841 err
= "Bad directive or wrong number of arguments"; goto loaderr
;
1843 for (j
= 0; j
< argc
; j
++)
1848 if (fp
!= stdin
) fclose(fp
);
1852 fprintf(stderr
, "\n*** FATAL CONFIG FILE ERROR ***\n");
1853 fprintf(stderr
, "Reading the configuration file, at line %d\n", linenum
);
1854 fprintf(stderr
, ">>> '%s'\n", line
);
1855 fprintf(stderr
, "%s\n", err
);
1859 static void freeClientArgv(redisClient
*c
) {
1862 for (j
= 0; j
< c
->argc
; j
++)
1863 decrRefCount(c
->argv
[j
]);
1864 for (j
= 0; j
< c
->mbargc
; j
++)
1865 decrRefCount(c
->mbargv
[j
]);
1870 static void freeClient(redisClient
*c
) {
1873 /* Note that if the client we are freeing is blocked into a blocking
1874 * call, we have to set querybuf to NULL *before* to call
1875 * unblockClientWaitingData() to avoid processInputBuffer() will get
1876 * called. Also it is important to remove the file events after
1877 * this, because this call adds the READABLE event. */
1878 sdsfree(c
->querybuf
);
1880 if (c
->flags
& REDIS_BLOCKED
)
1881 unblockClientWaitingData(c
);
1883 /* Unsubscribe from all the pubsub channels */
1884 pubsubUnsubscribeAllChannels(c
,0);
1885 pubsubUnsubscribeAllPatterns(c
,0);
1886 dictRelease(c
->pubsub_channels
);
1887 listRelease(c
->pubsub_patterns
);
1888 /* Obvious cleanup */
1889 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
1890 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1891 listRelease(c
->reply
);
1894 /* Remove from the list of clients */
1895 ln
= listSearchKey(server
.clients
,c
);
1896 redisAssert(ln
!= NULL
);
1897 listDelNode(server
.clients
,ln
);
1898 /* Remove from the list of clients waiting for swapped keys */
1899 if (c
->flags
& REDIS_IO_WAIT
&& listLength(c
->io_keys
) == 0) {
1900 ln
= listSearchKey(server
.io_ready_clients
,c
);
1902 listDelNode(server
.io_ready_clients
,ln
);
1903 server
.vm_blocked_clients
--;
1906 while (server
.vm_enabled
&& listLength(c
->io_keys
)) {
1907 ln
= listFirst(c
->io_keys
);
1908 dontWaitForSwappedKey(c
,ln
->value
);
1910 listRelease(c
->io_keys
);
1911 /* Master/slave cleanup */
1912 if (c
->flags
& REDIS_SLAVE
) {
1913 if (c
->replstate
== REDIS_REPL_SEND_BULK
&& c
->repldbfd
!= -1)
1915 list
*l
= (c
->flags
& REDIS_MONITOR
) ? server
.monitors
: server
.slaves
;
1916 ln
= listSearchKey(l
,c
);
1917 redisAssert(ln
!= NULL
);
1920 if (c
->flags
& REDIS_MASTER
) {
1921 server
.master
= NULL
;
1922 server
.replstate
= REDIS_REPL_CONNECT
;
1924 /* Release memory */
1927 freeClientMultiState(c
);
1931 #define GLUEREPLY_UP_TO (1024)
1932 static void glueReplyBuffersIfNeeded(redisClient
*c
) {
1934 char buf
[GLUEREPLY_UP_TO
];
1939 listRewind(c
->reply
,&li
);
1940 while((ln
= listNext(&li
))) {
1944 objlen
= sdslen(o
->ptr
);
1945 if (copylen
+ objlen
<= GLUEREPLY_UP_TO
) {
1946 memcpy(buf
+copylen
,o
->ptr
,objlen
);
1948 listDelNode(c
->reply
,ln
);
1950 if (copylen
== 0) return;
1954 /* Now the output buffer is empty, add the new single element */
1955 o
= createObject(REDIS_STRING
,sdsnewlen(buf
,copylen
));
1956 listAddNodeHead(c
->reply
,o
);
1959 static void sendReplyToClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
1960 redisClient
*c
= privdata
;
1961 int nwritten
= 0, totwritten
= 0, objlen
;
1964 REDIS_NOTUSED(mask
);
1966 /* Use writev() if we have enough buffers to send */
1967 if (!server
.glueoutputbuf
&&
1968 listLength(c
->reply
) > REDIS_WRITEV_THRESHOLD
&&
1969 !(c
->flags
& REDIS_MASTER
))
1971 sendReplyToClientWritev(el
, fd
, privdata
, mask
);
1975 while(listLength(c
->reply
)) {
1976 if (server
.glueoutputbuf
&& listLength(c
->reply
) > 1)
1977 glueReplyBuffersIfNeeded(c
);
1979 o
= listNodeValue(listFirst(c
->reply
));
1980 objlen
= sdslen(o
->ptr
);
1983 listDelNode(c
->reply
,listFirst(c
->reply
));
1987 if (c
->flags
& REDIS_MASTER
) {
1988 /* Don't reply to a master */
1989 nwritten
= objlen
- c
->sentlen
;
1991 nwritten
= write(fd
, ((char*)o
->ptr
)+c
->sentlen
, objlen
- c
->sentlen
);
1992 if (nwritten
<= 0) break;
1994 c
->sentlen
+= nwritten
;
1995 totwritten
+= nwritten
;
1996 /* If we fully sent the object on head go to the next one */
1997 if (c
->sentlen
== objlen
) {
1998 listDelNode(c
->reply
,listFirst(c
->reply
));
2001 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
2002 * bytes, in a single threaded server it's a good idea to serve
2003 * other clients as well, even if a very large request comes from
2004 * super fast link that is always able to accept data (in real world
2005 * scenario think about 'KEYS *' against the loopback interfae) */
2006 if (totwritten
> REDIS_MAX_WRITE_PER_EVENT
) break;
2008 if (nwritten
== -1) {
2009 if (errno
== EAGAIN
) {
2012 redisLog(REDIS_VERBOSE
,
2013 "Error writing to client: %s", strerror(errno
));
2018 if (totwritten
> 0) c
->lastinteraction
= time(NULL
);
2019 if (listLength(c
->reply
) == 0) {
2021 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2025 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
)
2027 redisClient
*c
= privdata
;
2028 int nwritten
= 0, totwritten
= 0, objlen
, willwrite
;
2030 struct iovec iov
[REDIS_WRITEV_IOVEC_COUNT
];
2031 int offset
, ion
= 0;
2033 REDIS_NOTUSED(mask
);
2036 while (listLength(c
->reply
)) {
2037 offset
= c
->sentlen
;
2041 /* fill-in the iov[] array */
2042 for(node
= listFirst(c
->reply
); node
; node
= listNextNode(node
)) {
2043 o
= listNodeValue(node
);
2044 objlen
= sdslen(o
->ptr
);
2046 if (totwritten
+ objlen
- offset
> REDIS_MAX_WRITE_PER_EVENT
)
2049 if(ion
== REDIS_WRITEV_IOVEC_COUNT
)
2050 break; /* no more iovecs */
2052 iov
[ion
].iov_base
= ((char*)o
->ptr
) + offset
;
2053 iov
[ion
].iov_len
= objlen
- offset
;
2054 willwrite
+= objlen
- offset
;
2055 offset
= 0; /* just for the first item */
2062 /* write all collected blocks at once */
2063 if((nwritten
= writev(fd
, iov
, ion
)) < 0) {
2064 if (errno
!= EAGAIN
) {
2065 redisLog(REDIS_VERBOSE
,
2066 "Error writing to client: %s", strerror(errno
));
2073 totwritten
+= nwritten
;
2074 offset
= c
->sentlen
;
2076 /* remove written robjs from c->reply */
2077 while (nwritten
&& listLength(c
->reply
)) {
2078 o
= listNodeValue(listFirst(c
->reply
));
2079 objlen
= sdslen(o
->ptr
);
2081 if(nwritten
>= objlen
- offset
) {
2082 listDelNode(c
->reply
, listFirst(c
->reply
));
2083 nwritten
-= objlen
- offset
;
2087 c
->sentlen
+= nwritten
;
2095 c
->lastinteraction
= time(NULL
);
2097 if (listLength(c
->reply
) == 0) {
2099 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2103 static struct redisCommand
*lookupCommand(char *name
) {
2105 while(cmdTable
[j
].name
!= NULL
) {
2106 if (!strcasecmp(name
,cmdTable
[j
].name
)) return &cmdTable
[j
];
2112 /* resetClient prepare the client to process the next command */
2113 static void resetClient(redisClient
*c
) {
2119 /* Call() is the core of Redis execution of a command */
2120 static void call(redisClient
*c
, struct redisCommand
*cmd
) {
2123 dirty
= server
.dirty
;
2125 dirty
= server
.dirty
-dirty
;
2127 if (server
.appendonly
&& dirty
)
2128 feedAppendOnlyFile(cmd
,c
->db
->id
,c
->argv
,c
->argc
);
2129 if ((dirty
|| cmd
->flags
& REDIS_CMD_FORCE_REPLICATION
) &&
2130 listLength(server
.slaves
))
2131 replicationFeedSlaves(server
.slaves
,c
->db
->id
,c
->argv
,c
->argc
);
2132 if (listLength(server
.monitors
))
2133 replicationFeedSlaves(server
.monitors
,c
->db
->id
,c
->argv
,c
->argc
);
2134 server
.stat_numcommands
++;
2137 /* If this function gets called we already read a whole
2138 * command, argments are in the client argv/argc fields.
2139 * processCommand() execute the command or prepare the
2140 * server for a bulk read from the client.
2142 * If 1 is returned the client is still alive and valid and
2143 * and other operations can be performed by the caller. Otherwise
2144 * if 0 is returned the client was destroied (i.e. after QUIT). */
2145 static int processCommand(redisClient
*c
) {
2146 struct redisCommand
*cmd
;
2148 /* Free some memory if needed (maxmemory setting) */
2149 if (server
.maxmemory
) freeMemoryIfNeeded();
2151 /* Handle the multi bulk command type. This is an alternative protocol
2152 * supported by Redis in order to receive commands that are composed of
2153 * multiple binary-safe "bulk" arguments. The latency of processing is
2154 * a bit higher but this allows things like multi-sets, so if this
2155 * protocol is used only for MSET and similar commands this is a big win. */
2156 if (c
->multibulk
== 0 && c
->argc
== 1 && ((char*)(c
->argv
[0]->ptr
))[0] == '*') {
2157 c
->multibulk
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2158 if (c
->multibulk
<= 0) {
2162 decrRefCount(c
->argv
[c
->argc
-1]);
2166 } else if (c
->multibulk
) {
2167 if (c
->bulklen
== -1) {
2168 if (((char*)c
->argv
[0]->ptr
)[0] != '$') {
2169 addReplySds(c
,sdsnew("-ERR multi bulk protocol error\r\n"));
2173 int bulklen
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2174 decrRefCount(c
->argv
[0]);
2175 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2177 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2182 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2186 c
->mbargv
= zrealloc(c
->mbargv
,(sizeof(robj
*))*(c
->mbargc
+1));
2187 c
->mbargv
[c
->mbargc
] = c
->argv
[0];
2191 if (c
->multibulk
== 0) {
2195 /* Here we need to swap the multi-bulk argc/argv with the
2196 * normal argc/argv of the client structure. */
2198 c
->argv
= c
->mbargv
;
2199 c
->mbargv
= auxargv
;
2202 c
->argc
= c
->mbargc
;
2203 c
->mbargc
= auxargc
;
2205 /* We need to set bulklen to something different than -1
2206 * in order for the code below to process the command without
2207 * to try to read the last argument of a bulk command as
2208 * a special argument. */
2210 /* continue below and process the command */
2217 /* -- end of multi bulk commands processing -- */
2219 /* The QUIT command is handled as a special case. Normal command
2220 * procs are unable to close the client connection safely */
2221 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
2226 /* Now lookup the command and check ASAP about trivial error conditions
2227 * such wrong arity, bad command name and so forth. */
2228 cmd
= lookupCommand(c
->argv
[0]->ptr
);
2231 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2232 (char*)c
->argv
[0]->ptr
));
2235 } else if ((cmd
->arity
> 0 && cmd
->arity
!= c
->argc
) ||
2236 (c
->argc
< -cmd
->arity
)) {
2238 sdscatprintf(sdsempty(),
2239 "-ERR wrong number of arguments for '%s' command\r\n",
2243 } else if (cmd
->flags
& REDIS_CMD_BULK
&& c
->bulklen
== -1) {
2244 /* This is a bulk command, we have to read the last argument yet. */
2245 int bulklen
= atoi(c
->argv
[c
->argc
-1]->ptr
);
2247 decrRefCount(c
->argv
[c
->argc
-1]);
2248 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2250 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2255 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2256 /* It is possible that the bulk read is already in the
2257 * buffer. Check this condition and handle it accordingly.
2258 * This is just a fast path, alternative to call processInputBuffer().
2259 * It's a good idea since the code is small and this condition
2260 * happens most of the times. */
2261 if ((signed)sdslen(c
->querybuf
) >= c
->bulklen
) {
2262 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2264 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2266 /* Otherwise return... there is to read the last argument
2267 * from the socket. */
2271 /* Let's try to share objects on the command arguments vector */
2272 if (server
.shareobjects
) {
2274 for(j
= 1; j
< c
->argc
; j
++)
2275 c
->argv
[j
] = tryObjectSharing(c
->argv
[j
]);
2277 /* Let's try to encode the bulk object to save space. */
2278 if (cmd
->flags
& REDIS_CMD_BULK
)
2279 tryObjectEncoding(c
->argv
[c
->argc
-1]);
2281 /* Check if the user is authenticated */
2282 if (server
.requirepass
&& !c
->authenticated
&& cmd
->proc
!= authCommand
) {
2283 addReplySds(c
,sdsnew("-ERR operation not permitted\r\n"));
2288 /* Handle the maxmemory directive */
2289 if (server
.maxmemory
&& (cmd
->flags
& REDIS_CMD_DENYOOM
) &&
2290 zmalloc_used_memory() > server
.maxmemory
)
2292 addReplySds(c
,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2297 /* Only allow SUBSCRIBE and UNSUBSCRIBE in the context of Pub/Sub */
2298 if (dictSize(c
->pubsub_channels
) > 0 &&
2299 cmd
->proc
!= subscribeCommand
&& cmd
->proc
!= unsubscribeCommand
&&
2300 cmd
->proc
!= psubscribeCommand
&& cmd
->proc
!= punsubscribeCommand
) {
2301 addReplySds(c
,sdsnew("-ERR only (P)SUBSCRIBE / (P)UNSUBSCRIBE / QUIT allowed in this context\r\n"));
2306 /* Exec the command */
2307 if (c
->flags
& REDIS_MULTI
&& cmd
->proc
!= execCommand
&& cmd
->proc
!= discardCommand
) {
2308 queueMultiCommand(c
,cmd
);
2309 addReply(c
,shared
.queued
);
2311 if (server
.vm_enabled
&& server
.vm_max_threads
> 0 &&
2312 blockClientOnSwappedKeys(cmd
,c
)) return 1;
2316 /* Prepare the client for the next command */
2321 static void replicationFeedSlaves(list
*slaves
, int dictid
, robj
**argv
, int argc
) {
2326 /* We need 1+(ARGS*3) objects since commands are using the new protocol
2327 * and we one 1 object for the first "*<count>\r\n" multibulk count, then
2328 * for every additional object we have "$<count>\r\n" + object + "\r\n". */
2329 robj
*static_outv
[REDIS_STATIC_ARGS
*3+1];
2332 if (argc
<= REDIS_STATIC_ARGS
) {
2335 outv
= zmalloc(sizeof(robj
*)*(argc
*3+1));
2338 lenobj
= createObject(REDIS_STRING
,
2339 sdscatprintf(sdsempty(), "*%d\r\n", argc
));
2340 lenobj
->refcount
= 0;
2341 outv
[outc
++] = lenobj
;
2342 for (j
= 0; j
< argc
; j
++) {
2343 lenobj
= createObject(REDIS_STRING
,
2344 sdscatprintf(sdsempty(),"$%lu\r\n",
2345 (unsigned long) stringObjectLen(argv
[j
])));
2346 lenobj
->refcount
= 0;
2347 outv
[outc
++] = lenobj
;
2348 outv
[outc
++] = argv
[j
];
2349 outv
[outc
++] = shared
.crlf
;
2352 /* Increment all the refcounts at start and decrement at end in order to
2353 * be sure to free objects if there is no slave in a replication state
2354 * able to be feed with commands */
2355 for (j
= 0; j
< outc
; j
++) incrRefCount(outv
[j
]);
2356 listRewind(slaves
,&li
);
2357 while((ln
= listNext(&li
))) {
2358 redisClient
*slave
= ln
->value
;
2360 /* Don't feed slaves that are still waiting for BGSAVE to start */
2361 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) continue;
2363 /* Feed all the other slaves, MONITORs and so on */
2364 if (slave
->slaveseldb
!= dictid
) {
2368 case 0: selectcmd
= shared
.select0
; break;
2369 case 1: selectcmd
= shared
.select1
; break;
2370 case 2: selectcmd
= shared
.select2
; break;
2371 case 3: selectcmd
= shared
.select3
; break;
2372 case 4: selectcmd
= shared
.select4
; break;
2373 case 5: selectcmd
= shared
.select5
; break;
2374 case 6: selectcmd
= shared
.select6
; break;
2375 case 7: selectcmd
= shared
.select7
; break;
2376 case 8: selectcmd
= shared
.select8
; break;
2377 case 9: selectcmd
= shared
.select9
; break;
2379 selectcmd
= createObject(REDIS_STRING
,
2380 sdscatprintf(sdsempty(),"select %d\r\n",dictid
));
2381 selectcmd
->refcount
= 0;
2384 addReply(slave
,selectcmd
);
2385 slave
->slaveseldb
= dictid
;
2387 for (j
= 0; j
< outc
; j
++) addReply(slave
,outv
[j
]);
2389 for (j
= 0; j
< outc
; j
++) decrRefCount(outv
[j
]);
2390 if (outv
!= static_outv
) zfree(outv
);
2393 static void processInputBuffer(redisClient
*c
) {
2395 /* Before to process the input buffer, make sure the client is not
2396 * waitig for a blocking operation such as BLPOP. Note that the first
2397 * iteration the client is never blocked, otherwise the processInputBuffer
2398 * would not be called at all, but after the execution of the first commands
2399 * in the input buffer the client may be blocked, and the "goto again"
2400 * will try to reiterate. The following line will make it return asap. */
2401 if (c
->flags
& REDIS_BLOCKED
|| c
->flags
& REDIS_IO_WAIT
) return;
2402 if (c
->bulklen
== -1) {
2403 /* Read the first line of the query */
2404 char *p
= strchr(c
->querybuf
,'\n');
2411 query
= c
->querybuf
;
2412 c
->querybuf
= sdsempty();
2413 querylen
= 1+(p
-(query
));
2414 if (sdslen(query
) > querylen
) {
2415 /* leave data after the first line of the query in the buffer */
2416 c
->querybuf
= sdscatlen(c
->querybuf
,query
+querylen
,sdslen(query
)-querylen
);
2418 *p
= '\0'; /* remove "\n" */
2419 if (*(p
-1) == '\r') *(p
-1) = '\0'; /* and "\r" if any */
2420 sdsupdatelen(query
);
2422 /* Now we can split the query in arguments */
2423 argv
= sdssplitlen(query
,sdslen(query
)," ",1,&argc
);
2426 if (c
->argv
) zfree(c
->argv
);
2427 c
->argv
= zmalloc(sizeof(robj
*)*argc
);
2429 for (j
= 0; j
< argc
; j
++) {
2430 if (sdslen(argv
[j
])) {
2431 c
->argv
[c
->argc
] = createObject(REDIS_STRING
,argv
[j
]);
2439 /* Execute the command. If the client is still valid
2440 * after processCommand() return and there is something
2441 * on the query buffer try to process the next command. */
2442 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2444 /* Nothing to process, argc == 0. Just process the query
2445 * buffer if it's not empty or return to the caller */
2446 if (sdslen(c
->querybuf
)) goto again
;
2449 } else if (sdslen(c
->querybuf
) >= REDIS_REQUEST_MAX_SIZE
) {
2450 redisLog(REDIS_VERBOSE
, "Client protocol error");
2455 /* Bulk read handling. Note that if we are at this point
2456 the client already sent a command terminated with a newline,
2457 we are reading the bulk data that is actually the last
2458 argument of the command. */
2459 int qbl
= sdslen(c
->querybuf
);
2461 if (c
->bulklen
<= qbl
) {
2462 /* Copy everything but the final CRLF as final argument */
2463 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2465 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2466 /* Process the command. If the client is still valid after
2467 * the processing and there is more data in the buffer
2468 * try to parse it. */
2469 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2475 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2476 redisClient
*c
= (redisClient
*) privdata
;
2477 char buf
[REDIS_IOBUF_LEN
];
2480 REDIS_NOTUSED(mask
);
2482 nread
= read(fd
, buf
, REDIS_IOBUF_LEN
);
2484 if (errno
== EAGAIN
) {
2487 redisLog(REDIS_VERBOSE
, "Reading from client: %s",strerror(errno
));
2491 } else if (nread
== 0) {
2492 redisLog(REDIS_VERBOSE
, "Client closed connection");
2497 c
->querybuf
= sdscatlen(c
->querybuf
, buf
, nread
);
2498 c
->lastinteraction
= time(NULL
);
2502 processInputBuffer(c
);
2505 static int selectDb(redisClient
*c
, int id
) {
2506 if (id
< 0 || id
>= server
.dbnum
)
2508 c
->db
= &server
.db
[id
];
2512 static void *dupClientReplyValue(void *o
) {
2513 incrRefCount((robj
*)o
);
2517 static int listMatchObjects(void *a
, void *b
) {
2518 return compareStringObjects(a
,b
) == 0;
2521 static redisClient
*createClient(int fd
) {
2522 redisClient
*c
= zmalloc(sizeof(*c
));
2524 anetNonBlock(NULL
,fd
);
2525 anetTcpNoDelay(NULL
,fd
);
2526 if (!c
) return NULL
;
2529 c
->querybuf
= sdsempty();
2538 c
->lastinteraction
= time(NULL
);
2539 c
->authenticated
= 0;
2540 c
->replstate
= REDIS_REPL_NONE
;
2541 c
->reply
= listCreate();
2542 listSetFreeMethod(c
->reply
,decrRefCount
);
2543 listSetDupMethod(c
->reply
,dupClientReplyValue
);
2544 c
->blockingkeys
= NULL
;
2545 c
->blockingkeysnum
= 0;
2546 c
->io_keys
= listCreate();
2547 listSetFreeMethod(c
->io_keys
,decrRefCount
);
2548 c
->pubsub_channels
= dictCreate(&setDictType
,NULL
);
2549 c
->pubsub_patterns
= listCreate();
2550 listSetFreeMethod(c
->pubsub_patterns
,decrRefCount
);
2551 listSetMatchMethod(c
->pubsub_patterns
,listMatchObjects
);
2552 if (aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
2553 readQueryFromClient
, c
) == AE_ERR
) {
2557 listAddNodeTail(server
.clients
,c
);
2558 initClientMultiState(c
);
2562 static void addReply(redisClient
*c
, robj
*obj
) {
2563 if (listLength(c
->reply
) == 0 &&
2564 (c
->replstate
== REDIS_REPL_NONE
||
2565 c
->replstate
== REDIS_REPL_ONLINE
) &&
2566 aeCreateFileEvent(server
.el
, c
->fd
, AE_WRITABLE
,
2567 sendReplyToClient
, c
) == AE_ERR
) return;
2569 if (server
.vm_enabled
&& obj
->storage
!= REDIS_VM_MEMORY
) {
2570 obj
= dupStringObject(obj
);
2571 obj
->refcount
= 0; /* getDecodedObject() will increment the refcount */
2573 listAddNodeTail(c
->reply
,getDecodedObject(obj
));
2576 static void addReplySds(redisClient
*c
, sds s
) {
2577 robj
*o
= createObject(REDIS_STRING
,s
);
2582 static void addReplyDouble(redisClient
*c
, double d
) {
2585 snprintf(buf
,sizeof(buf
),"%.17g",d
);
2586 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2587 (unsigned long) strlen(buf
),buf
));
2590 static void addReplyLong(redisClient
*c
, long l
) {
2595 addReply(c
,shared
.czero
);
2597 } else if (l
== 1) {
2598 addReply(c
,shared
.cone
);
2601 len
= snprintf(buf
,sizeof(buf
),":%ld\r\n",l
);
2602 addReplySds(c
,sdsnewlen(buf
,len
));
2605 static void addReplyLongLong(redisClient
*c
, long long ll
) {
2610 addReply(c
,shared
.czero
);
2612 } else if (ll
== 1) {
2613 addReply(c
,shared
.cone
);
2616 len
= snprintf(buf
,sizeof(buf
),":%lld\r\n",ll
);
2617 addReplySds(c
,sdsnewlen(buf
,len
));
2620 static void addReplyUlong(redisClient
*c
, unsigned long ul
) {
2625 addReply(c
,shared
.czero
);
2627 } else if (ul
== 1) {
2628 addReply(c
,shared
.cone
);
2631 len
= snprintf(buf
,sizeof(buf
),":%lu\r\n",ul
);
2632 addReplySds(c
,sdsnewlen(buf
,len
));
2635 static void addReplyBulkLen(redisClient
*c
, robj
*obj
) {
2638 if (obj
->encoding
== REDIS_ENCODING_RAW
) {
2639 len
= sdslen(obj
->ptr
);
2641 long n
= (long)obj
->ptr
;
2643 /* Compute how many bytes will take this integer as a radix 10 string */
2649 while((n
= n
/10) != 0) {
2653 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",(unsigned long)len
));
2656 static void addReplyBulk(redisClient
*c
, robj
*obj
) {
2657 addReplyBulkLen(c
,obj
);
2659 addReply(c
,shared
.crlf
);
2662 /* In the CONFIG command we need to add vanilla C string as bulk replies */
2663 static void addReplyBulkCString(redisClient
*c
, char *s
) {
2665 addReply(c
,shared
.nullbulk
);
2667 robj
*o
= createStringObject(s
,strlen(s
));
2673 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2678 REDIS_NOTUSED(mask
);
2679 REDIS_NOTUSED(privdata
);
2681 cfd
= anetAccept(server
.neterr
, fd
, cip
, &cport
);
2682 if (cfd
== AE_ERR
) {
2683 redisLog(REDIS_VERBOSE
,"Accepting client connection: %s", server
.neterr
);
2686 redisLog(REDIS_VERBOSE
,"Accepted %s:%d", cip
, cport
);
2687 if ((c
= createClient(cfd
)) == NULL
) {
2688 redisLog(REDIS_WARNING
,"Error allocating resoures for the client");
2689 close(cfd
); /* May be already closed, just ingore errors */
2692 /* If maxclient directive is set and this is one client more... close the
2693 * connection. Note that we create the client instead to check before
2694 * for this condition, since now the socket is already set in nonblocking
2695 * mode and we can send an error for free using the Kernel I/O */
2696 if (server
.maxclients
&& listLength(server
.clients
) > server
.maxclients
) {
2697 char *err
= "-ERR max number of clients reached\r\n";
2699 /* That's a best effort error message, don't check write errors */
2700 if (write(c
->fd
,err
,strlen(err
)) == -1) {
2701 /* Nothing to do, Just to avoid the warning... */
2706 server
.stat_numconnections
++;
2709 /* ======================= Redis objects implementation ===================== */
2711 static robj
*createObject(int type
, void *ptr
) {
2714 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2715 if (listLength(server
.objfreelist
)) {
2716 listNode
*head
= listFirst(server
.objfreelist
);
2717 o
= listNodeValue(head
);
2718 listDelNode(server
.objfreelist
,head
);
2719 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2721 if (server
.vm_enabled
) {
2722 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2723 o
= zmalloc(sizeof(*o
));
2725 o
= zmalloc(sizeof(*o
)-sizeof(struct redisObjectVM
));
2729 o
->encoding
= REDIS_ENCODING_RAW
;
2732 if (server
.vm_enabled
) {
2733 /* Note that this code may run in the context of an I/O thread
2734 * and accessing to server.unixtime in theory is an error
2735 * (no locks). But in practice this is safe, and even if we read
2736 * garbage Redis will not fail, as it's just a statistical info */
2737 o
->vm
.atime
= server
.unixtime
;
2738 o
->storage
= REDIS_VM_MEMORY
;
2743 static robj
*createStringObject(char *ptr
, size_t len
) {
2744 return createObject(REDIS_STRING
,sdsnewlen(ptr
,len
));
2747 static robj
*dupStringObject(robj
*o
) {
2748 assert(o
->encoding
== REDIS_ENCODING_RAW
);
2749 return createStringObject(o
->ptr
,sdslen(o
->ptr
));
2752 static robj
*createListObject(void) {
2753 list
*l
= listCreate();
2755 listSetFreeMethod(l
,decrRefCount
);
2756 return createObject(REDIS_LIST
,l
);
2759 static robj
*createSetObject(void) {
2760 dict
*d
= dictCreate(&setDictType
,NULL
);
2761 return createObject(REDIS_SET
,d
);
2764 static robj
*createHashObject(void) {
2765 /* All the Hashes start as zipmaps. Will be automatically converted
2766 * into hash tables if there are enough elements or big elements
2768 unsigned char *zm
= zipmapNew();
2769 robj
*o
= createObject(REDIS_HASH
,zm
);
2770 o
->encoding
= REDIS_ENCODING_ZIPMAP
;
2774 static robj
*createZsetObject(void) {
2775 zset
*zs
= zmalloc(sizeof(*zs
));
2777 zs
->dict
= dictCreate(&zsetDictType
,NULL
);
2778 zs
->zsl
= zslCreate();
2779 return createObject(REDIS_ZSET
,zs
);
2782 static void freeStringObject(robj
*o
) {
2783 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2788 static void freeListObject(robj
*o
) {
2789 listRelease((list
*) o
->ptr
);
2792 static void freeSetObject(robj
*o
) {
2793 dictRelease((dict
*) o
->ptr
);
2796 static void freeZsetObject(robj
*o
) {
2799 dictRelease(zs
->dict
);
2804 static void freeHashObject(robj
*o
) {
2805 switch (o
->encoding
) {
2806 case REDIS_ENCODING_HT
:
2807 dictRelease((dict
*) o
->ptr
);
2809 case REDIS_ENCODING_ZIPMAP
:
2818 static void incrRefCount(robj
*o
) {
2819 redisAssert(!server
.vm_enabled
|| o
->storage
== REDIS_VM_MEMORY
);
2823 static void decrRefCount(void *obj
) {
2826 /* Object is a key of a swapped out value, or in the process of being
2828 if (server
.vm_enabled
&&
2829 (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
))
2831 if (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
) {
2832 redisAssert(o
->refcount
== 1);
2834 if (o
->storage
== REDIS_VM_LOADING
) vmCancelThreadedIOJob(obj
);
2835 redisAssert(o
->type
== REDIS_STRING
);
2836 freeStringObject(o
);
2837 vmMarkPagesFree(o
->vm
.page
,o
->vm
.usedpages
);
2838 pthread_mutex_lock(&server
.obj_freelist_mutex
);
2839 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2840 !listAddNodeHead(server
.objfreelist
,o
))
2842 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2843 server
.vm_stats_swapped_objects
--;
2846 /* Object is in memory, or in the process of being swapped out. */
2847 if (--(o
->refcount
) == 0) {
2848 if (server
.vm_enabled
&& o
->storage
== REDIS_VM_SWAPPING
)
2849 vmCancelThreadedIOJob(obj
);
2851 case REDIS_STRING
: freeStringObject(o
); break;
2852 case REDIS_LIST
: freeListObject(o
); break;
2853 case REDIS_SET
: freeSetObject(o
); break;
2854 case REDIS_ZSET
: freeZsetObject(o
); break;
2855 case REDIS_HASH
: freeHashObject(o
); break;
2856 default: redisAssert(0); break;
2858 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2859 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2860 !listAddNodeHead(server
.objfreelist
,o
))
2862 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2866 static robj
*lookupKey(redisDb
*db
, robj
*key
) {
2867 dictEntry
*de
= dictFind(db
->dict
,key
);
2869 robj
*key
= dictGetEntryKey(de
);
2870 robj
*val
= dictGetEntryVal(de
);
2872 if (server
.vm_enabled
) {
2873 if (key
->storage
== REDIS_VM_MEMORY
||
2874 key
->storage
== REDIS_VM_SWAPPING
)
2876 /* If we were swapping the object out, stop it, this key
2878 if (key
->storage
== REDIS_VM_SWAPPING
)
2879 vmCancelThreadedIOJob(key
);
2880 /* Update the access time of the key for the aging algorithm. */
2881 key
->vm
.atime
= server
.unixtime
;
2883 int notify
= (key
->storage
== REDIS_VM_LOADING
);
2885 /* Our value was swapped on disk. Bring it at home. */
2886 redisAssert(val
== NULL
);
2887 val
= vmLoadObject(key
);
2888 dictGetEntryVal(de
) = val
;
2890 /* Clients blocked by the VM subsystem may be waiting for
2892 if (notify
) handleClientsBlockedOnSwappedKey(db
,key
);
2901 static robj
*lookupKeyRead(redisDb
*db
, robj
*key
) {
2902 expireIfNeeded(db
,key
);
2903 return lookupKey(db
,key
);
2906 static robj
*lookupKeyWrite(redisDb
*db
, robj
*key
) {
2907 deleteIfVolatile(db
,key
);
2908 return lookupKey(db
,key
);
2911 static robj
*lookupKeyReadOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
2912 robj
*o
= lookupKeyRead(c
->db
, key
);
2913 if (!o
) addReply(c
,reply
);
2917 static robj
*lookupKeyWriteOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
2918 robj
*o
= lookupKeyWrite(c
->db
, key
);
2919 if (!o
) addReply(c
,reply
);
2923 static int checkType(redisClient
*c
, robj
*o
, int type
) {
2924 if (o
->type
!= type
) {
2925 addReply(c
,shared
.wrongtypeerr
);
2931 static int deleteKey(redisDb
*db
, robj
*key
) {
2934 /* We need to protect key from destruction: after the first dictDelete()
2935 * it may happen that 'key' is no longer valid if we don't increment
2936 * it's count. This may happen when we get the object reference directly
2937 * from the hash table with dictRandomKey() or dict iterators */
2939 if (dictSize(db
->expires
)) dictDelete(db
->expires
,key
);
2940 retval
= dictDelete(db
->dict
,key
);
2943 return retval
== DICT_OK
;
2946 /* Try to share an object against the shared objects pool */
2947 static robj
*tryObjectSharing(robj
*o
) {
2948 struct dictEntry
*de
;
2951 if (o
== NULL
|| server
.shareobjects
== 0) return o
;
2953 redisAssert(o
->type
== REDIS_STRING
);
2954 de
= dictFind(server
.sharingpool
,o
);
2956 robj
*shared
= dictGetEntryKey(de
);
2958 c
= ((unsigned long) dictGetEntryVal(de
))+1;
2959 dictGetEntryVal(de
) = (void*) c
;
2960 incrRefCount(shared
);
2964 /* Here we are using a stream algorihtm: Every time an object is
2965 * shared we increment its count, everytime there is a miss we
2966 * recrement the counter of a random object. If this object reaches
2967 * zero we remove the object and put the current object instead. */
2968 if (dictSize(server
.sharingpool
) >=
2969 server
.sharingpoolsize
) {
2970 de
= dictGetRandomKey(server
.sharingpool
);
2971 redisAssert(de
!= NULL
);
2972 c
= ((unsigned long) dictGetEntryVal(de
))-1;
2973 dictGetEntryVal(de
) = (void*) c
;
2975 dictDelete(server
.sharingpool
,de
->key
);
2978 c
= 0; /* If the pool is empty we want to add this object */
2983 retval
= dictAdd(server
.sharingpool
,o
,(void*)1);
2984 redisAssert(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 int tryObjectEncoding(robj
*o
) {
3018 if (o
->encoding
!= REDIS_ENCODING_RAW
)
3019 return REDIS_ERR
; /* Already encoded */
3021 /* It's not save 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 REDIS_ERR
;
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 REDIS_ERR
;
3032 /* Ok, this object can be encoded */
3033 o
->encoding
= REDIS_ENCODING_INT
;
3035 o
->ptr
= (void*) value
;
3039 /* Get a decoded version of an encoded object (returned as a new object).
3040 * If the object is already raw-encoded just increment the ref count. */
3041 static robj
*getDecodedObject(robj
*o
) {
3044 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3048 if (o
->type
== REDIS_STRING
&& o
->encoding
== REDIS_ENCODING_INT
) {
3051 snprintf(buf
,32,"%ld",(long)o
->ptr
);
3052 dec
= createStringObject(buf
,strlen(buf
));
3055 redisAssert(1 != 1);
3059 /* Compare two string objects via strcmp() or alike.
3060 * Note that the objects may be integer-encoded. In such a case we
3061 * use snprintf() to get a string representation of the numbers on the stack
3062 * and compare the strings, it's much faster than calling getDecodedObject().
3064 * Important note: if objects are not integer encoded, but binary-safe strings,
3065 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
3067 static int compareStringObjects(robj
*a
, robj
*b
) {
3068 redisAssert(a
->type
== REDIS_STRING
&& b
->type
== REDIS_STRING
);
3069 char bufa
[128], bufb
[128], *astr
, *bstr
;
3072 if (a
== b
) return 0;
3073 if (a
->encoding
!= REDIS_ENCODING_RAW
) {
3074 snprintf(bufa
,sizeof(bufa
),"%ld",(long) a
->ptr
);
3080 if (b
->encoding
!= REDIS_ENCODING_RAW
) {
3081 snprintf(bufb
,sizeof(bufb
),"%ld",(long) b
->ptr
);
3087 return bothsds
? sdscmp(astr
,bstr
) : strcmp(astr
,bstr
);
3090 static size_t stringObjectLen(robj
*o
) {
3091 redisAssert(o
->type
== REDIS_STRING
);
3092 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3093 return sdslen(o
->ptr
);
3097 return snprintf(buf
,32,"%ld",(long)o
->ptr
);
3101 /*============================ RDB saving/loading =========================== */
3103 static int rdbSaveType(FILE *fp
, unsigned char type
) {
3104 if (fwrite(&type
,1,1,fp
) == 0) return -1;
3108 static int rdbSaveTime(FILE *fp
, time_t t
) {
3109 int32_t t32
= (int32_t) t
;
3110 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
3114 /* check rdbLoadLen() comments for more info */
3115 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
3116 unsigned char buf
[2];
3119 /* Save a 6 bit len */
3120 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
3121 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3122 } else if (len
< (1<<14)) {
3123 /* Save a 14 bit len */
3124 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
3126 if (fwrite(buf
,2,1,fp
) == 0) return -1;
3128 /* Save a 32 bit len */
3129 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
3130 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3132 if (fwrite(&len
,4,1,fp
) == 0) return -1;
3137 /* String objects in the form "2391" "-100" without any space and with a
3138 * range of values that can fit in an 8, 16 or 32 bit signed value can be
3139 * encoded as integers to save space */
3140 static int rdbTryIntegerEncoding(char *s
, size_t len
, unsigned char *enc
) {
3142 char *endptr
, buf
[32];
3144 /* Check if it's possible to encode this value as a number */
3145 value
= strtoll(s
, &endptr
, 10);
3146 if (endptr
[0] != '\0') return 0;
3147 snprintf(buf
,32,"%lld",value
);
3149 /* If the number converted back into a string is not identical
3150 * then it's not possible to encode the string as integer */
3151 if (strlen(buf
) != len
|| memcmp(buf
,s
,len
)) return 0;
3153 /* Finally check if it fits in our ranges */
3154 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
3155 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
3156 enc
[1] = value
&0xFF;
3158 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
3159 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
3160 enc
[1] = value
&0xFF;
3161 enc
[2] = (value
>>8)&0xFF;
3163 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
3164 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
3165 enc
[1] = value
&0xFF;
3166 enc
[2] = (value
>>8)&0xFF;
3167 enc
[3] = (value
>>16)&0xFF;
3168 enc
[4] = (value
>>24)&0xFF;
3175 static int rdbSaveLzfStringObject(FILE *fp
, unsigned char *s
, size_t len
) {
3176 size_t comprlen
, outlen
;
3180 /* We require at least four bytes compression for this to be worth it */
3181 if (len
<= 4) return 0;
3183 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
3184 comprlen
= lzf_compress(s
, len
, out
, outlen
);
3185 if (comprlen
== 0) {
3189 /* Data compressed! Let's save it on disk */
3190 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
3191 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
3192 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
3193 if (rdbSaveLen(fp
,len
) == -1) goto writeerr
;
3194 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
3203 /* Save a string objet as [len][data] on disk. If the object is a string
3204 * representation of an integer value we try to safe it in a special form */
3205 static int rdbSaveRawString(FILE *fp
, unsigned char *s
, size_t len
) {
3208 /* Try integer encoding */
3210 unsigned char buf
[5];
3211 if ((enclen
= rdbTryIntegerEncoding((char*)s
,len
,buf
)) > 0) {
3212 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3217 /* Try LZF compression - under 20 bytes it's unable to compress even
3218 * aaaaaaaaaaaaaaaaaa so skip it */
3219 if (server
.rdbcompression
&& len
> 20) {
3222 retval
= rdbSaveLzfStringObject(fp
,s
,len
);
3223 if (retval
== -1) return -1;
3224 if (retval
> 0) return 0;
3225 /* retval == 0 means data can't be compressed, save the old way */
3228 /* Store verbatim */
3229 if (rdbSaveLen(fp
,len
) == -1) return -1;
3230 if (len
&& fwrite(s
,len
,1,fp
) == 0) return -1;
3234 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
3235 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
3238 /* Avoid incr/decr ref count business when possible.
3239 * This plays well with copy-on-write given that we are probably
3240 * in a child process (BGSAVE). Also this makes sure key objects
3241 * of swapped objects are not incRefCount-ed (an assert does not allow
3242 * this in order to avoid bugs) */
3243 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
3244 obj
= getDecodedObject(obj
);
3245 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3248 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3253 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
3254 * 8 bit integer specifing the length of the representation.
3255 * This 8 bit integer has special values in order to specify the following
3261 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
3262 unsigned char buf
[128];
3268 } else if (!isfinite(val
)) {
3270 buf
[0] = (val
< 0) ? 255 : 254;
3272 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
3273 buf
[0] = strlen((char*)buf
+1);
3276 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
3280 /* Save a Redis object. */
3281 static int rdbSaveObject(FILE *fp
, robj
*o
) {
3282 if (o
->type
== REDIS_STRING
) {
3283 /* Save a string value */
3284 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
3285 } else if (o
->type
== REDIS_LIST
) {
3286 /* Save a list value */
3287 list
*list
= o
->ptr
;
3291 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
3292 listRewind(list
,&li
);
3293 while((ln
= listNext(&li
))) {
3294 robj
*eleobj
= listNodeValue(ln
);
3296 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3298 } else if (o
->type
== REDIS_SET
) {
3299 /* Save a set value */
3301 dictIterator
*di
= dictGetIterator(set
);
3304 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
3305 while((de
= dictNext(di
)) != NULL
) {
3306 robj
*eleobj
= dictGetEntryKey(de
);
3308 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3310 dictReleaseIterator(di
);
3311 } else if (o
->type
== REDIS_ZSET
) {
3312 /* Save a set value */
3314 dictIterator
*di
= dictGetIterator(zs
->dict
);
3317 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
3318 while((de
= dictNext(di
)) != NULL
) {
3319 robj
*eleobj
= dictGetEntryKey(de
);
3320 double *score
= dictGetEntryVal(de
);
3322 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3323 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
3325 dictReleaseIterator(di
);
3326 } else if (o
->type
== REDIS_HASH
) {
3327 /* Save a hash value */
3328 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3329 unsigned char *p
= zipmapRewind(o
->ptr
);
3330 unsigned int count
= zipmapLen(o
->ptr
);
3331 unsigned char *key
, *val
;
3332 unsigned int klen
, vlen
;
3334 if (rdbSaveLen(fp
,count
) == -1) return -1;
3335 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
3336 if (rdbSaveRawString(fp
,key
,klen
) == -1) return -1;
3337 if (rdbSaveRawString(fp
,val
,vlen
) == -1) return -1;
3340 dictIterator
*di
= dictGetIterator(o
->ptr
);
3343 if (rdbSaveLen(fp
,dictSize((dict
*)o
->ptr
)) == -1) return -1;
3344 while((de
= dictNext(di
)) != NULL
) {
3345 robj
*key
= dictGetEntryKey(de
);
3346 robj
*val
= dictGetEntryVal(de
);
3348 if (rdbSaveStringObject(fp
,key
) == -1) return -1;
3349 if (rdbSaveStringObject(fp
,val
) == -1) return -1;
3351 dictReleaseIterator(di
);
3359 /* Return the length the object will have on disk if saved with
3360 * the rdbSaveObject() function. Currently we use a trick to get
3361 * this length with very little changes to the code. In the future
3362 * we could switch to a faster solution. */
3363 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
3364 if (fp
== NULL
) fp
= server
.devnull
;
3366 assert(rdbSaveObject(fp
,o
) != 1);
3370 /* Return the number of pages required to save this object in the swap file */
3371 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
3372 off_t bytes
= rdbSavedObjectLen(o
,fp
);
3374 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
3377 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3378 static int rdbSave(char *filename
) {
3379 dictIterator
*di
= NULL
;
3384 time_t now
= time(NULL
);
3386 /* Wait for I/O therads to terminate, just in case this is a
3387 * foreground-saving, to avoid seeking the swap file descriptor at the
3389 if (server
.vm_enabled
)
3390 waitEmptyIOJobsQueue();
3392 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3393 fp
= fopen(tmpfile
,"w");
3395 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3398 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3399 for (j
= 0; j
< server
.dbnum
; j
++) {
3400 redisDb
*db
= server
.db
+j
;
3402 if (dictSize(d
) == 0) continue;
3403 di
= dictGetIterator(d
);
3409 /* Write the SELECT DB opcode */
3410 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3411 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3413 /* Iterate this DB writing every entry */
3414 while((de
= dictNext(di
)) != NULL
) {
3415 robj
*key
= dictGetEntryKey(de
);
3416 robj
*o
= dictGetEntryVal(de
);
3417 time_t expiretime
= getExpire(db
,key
);
3419 /* Save the expire time */
3420 if (expiretime
!= -1) {
3421 /* If this key is already expired skip it */
3422 if (expiretime
< now
) continue;
3423 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3424 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3426 /* Save the key and associated value. This requires special
3427 * handling if the value is swapped out. */
3428 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
3429 key
->storage
== REDIS_VM_SWAPPING
) {
3430 /* Save type, key, value */
3431 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3432 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3433 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3435 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3437 /* Get a preview of the object in memory */
3438 po
= vmPreviewObject(key
);
3439 /* Save type, key, value */
3440 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
3441 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3442 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3443 /* Remove the loaded object from memory */
3447 dictReleaseIterator(di
);
3450 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3452 /* Make sure data will not remain on the OS's output buffers */
3457 /* Use RENAME to make sure the DB file is changed atomically only
3458 * if the generate DB file is ok. */
3459 if (rename(tmpfile
,filename
) == -1) {
3460 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3464 redisLog(REDIS_NOTICE
,"DB saved on disk");
3466 server
.lastsave
= time(NULL
);
3472 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3473 if (di
) dictReleaseIterator(di
);
3477 static int rdbSaveBackground(char *filename
) {
3480 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3481 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
3482 if ((childpid
= fork()) == 0) {
3484 if (server
.vm_enabled
) vmReopenSwapFile();
3486 if (rdbSave(filename
) == REDIS_OK
) {
3493 if (childpid
== -1) {
3494 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3498 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3499 server
.bgsavechildpid
= childpid
;
3502 return REDIS_OK
; /* unreached */
3505 static void rdbRemoveTempFile(pid_t childpid
) {
3508 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
3512 static int rdbLoadType(FILE *fp
) {
3514 if (fread(&type
,1,1,fp
) == 0) return -1;
3518 static time_t rdbLoadTime(FILE *fp
) {
3520 if (fread(&t32
,4,1,fp
) == 0) return -1;
3521 return (time_t) t32
;
3524 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3525 * of this file for a description of how this are stored on disk.
3527 * isencoded is set to 1 if the readed length is not actually a length but
3528 * an "encoding type", check the above comments for more info */
3529 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3530 unsigned char buf
[2];
3534 if (isencoded
) *isencoded
= 0;
3535 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3536 type
= (buf
[0]&0xC0)>>6;
3537 if (type
== REDIS_RDB_6BITLEN
) {
3538 /* Read a 6 bit len */
3540 } else if (type
== REDIS_RDB_ENCVAL
) {
3541 /* Read a 6 bit len encoding type */
3542 if (isencoded
) *isencoded
= 1;
3544 } else if (type
== REDIS_RDB_14BITLEN
) {
3545 /* Read a 14 bit len */
3546 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3547 return ((buf
[0]&0x3F)<<8)|buf
[1];
3549 /* Read a 32 bit len */
3550 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3555 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
) {
3556 unsigned char enc
[4];
3559 if (enctype
== REDIS_RDB_ENC_INT8
) {
3560 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3561 val
= (signed char)enc
[0];
3562 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3564 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3565 v
= enc
[0]|(enc
[1]<<8);
3567 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3569 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3570 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3573 val
= 0; /* anti-warning */
3576 return createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",val
));
3579 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3580 unsigned int len
, clen
;
3581 unsigned char *c
= NULL
;
3584 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3585 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3586 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3587 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3588 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3589 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3591 return createObject(REDIS_STRING
,val
);
3598 static robj
*rdbLoadStringObject(FILE*fp
) {
3603 len
= rdbLoadLen(fp
,&isencoded
);
3606 case REDIS_RDB_ENC_INT8
:
3607 case REDIS_RDB_ENC_INT16
:
3608 case REDIS_RDB_ENC_INT32
:
3609 return tryObjectSharing(rdbLoadIntegerObject(fp
,len
));
3610 case REDIS_RDB_ENC_LZF
:
3611 return tryObjectSharing(rdbLoadLzfStringObject(fp
));
3617 if (len
== REDIS_RDB_LENERR
) return NULL
;
3618 val
= sdsnewlen(NULL
,len
);
3619 if (len
&& fread(val
,len
,1,fp
) == 0) {
3623 return tryObjectSharing(createObject(REDIS_STRING
,val
));
3626 /* For information about double serialization check rdbSaveDoubleValue() */
3627 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
3631 if (fread(&len
,1,1,fp
) == 0) return -1;
3633 case 255: *val
= R_NegInf
; return 0;
3634 case 254: *val
= R_PosInf
; return 0;
3635 case 253: *val
= R_Nan
; return 0;
3637 if (fread(buf
,len
,1,fp
) == 0) return -1;
3639 sscanf(buf
, "%lg", val
);
3644 /* Load a Redis object of the specified type from the specified file.
3645 * On success a newly allocated object is returned, otherwise NULL. */
3646 static robj
*rdbLoadObject(int type
, FILE *fp
) {
3649 redisLog(REDIS_DEBUG
,"LOADING OBJECT %d (at %d)\n",type
,ftell(fp
));
3650 if (type
== REDIS_STRING
) {
3651 /* Read string value */
3652 if ((o
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3653 tryObjectEncoding(o
);
3654 } else if (type
== REDIS_LIST
|| type
== REDIS_SET
) {
3655 /* Read list/set value */
3658 if ((listlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3659 o
= (type
== REDIS_LIST
) ? createListObject() : createSetObject();
3660 /* It's faster to expand the dict to the right size asap in order
3661 * to avoid rehashing */
3662 if (type
== REDIS_SET
&& listlen
> DICT_HT_INITIAL_SIZE
)
3663 dictExpand(o
->ptr
,listlen
);
3664 /* Load every single element of the list/set */
3668 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3669 tryObjectEncoding(ele
);
3670 if (type
== REDIS_LIST
) {
3671 listAddNodeTail((list
*)o
->ptr
,ele
);
3673 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
3676 } else if (type
== REDIS_ZSET
) {
3677 /* Read list/set value */
3681 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3682 o
= createZsetObject();
3684 /* Load every single element of the list/set */
3687 double *score
= zmalloc(sizeof(double));
3689 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3690 tryObjectEncoding(ele
);
3691 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
3692 dictAdd(zs
->dict
,ele
,score
);
3693 zslInsert(zs
->zsl
,*score
,ele
);
3694 incrRefCount(ele
); /* added to skiplist */
3696 } else if (type
== REDIS_HASH
) {
3699 if ((hashlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3700 o
= createHashObject();
3701 /* Too many entries? Use an hash table. */
3702 if (hashlen
> server
.hash_max_zipmap_entries
)
3703 convertToRealHash(o
);
3704 /* Load every key/value, then set it into the zipmap or hash
3705 * table, as needed. */
3709 if ((key
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3710 if ((val
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3711 /* If we are using a zipmap and there are too big values
3712 * the object is converted to real hash table encoding. */
3713 if (o
->encoding
!= REDIS_ENCODING_HT
&&
3714 (sdslen(key
->ptr
) > server
.hash_max_zipmap_value
||
3715 sdslen(val
->ptr
) > server
.hash_max_zipmap_value
))
3717 convertToRealHash(o
);
3720 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3721 unsigned char *zm
= o
->ptr
;
3723 zm
= zipmapSet(zm
,key
->ptr
,sdslen(key
->ptr
),
3724 val
->ptr
,sdslen(val
->ptr
),NULL
);
3729 tryObjectEncoding(key
);
3730 tryObjectEncoding(val
);
3731 dictAdd((dict
*)o
->ptr
,key
,val
);
3740 static int rdbLoad(char *filename
) {
3742 robj
*keyobj
= NULL
;
3744 int type
, retval
, rdbver
;
3745 dict
*d
= server
.db
[0].dict
;
3746 redisDb
*db
= server
.db
+0;
3748 time_t expiretime
= -1, now
= time(NULL
);
3749 long long loadedkeys
= 0;
3751 fp
= fopen(filename
,"r");
3752 if (!fp
) return REDIS_ERR
;
3753 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
3755 if (memcmp(buf
,"REDIS",5) != 0) {
3757 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
3760 rdbver
= atoi(buf
+5);
3763 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
3770 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3771 if (type
== REDIS_EXPIRETIME
) {
3772 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
3773 /* We read the time so we need to read the object type again */
3774 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3776 if (type
== REDIS_EOF
) break;
3777 /* Handle SELECT DB opcode as a special case */
3778 if (type
== REDIS_SELECTDB
) {
3779 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
3781 if (dbid
>= (unsigned)server
.dbnum
) {
3782 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
3785 db
= server
.db
+dbid
;
3790 if ((keyobj
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
3792 if ((o
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
3793 /* Add the new object in the hash table */
3794 retval
= dictAdd(d
,keyobj
,o
);
3795 if (retval
== DICT_ERR
) {
3796 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", keyobj
->ptr
);
3799 /* Set the expire time if needed */
3800 if (expiretime
!= -1) {
3801 setExpire(db
,keyobj
,expiretime
);
3802 /* Delete this key if already expired */
3803 if (expiretime
< now
) deleteKey(db
,keyobj
);
3807 /* Handle swapping while loading big datasets when VM is on */
3809 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
3810 while (zmalloc_used_memory() > server
.vm_max_memory
) {
3811 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
3818 eoferr
: /* unexpected end of file is handled here with a fatal exit */
3819 if (keyobj
) decrRefCount(keyobj
);
3820 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
3822 return REDIS_ERR
; /* Just to avoid warning */
3825 /*================================== Commands =============================== */
3827 static void authCommand(redisClient
*c
) {
3828 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
3829 c
->authenticated
= 1;
3830 addReply(c
,shared
.ok
);
3832 c
->authenticated
= 0;
3833 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
3837 static void pingCommand(redisClient
*c
) {
3838 addReply(c
,shared
.pong
);
3841 static void echoCommand(redisClient
*c
) {
3842 addReplyBulk(c
,c
->argv
[1]);
3845 /*=================================== Strings =============================== */
3847 static void setGenericCommand(redisClient
*c
, int nx
) {
3850 if (nx
) deleteIfVolatile(c
->db
,c
->argv
[1]);
3851 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3852 if (retval
== DICT_ERR
) {
3854 /* If the key is about a swapped value, we want a new key object
3855 * to overwrite the old. So we delete the old key in the database.
3856 * This will also make sure that swap pages about the old object
3857 * will be marked as free. */
3858 if (server
.vm_enabled
&& deleteIfSwapped(c
->db
,c
->argv
[1]))
3859 incrRefCount(c
->argv
[1]);
3860 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3861 incrRefCount(c
->argv
[2]);
3863 addReply(c
,shared
.czero
);
3867 incrRefCount(c
->argv
[1]);
3868 incrRefCount(c
->argv
[2]);
3871 removeExpire(c
->db
,c
->argv
[1]);
3872 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3875 static void setCommand(redisClient
*c
) {
3876 setGenericCommand(c
,0);
3879 static void setnxCommand(redisClient
*c
) {
3880 setGenericCommand(c
,1);
3883 static int getGenericCommand(redisClient
*c
) {
3886 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
)
3889 if (o
->type
!= REDIS_STRING
) {
3890 addReply(c
,shared
.wrongtypeerr
);
3898 static void getCommand(redisClient
*c
) {
3899 getGenericCommand(c
);
3902 static void getsetCommand(redisClient
*c
) {
3903 if (getGenericCommand(c
) == REDIS_ERR
) return;
3904 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
3905 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3907 incrRefCount(c
->argv
[1]);
3909 incrRefCount(c
->argv
[2]);
3911 removeExpire(c
->db
,c
->argv
[1]);
3914 static void mgetCommand(redisClient
*c
) {
3917 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
3918 for (j
= 1; j
< c
->argc
; j
++) {
3919 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
3921 addReply(c
,shared
.nullbulk
);
3923 if (o
->type
!= REDIS_STRING
) {
3924 addReply(c
,shared
.nullbulk
);
3932 static void msetGenericCommand(redisClient
*c
, int nx
) {
3933 int j
, busykeys
= 0;
3935 if ((c
->argc
% 2) == 0) {
3936 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
3939 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
3940 * set nothing at all if at least one already key exists. */
3942 for (j
= 1; j
< c
->argc
; j
+= 2) {
3943 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
3949 addReply(c
, shared
.czero
);
3953 for (j
= 1; j
< c
->argc
; j
+= 2) {
3956 tryObjectEncoding(c
->argv
[j
+1]);
3957 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3958 if (retval
== DICT_ERR
) {
3959 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3960 incrRefCount(c
->argv
[j
+1]);
3962 incrRefCount(c
->argv
[j
]);
3963 incrRefCount(c
->argv
[j
+1]);
3965 removeExpire(c
->db
,c
->argv
[j
]);
3967 server
.dirty
+= (c
->argc
-1)/2;
3968 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3971 static void msetCommand(redisClient
*c
) {
3972 msetGenericCommand(c
,0);
3975 static void msetnxCommand(redisClient
*c
) {
3976 msetGenericCommand(c
,1);
3979 static void incrDecrCommand(redisClient
*c
, long long incr
) {
3984 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3988 if (o
->type
!= REDIS_STRING
) {
3993 if (o
->encoding
== REDIS_ENCODING_RAW
)
3994 value
= strtoll(o
->ptr
, &eptr
, 10);
3995 else if (o
->encoding
== REDIS_ENCODING_INT
)
3996 value
= (long)o
->ptr
;
3998 redisAssert(1 != 1);
4003 o
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
4004 tryObjectEncoding(o
);
4005 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
4006 if (retval
== DICT_ERR
) {
4007 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4008 removeExpire(c
->db
,c
->argv
[1]);
4010 incrRefCount(c
->argv
[1]);
4013 addReply(c
,shared
.colon
);
4015 addReply(c
,shared
.crlf
);
4018 static void incrCommand(redisClient
*c
) {
4019 incrDecrCommand(c
,1);
4022 static void decrCommand(redisClient
*c
) {
4023 incrDecrCommand(c
,-1);
4026 static void incrbyCommand(redisClient
*c
) {
4027 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
4028 incrDecrCommand(c
,incr
);
4031 static void decrbyCommand(redisClient
*c
) {
4032 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
4033 incrDecrCommand(c
,-incr
);
4036 static void appendCommand(redisClient
*c
) {
4041 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4043 /* Create the key */
4044 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4045 incrRefCount(c
->argv
[1]);
4046 incrRefCount(c
->argv
[2]);
4047 totlen
= stringObjectLen(c
->argv
[2]);
4051 de
= dictFind(c
->db
->dict
,c
->argv
[1]);
4054 o
= dictGetEntryVal(de
);
4055 if (o
->type
!= REDIS_STRING
) {
4056 addReply(c
,shared
.wrongtypeerr
);
4059 /* If the object is specially encoded or shared we have to make
4061 if (o
->refcount
!= 1 || o
->encoding
!= REDIS_ENCODING_RAW
) {
4062 robj
*decoded
= getDecodedObject(o
);
4064 o
= createStringObject(decoded
->ptr
, sdslen(decoded
->ptr
));
4065 decrRefCount(decoded
);
4066 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4069 if (c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
) {
4070 o
->ptr
= sdscatlen(o
->ptr
,
4071 c
->argv
[2]->ptr
, sdslen(c
->argv
[2]->ptr
));
4073 o
->ptr
= sdscatprintf(o
->ptr
, "%ld",
4074 (unsigned long) c
->argv
[2]->ptr
);
4076 totlen
= sdslen(o
->ptr
);
4079 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen
));
4082 static void substrCommand(redisClient
*c
) {
4084 long start
= atoi(c
->argv
[2]->ptr
);
4085 long end
= atoi(c
->argv
[3]->ptr
);
4086 size_t rangelen
, strlen
;
4089 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4090 checkType(c
,o
,REDIS_STRING
)) return;
4092 o
= getDecodedObject(o
);
4093 strlen
= sdslen(o
->ptr
);
4095 /* convert negative indexes */
4096 if (start
< 0) start
= strlen
+start
;
4097 if (end
< 0) end
= strlen
+end
;
4098 if (start
< 0) start
= 0;
4099 if (end
< 0) end
= 0;
4101 /* indexes sanity checks */
4102 if (start
> end
|| (size_t)start
>= strlen
) {
4103 /* Out of range start or start > end result in null reply */
4104 addReply(c
,shared
.nullbulk
);
4108 if ((size_t)end
>= strlen
) end
= strlen
-1;
4109 rangelen
= (end
-start
)+1;
4111 /* Return the result */
4112 addReplySds(c
,sdscatprintf(sdsempty(),"$%zu\r\n",rangelen
));
4113 range
= sdsnewlen((char*)o
->ptr
+start
,rangelen
);
4114 addReplySds(c
,range
);
4115 addReply(c
,shared
.crlf
);
4119 /* ========================= Type agnostic commands ========================= */
4121 static void delCommand(redisClient
*c
) {
4124 for (j
= 1; j
< c
->argc
; j
++) {
4125 if (deleteKey(c
->db
,c
->argv
[j
])) {
4130 addReplyLong(c
,deleted
);
4133 static void existsCommand(redisClient
*c
) {
4134 addReply(c
,lookupKeyRead(c
->db
,c
->argv
[1]) ? shared
.cone
: shared
.czero
);
4137 static void selectCommand(redisClient
*c
) {
4138 int id
= atoi(c
->argv
[1]->ptr
);
4140 if (selectDb(c
,id
) == REDIS_ERR
) {
4141 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
4143 addReply(c
,shared
.ok
);
4147 static void randomkeyCommand(redisClient
*c
) {
4151 de
= dictGetRandomKey(c
->db
->dict
);
4152 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
4155 addReply(c
,shared
.plus
);
4156 addReply(c
,shared
.crlf
);
4158 addReply(c
,shared
.plus
);
4159 addReply(c
,dictGetEntryKey(de
));
4160 addReply(c
,shared
.crlf
);
4164 static void keysCommand(redisClient
*c
) {
4167 sds pattern
= c
->argv
[1]->ptr
;
4168 int plen
= sdslen(pattern
);
4169 unsigned long numkeys
= 0;
4170 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
4172 di
= dictGetIterator(c
->db
->dict
);
4174 decrRefCount(lenobj
);
4175 while((de
= dictNext(di
)) != NULL
) {
4176 robj
*keyobj
= dictGetEntryKey(de
);
4178 sds key
= keyobj
->ptr
;
4179 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
4180 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
4181 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
4182 addReplyBulk(c
,keyobj
);
4187 dictReleaseIterator(di
);
4188 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",numkeys
);
4191 static void dbsizeCommand(redisClient
*c
) {
4193 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
4196 static void lastsaveCommand(redisClient
*c
) {
4198 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
4201 static void typeCommand(redisClient
*c
) {
4205 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4210 case REDIS_STRING
: type
= "+string"; break;
4211 case REDIS_LIST
: type
= "+list"; break;
4212 case REDIS_SET
: type
= "+set"; break;
4213 case REDIS_ZSET
: type
= "+zset"; break;
4214 case REDIS_HASH
: type
= "+hash"; break;
4215 default: type
= "+unknown"; break;
4218 addReplySds(c
,sdsnew(type
));
4219 addReply(c
,shared
.crlf
);
4222 static void saveCommand(redisClient
*c
) {
4223 if (server
.bgsavechildpid
!= -1) {
4224 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
4227 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4228 addReply(c
,shared
.ok
);
4230 addReply(c
,shared
.err
);
4234 static void bgsaveCommand(redisClient
*c
) {
4235 if (server
.bgsavechildpid
!= -1) {
4236 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
4239 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
4240 char *status
= "+Background saving started\r\n";
4241 addReplySds(c
,sdsnew(status
));
4243 addReply(c
,shared
.err
);
4247 static void shutdownCommand(redisClient
*c
) {
4248 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
4249 /* Kill the saving child if there is a background saving in progress.
4250 We want to avoid race conditions, for instance our saving child may
4251 overwrite the synchronous saving did by SHUTDOWN. */
4252 if (server
.bgsavechildpid
!= -1) {
4253 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
4254 kill(server
.bgsavechildpid
,SIGKILL
);
4255 rdbRemoveTempFile(server
.bgsavechildpid
);
4257 if (server
.appendonly
) {
4258 /* Append only file: fsync() the AOF and exit */
4259 fsync(server
.appendfd
);
4260 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4263 /* Snapshotting. Perform a SYNC SAVE and exit */
4264 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4265 if (server
.daemonize
)
4266 unlink(server
.pidfile
);
4267 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
4268 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
4269 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4272 /* Ooops.. error saving! The best we can do is to continue
4273 * operating. Note that if there was a background saving process,
4274 * in the next cron() Redis will be notified that the background
4275 * saving aborted, handling special stuff like slaves pending for
4276 * synchronization... */
4277 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
4279 sdsnew("-ERR can't quit, problems saving the DB\r\n"));
4284 static void renameGenericCommand(redisClient
*c
, int nx
) {
4287 /* To use the same key as src and dst is probably an error */
4288 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
4289 addReply(c
,shared
.sameobjecterr
);
4293 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
)
4297 deleteIfVolatile(c
->db
,c
->argv
[2]);
4298 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
4301 addReply(c
,shared
.czero
);
4304 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
4306 incrRefCount(c
->argv
[2]);
4308 deleteKey(c
->db
,c
->argv
[1]);
4310 addReply(c
,nx
? shared
.cone
: shared
.ok
);
4313 static void renameCommand(redisClient
*c
) {
4314 renameGenericCommand(c
,0);
4317 static void renamenxCommand(redisClient
*c
) {
4318 renameGenericCommand(c
,1);
4321 static void moveCommand(redisClient
*c
) {
4326 /* Obtain source and target DB pointers */
4329 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
4330 addReply(c
,shared
.outofrangeerr
);
4334 selectDb(c
,srcid
); /* Back to the source DB */
4336 /* If the user is moving using as target the same
4337 * DB as the source DB it is probably an error. */
4339 addReply(c
,shared
.sameobjecterr
);
4343 /* Check if the element exists and get a reference */
4344 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4346 addReply(c
,shared
.czero
);
4350 /* Try to add the element to the target DB */
4351 deleteIfVolatile(dst
,c
->argv
[1]);
4352 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
4353 addReply(c
,shared
.czero
);
4356 incrRefCount(c
->argv
[1]);
4359 /* OK! key moved, free the entry in the source DB */
4360 deleteKey(src
,c
->argv
[1]);
4362 addReply(c
,shared
.cone
);
4365 /* =================================== Lists ================================ */
4366 static void pushGenericCommand(redisClient
*c
, int where
) {
4370 lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4372 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4373 addReply(c
,shared
.cone
);
4376 lobj
= createListObject();
4378 if (where
== REDIS_HEAD
) {
4379 listAddNodeHead(list
,c
->argv
[2]);
4381 listAddNodeTail(list
,c
->argv
[2]);
4383 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
4384 incrRefCount(c
->argv
[1]);
4385 incrRefCount(c
->argv
[2]);
4387 if (lobj
->type
!= REDIS_LIST
) {
4388 addReply(c
,shared
.wrongtypeerr
);
4391 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4392 addReply(c
,shared
.cone
);
4396 if (where
== REDIS_HEAD
) {
4397 listAddNodeHead(list
,c
->argv
[2]);
4399 listAddNodeTail(list
,c
->argv
[2]);
4401 incrRefCount(c
->argv
[2]);
4404 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",listLength(list
)));
4407 static void lpushCommand(redisClient
*c
) {
4408 pushGenericCommand(c
,REDIS_HEAD
);
4411 static void rpushCommand(redisClient
*c
) {
4412 pushGenericCommand(c
,REDIS_TAIL
);
4415 static void llenCommand(redisClient
*c
) {
4419 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4420 checkType(c
,o
,REDIS_LIST
)) return;
4423 addReplyUlong(c
,listLength(l
));
4426 static void lindexCommand(redisClient
*c
) {
4428 int index
= atoi(c
->argv
[2]->ptr
);
4432 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4433 checkType(c
,o
,REDIS_LIST
)) return;
4436 ln
= listIndex(list
, index
);
4438 addReply(c
,shared
.nullbulk
);
4440 robj
*ele
= listNodeValue(ln
);
4441 addReplyBulk(c
,ele
);
4445 static void lsetCommand(redisClient
*c
) {
4447 int index
= atoi(c
->argv
[2]->ptr
);
4451 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
||
4452 checkType(c
,o
,REDIS_LIST
)) return;
4455 ln
= listIndex(list
, index
);
4457 addReply(c
,shared
.outofrangeerr
);
4459 robj
*ele
= listNodeValue(ln
);
4462 listNodeValue(ln
) = c
->argv
[3];
4463 incrRefCount(c
->argv
[3]);
4464 addReply(c
,shared
.ok
);
4469 static void popGenericCommand(redisClient
*c
, int where
) {
4474 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4475 checkType(c
,o
,REDIS_LIST
)) return;
4478 if (where
== REDIS_HEAD
)
4479 ln
= listFirst(list
);
4481 ln
= listLast(list
);
4484 addReply(c
,shared
.nullbulk
);
4486 robj
*ele
= listNodeValue(ln
);
4487 addReplyBulk(c
,ele
);
4488 listDelNode(list
,ln
);
4489 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4494 static void lpopCommand(redisClient
*c
) {
4495 popGenericCommand(c
,REDIS_HEAD
);
4498 static void rpopCommand(redisClient
*c
) {
4499 popGenericCommand(c
,REDIS_TAIL
);
4502 static void lrangeCommand(redisClient
*c
) {
4504 int start
= atoi(c
->argv
[2]->ptr
);
4505 int end
= atoi(c
->argv
[3]->ptr
);
4512 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullmultibulk
)) == NULL
||
4513 checkType(c
,o
,REDIS_LIST
)) return;
4515 llen
= listLength(list
);
4517 /* convert negative indexes */
4518 if (start
< 0) start
= llen
+start
;
4519 if (end
< 0) end
= llen
+end
;
4520 if (start
< 0) start
= 0;
4521 if (end
< 0) end
= 0;
4523 /* indexes sanity checks */
4524 if (start
> end
|| start
>= llen
) {
4525 /* Out of range start or start > end result in empty list */
4526 addReply(c
,shared
.emptymultibulk
);
4529 if (end
>= llen
) end
= llen
-1;
4530 rangelen
= (end
-start
)+1;
4532 /* Return the result in form of a multi-bulk reply */
4533 ln
= listIndex(list
, start
);
4534 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
4535 for (j
= 0; j
< rangelen
; j
++) {
4536 ele
= listNodeValue(ln
);
4537 addReplyBulk(c
,ele
);
4542 static void ltrimCommand(redisClient
*c
) {
4544 int start
= atoi(c
->argv
[2]->ptr
);
4545 int end
= atoi(c
->argv
[3]->ptr
);
4547 int j
, ltrim
, rtrim
;
4551 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.ok
)) == NULL
||
4552 checkType(c
,o
,REDIS_LIST
)) return;
4554 llen
= listLength(list
);
4556 /* convert negative indexes */
4557 if (start
< 0) start
= llen
+start
;
4558 if (end
< 0) end
= llen
+end
;
4559 if (start
< 0) start
= 0;
4560 if (end
< 0) end
= 0;
4562 /* indexes sanity checks */
4563 if (start
> end
|| start
>= llen
) {
4564 /* Out of range start or start > end result in empty list */
4568 if (end
>= llen
) end
= llen
-1;
4573 /* Remove list elements to perform the trim */
4574 for (j
= 0; j
< ltrim
; j
++) {
4575 ln
= listFirst(list
);
4576 listDelNode(list
,ln
);
4578 for (j
= 0; j
< rtrim
; j
++) {
4579 ln
= listLast(list
);
4580 listDelNode(list
,ln
);
4582 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4584 addReply(c
,shared
.ok
);
4587 static void lremCommand(redisClient
*c
) {
4590 listNode
*ln
, *next
;
4591 int toremove
= atoi(c
->argv
[2]->ptr
);
4595 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4596 checkType(c
,o
,REDIS_LIST
)) return;
4600 toremove
= -toremove
;
4603 ln
= fromtail
? list
->tail
: list
->head
;
4605 robj
*ele
= listNodeValue(ln
);
4607 next
= fromtail
? ln
->prev
: ln
->next
;
4608 if (compareStringObjects(ele
,c
->argv
[3]) == 0) {
4609 listDelNode(list
,ln
);
4612 if (toremove
&& removed
== toremove
) break;
4616 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4617 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
4620 /* This is the semantic of this command:
4621 * RPOPLPUSH srclist dstlist:
4622 * IF LLEN(srclist) > 0
4623 * element = RPOP srclist
4624 * LPUSH dstlist element
4631 * The idea is to be able to get an element from a list in a reliable way
4632 * since the element is not just returned but pushed against another list
4633 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4635 static void rpoplpushcommand(redisClient
*c
) {
4640 if ((sobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4641 checkType(c
,sobj
,REDIS_LIST
)) return;
4642 srclist
= sobj
->ptr
;
4643 ln
= listLast(srclist
);
4646 addReply(c
,shared
.nullbulk
);
4648 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4649 robj
*ele
= listNodeValue(ln
);
4652 if (dobj
&& dobj
->type
!= REDIS_LIST
) {
4653 addReply(c
,shared
.wrongtypeerr
);
4657 /* Add the element to the target list (unless it's directly
4658 * passed to some BLPOP-ing client */
4659 if (!handleClientsWaitingListPush(c
,c
->argv
[2],ele
)) {
4661 /* Create the list if the key does not exist */
4662 dobj
= createListObject();
4663 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
4664 incrRefCount(c
->argv
[2]);
4666 dstlist
= dobj
->ptr
;
4667 listAddNodeHead(dstlist
,ele
);
4671 /* Send the element to the client as reply as well */
4672 addReplyBulk(c
,ele
);
4674 /* Finally remove the element from the source list */
4675 listDelNode(srclist
,ln
);
4676 if (listLength(srclist
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4681 /* ==================================== Sets ================================ */
4683 static void saddCommand(redisClient
*c
) {
4686 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4688 set
= createSetObject();
4689 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
4690 incrRefCount(c
->argv
[1]);
4692 if (set
->type
!= REDIS_SET
) {
4693 addReply(c
,shared
.wrongtypeerr
);
4697 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
4698 incrRefCount(c
->argv
[2]);
4700 addReply(c
,shared
.cone
);
4702 addReply(c
,shared
.czero
);
4706 static void sremCommand(redisClient
*c
) {
4709 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4710 checkType(c
,set
,REDIS_SET
)) return;
4712 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
4714 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4715 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4716 addReply(c
,shared
.cone
);
4718 addReply(c
,shared
.czero
);
4722 static void smoveCommand(redisClient
*c
) {
4723 robj
*srcset
, *dstset
;
4725 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4726 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4728 /* If the source key does not exist return 0, if it's of the wrong type
4730 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
4731 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
4734 /* Error if the destination key is not a set as well */
4735 if (dstset
&& dstset
->type
!= REDIS_SET
) {
4736 addReply(c
,shared
.wrongtypeerr
);
4739 /* Remove the element from the source set */
4740 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
4741 /* Key not found in the src set! return zero */
4742 addReply(c
,shared
.czero
);
4745 if (dictSize((dict
*)srcset
->ptr
) == 0 && srcset
!= dstset
)
4746 deleteKey(c
->db
,c
->argv
[1]);
4748 /* Add the element to the destination set */
4750 dstset
= createSetObject();
4751 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
4752 incrRefCount(c
->argv
[2]);
4754 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
4755 incrRefCount(c
->argv
[3]);
4756 addReply(c
,shared
.cone
);
4759 static void sismemberCommand(redisClient
*c
) {
4762 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4763 checkType(c
,set
,REDIS_SET
)) return;
4765 if (dictFind(set
->ptr
,c
->argv
[2]))
4766 addReply(c
,shared
.cone
);
4768 addReply(c
,shared
.czero
);
4771 static void scardCommand(redisClient
*c
) {
4775 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4776 checkType(c
,o
,REDIS_SET
)) return;
4779 addReplyUlong(c
,dictSize(s
));
4782 static void spopCommand(redisClient
*c
) {
4786 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4787 checkType(c
,set
,REDIS_SET
)) return;
4789 de
= dictGetRandomKey(set
->ptr
);
4791 addReply(c
,shared
.nullbulk
);
4793 robj
*ele
= dictGetEntryKey(de
);
4795 addReplyBulk(c
,ele
);
4796 dictDelete(set
->ptr
,ele
);
4797 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4798 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4803 static void srandmemberCommand(redisClient
*c
) {
4807 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4808 checkType(c
,set
,REDIS_SET
)) return;
4810 de
= dictGetRandomKey(set
->ptr
);
4812 addReply(c
,shared
.nullbulk
);
4814 robj
*ele
= dictGetEntryKey(de
);
4816 addReplyBulk(c
,ele
);
4820 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
4821 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
4823 return dictSize(*d1
)-dictSize(*d2
);
4826 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
4827 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4830 robj
*lenobj
= NULL
, *dstset
= NULL
;
4831 unsigned long j
, cardinality
= 0;
4833 for (j
= 0; j
< setsnum
; j
++) {
4837 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4838 lookupKeyRead(c
->db
,setskeys
[j
]);
4842 if (deleteKey(c
->db
,dstkey
))
4844 addReply(c
,shared
.czero
);
4846 addReply(c
,shared
.nullmultibulk
);
4850 if (setobj
->type
!= REDIS_SET
) {
4852 addReply(c
,shared
.wrongtypeerr
);
4855 dv
[j
] = setobj
->ptr
;
4857 /* Sort sets from the smallest to largest, this will improve our
4858 * algorithm's performace */
4859 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
4861 /* The first thing we should output is the total number of elements...
4862 * since this is a multi-bulk write, but at this stage we don't know
4863 * the intersection set size, so we use a trick, append an empty object
4864 * to the output list and save the pointer to later modify it with the
4867 lenobj
= createObject(REDIS_STRING
,NULL
);
4869 decrRefCount(lenobj
);
4871 /* If we have a target key where to store the resulting set
4872 * create this key with an empty set inside */
4873 dstset
= createSetObject();
4876 /* Iterate all the elements of the first (smallest) set, and test
4877 * the element against all the other sets, if at least one set does
4878 * not include the element it is discarded */
4879 di
= dictGetIterator(dv
[0]);
4881 while((de
= dictNext(di
)) != NULL
) {
4884 for (j
= 1; j
< setsnum
; j
++)
4885 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
4887 continue; /* at least one set does not contain the member */
4888 ele
= dictGetEntryKey(de
);
4890 addReplyBulk(c
,ele
);
4893 dictAdd(dstset
->ptr
,ele
,NULL
);
4897 dictReleaseIterator(di
);
4900 /* Store the resulting set into the target, if the intersection
4901 * is not an empty set. */
4902 deleteKey(c
->db
,dstkey
);
4903 if (dictSize((dict
*)dstset
->ptr
) > 0) {
4904 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4905 incrRefCount(dstkey
);
4906 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
4908 decrRefCount(dstset
);
4909 addReply(c
,shared
.czero
);
4913 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
4918 static void sinterCommand(redisClient
*c
) {
4919 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
4922 static void sinterstoreCommand(redisClient
*c
) {
4923 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
4926 #define REDIS_OP_UNION 0
4927 #define REDIS_OP_DIFF 1
4928 #define REDIS_OP_INTER 2
4930 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
4931 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4934 robj
*dstset
= NULL
;
4935 int j
, cardinality
= 0;
4937 for (j
= 0; j
< setsnum
; j
++) {
4941 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4942 lookupKeyRead(c
->db
,setskeys
[j
]);
4947 if (setobj
->type
!= REDIS_SET
) {
4949 addReply(c
,shared
.wrongtypeerr
);
4952 dv
[j
] = setobj
->ptr
;
4955 /* We need a temp set object to store our union. If the dstkey
4956 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
4957 * this set object will be the resulting object to set into the target key*/
4958 dstset
= createSetObject();
4960 /* Iterate all the elements of all the sets, add every element a single
4961 * time to the result set */
4962 for (j
= 0; j
< setsnum
; j
++) {
4963 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
4964 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
4966 di
= dictGetIterator(dv
[j
]);
4968 while((de
= dictNext(di
)) != NULL
) {
4971 /* dictAdd will not add the same element multiple times */
4972 ele
= dictGetEntryKey(de
);
4973 if (op
== REDIS_OP_UNION
|| j
== 0) {
4974 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
4978 } else if (op
== REDIS_OP_DIFF
) {
4979 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
4984 dictReleaseIterator(di
);
4986 /* result set is empty? Exit asap. */
4987 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break;
4990 /* Output the content of the resulting set, if not in STORE mode */
4992 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
4993 di
= dictGetIterator(dstset
->ptr
);
4994 while((de
= dictNext(di
)) != NULL
) {
4997 ele
= dictGetEntryKey(de
);
4998 addReplyBulk(c
,ele
);
5000 dictReleaseIterator(di
);
5001 decrRefCount(dstset
);
5003 /* If we have a target key where to store the resulting set
5004 * create this key with the result set inside */
5005 deleteKey(c
->db
,dstkey
);
5006 if (dictSize((dict
*)dstset
->ptr
) > 0) {
5007 dictAdd(c
->db
->dict
,dstkey
,dstset
);
5008 incrRefCount(dstkey
);
5009 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
5011 decrRefCount(dstset
);
5012 addReply(c
,shared
.czero
);
5019 static void sunionCommand(redisClient
*c
) {
5020 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
5023 static void sunionstoreCommand(redisClient
*c
) {
5024 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
5027 static void sdiffCommand(redisClient
*c
) {
5028 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
5031 static void sdiffstoreCommand(redisClient
*c
) {
5032 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
5035 /* ==================================== ZSets =============================== */
5037 /* ZSETs are ordered sets using two data structures to hold the same elements
5038 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
5041 * The elements are added to an hash table mapping Redis objects to scores.
5042 * At the same time the elements are added to a skip list mapping scores
5043 * to Redis objects (so objects are sorted by scores in this "view"). */
5045 /* This skiplist implementation is almost a C translation of the original
5046 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
5047 * Alternative to Balanced Trees", modified in three ways:
5048 * a) this implementation allows for repeated values.
5049 * b) the comparison is not just by key (our 'score') but by satellite data.
5050 * c) there is a back pointer, so it's a doubly linked list with the back
5051 * pointers being only at "level 1". This allows to traverse the list
5052 * from tail to head, useful for ZREVRANGE. */
5054 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
5055 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
5057 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
5059 zn
->span
= zmalloc(sizeof(unsigned int) * (level
- 1));
5065 static zskiplist
*zslCreate(void) {
5069 zsl
= zmalloc(sizeof(*zsl
));
5072 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
5073 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++) {
5074 zsl
->header
->forward
[j
] = NULL
;
5076 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
5077 if (j
< ZSKIPLIST_MAXLEVEL
-1)
5078 zsl
->header
->span
[j
] = 0;
5080 zsl
->header
->backward
= NULL
;
5085 static void zslFreeNode(zskiplistNode
*node
) {
5086 decrRefCount(node
->obj
);
5087 zfree(node
->forward
);
5092 static void zslFree(zskiplist
*zsl
) {
5093 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
5095 zfree(zsl
->header
->forward
);
5096 zfree(zsl
->header
->span
);
5099 next
= node
->forward
[0];
5106 static int zslRandomLevel(void) {
5108 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
5110 return (level
<ZSKIPLIST_MAXLEVEL
) ? level
: ZSKIPLIST_MAXLEVEL
;
5113 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
5114 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5115 unsigned int rank
[ZSKIPLIST_MAXLEVEL
];
5119 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5120 /* store rank that is crossed to reach the insert position */
5121 rank
[i
] = i
== (zsl
->level
-1) ? 0 : rank
[i
+1];
5123 while (x
->forward
[i
] &&
5124 (x
->forward
[i
]->score
< score
||
5125 (x
->forward
[i
]->score
== score
&&
5126 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0))) {
5127 rank
[i
] += i
> 0 ? x
->span
[i
-1] : 1;
5132 /* we assume the key is not already inside, since we allow duplicated
5133 * scores, and the re-insertion of score and redis object should never
5134 * happpen since the caller of zslInsert() should test in the hash table
5135 * if the element is already inside or not. */
5136 level
= zslRandomLevel();
5137 if (level
> zsl
->level
) {
5138 for (i
= zsl
->level
; i
< level
; i
++) {
5140 update
[i
] = zsl
->header
;
5141 update
[i
]->span
[i
-1] = zsl
->length
;
5145 x
= zslCreateNode(level
,score
,obj
);
5146 for (i
= 0; i
< level
; i
++) {
5147 x
->forward
[i
] = update
[i
]->forward
[i
];
5148 update
[i
]->forward
[i
] = x
;
5150 /* update span covered by update[i] as x is inserted here */
5152 x
->span
[i
-1] = update
[i
]->span
[i
-1] - (rank
[0] - rank
[i
]);
5153 update
[i
]->span
[i
-1] = (rank
[0] - rank
[i
]) + 1;
5157 /* increment span for untouched levels */
5158 for (i
= level
; i
< zsl
->level
; i
++) {
5159 update
[i
]->span
[i
-1]++;
5162 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
5164 x
->forward
[0]->backward
= x
;
5170 /* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank */
5171 void zslDeleteNode(zskiplist
*zsl
, zskiplistNode
*x
, zskiplistNode
**update
) {
5173 for (i
= 0; i
< zsl
->level
; i
++) {
5174 if (update
[i
]->forward
[i
] == x
) {
5176 update
[i
]->span
[i
-1] += x
->span
[i
-1] - 1;
5178 update
[i
]->forward
[i
] = x
->forward
[i
];
5180 /* invariant: i > 0, because update[0]->forward[0]
5181 * is always equal to x */
5182 update
[i
]->span
[i
-1] -= 1;
5185 if (x
->forward
[0]) {
5186 x
->forward
[0]->backward
= x
->backward
;
5188 zsl
->tail
= x
->backward
;
5190 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
5195 /* Delete an element with matching score/object from the skiplist. */
5196 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
5197 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5201 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5202 while (x
->forward
[i
] &&
5203 (x
->forward
[i
]->score
< score
||
5204 (x
->forward
[i
]->score
== score
&&
5205 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
5209 /* We may have multiple elements with the same score, what we need
5210 * is to find the element with both the right score and object. */
5212 if (x
&& score
== x
->score
&& compareStringObjects(x
->obj
,obj
) == 0) {
5213 zslDeleteNode(zsl
, x
, update
);
5217 return 0; /* not found */
5219 return 0; /* not found */
5222 /* Delete all the elements with score between min and max from the skiplist.
5223 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
5224 * Note that this function takes the reference to the hash table view of the
5225 * sorted set, in order to remove the elements from the hash table too. */
5226 static unsigned long zslDeleteRangeByScore(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
5227 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5228 unsigned long removed
= 0;
5232 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5233 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
5237 /* We may have multiple elements with the same score, what we need
5238 * is to find the element with both the right score and object. */
5240 while (x
&& x
->score
<= max
) {
5241 zskiplistNode
*next
= x
->forward
[0];
5242 zslDeleteNode(zsl
, x
, update
);
5243 dictDelete(dict
,x
->obj
);
5248 return removed
; /* not found */
5251 /* Delete all the elements with rank between start and end from the skiplist.
5252 * Start and end are inclusive. Note that start and end need to be 1-based */
5253 static unsigned long zslDeleteRangeByRank(zskiplist
*zsl
, unsigned int start
, unsigned int end
, dict
*dict
) {
5254 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5255 unsigned long traversed
= 0, removed
= 0;
5259 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5260 while (x
->forward
[i
] && (traversed
+ (i
> 0 ? x
->span
[i
-1] : 1)) < start
) {
5261 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5269 while (x
&& traversed
<= end
) {
5270 zskiplistNode
*next
= x
->forward
[0];
5271 zslDeleteNode(zsl
, x
, update
);
5272 dictDelete(dict
,x
->obj
);
5281 /* Find the first node having a score equal or greater than the specified one.
5282 * Returns NULL if there is no match. */
5283 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
5288 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5289 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
5292 /* We may have multiple elements with the same score, what we need
5293 * is to find the element with both the right score and object. */
5294 return x
->forward
[0];
5297 /* Find the rank for an element by both score and key.
5298 * Returns 0 when the element cannot be found, rank otherwise.
5299 * Note that the rank is 1-based due to the span of zsl->header to the
5301 static unsigned long zslGetRank(zskiplist
*zsl
, double score
, robj
*o
) {
5303 unsigned long rank
= 0;
5307 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5308 while (x
->forward
[i
] &&
5309 (x
->forward
[i
]->score
< score
||
5310 (x
->forward
[i
]->score
== score
&&
5311 compareStringObjects(x
->forward
[i
]->obj
,o
) <= 0))) {
5312 rank
+= i
> 0 ? x
->span
[i
-1] : 1;
5316 /* x might be equal to zsl->header, so test if obj is non-NULL */
5317 if (x
->obj
&& compareStringObjects(x
->obj
,o
) == 0) {
5324 /* Finds an element by its rank. The rank argument needs to be 1-based. */
5325 zskiplistNode
* zslGetElementByRank(zskiplist
*zsl
, unsigned long rank
) {
5327 unsigned long traversed
= 0;
5331 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5332 while (x
->forward
[i
] && (traversed
+ (i
>0 ? x
->span
[i
-1] : 1)) <= rank
)
5334 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5337 if (traversed
== rank
) {
5344 /* The actual Z-commands implementations */
5346 /* This generic command implements both ZADD and ZINCRBY.
5347 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
5348 * the increment if the operation is a ZINCRBY (doincrement == 1). */
5349 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
5354 zsetobj
= lookupKeyWrite(c
->db
,key
);
5355 if (zsetobj
== NULL
) {
5356 zsetobj
= createZsetObject();
5357 dictAdd(c
->db
->dict
,key
,zsetobj
);
5360 if (zsetobj
->type
!= REDIS_ZSET
) {
5361 addReply(c
,shared
.wrongtypeerr
);
5367 /* Ok now since we implement both ZADD and ZINCRBY here the code
5368 * needs to handle the two different conditions. It's all about setting
5369 * '*score', that is, the new score to set, to the right value. */
5370 score
= zmalloc(sizeof(double));
5374 /* Read the old score. If the element was not present starts from 0 */
5375 de
= dictFind(zs
->dict
,ele
);
5377 double *oldscore
= dictGetEntryVal(de
);
5378 *score
= *oldscore
+ scoreval
;
5386 /* What follows is a simple remove and re-insert operation that is common
5387 * to both ZADD and ZINCRBY... */
5388 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
5389 /* case 1: New element */
5390 incrRefCount(ele
); /* added to hash */
5391 zslInsert(zs
->zsl
,*score
,ele
);
5392 incrRefCount(ele
); /* added to skiplist */
5395 addReplyDouble(c
,*score
);
5397 addReply(c
,shared
.cone
);
5402 /* case 2: Score update operation */
5403 de
= dictFind(zs
->dict
,ele
);
5404 redisAssert(de
!= NULL
);
5405 oldscore
= dictGetEntryVal(de
);
5406 if (*score
!= *oldscore
) {
5409 /* Remove and insert the element in the skip list with new score */
5410 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
5411 redisAssert(deleted
!= 0);
5412 zslInsert(zs
->zsl
,*score
,ele
);
5414 /* Update the score in the hash table */
5415 dictReplace(zs
->dict
,ele
,score
);
5421 addReplyDouble(c
,*score
);
5423 addReply(c
,shared
.czero
);
5427 static void zaddCommand(redisClient
*c
) {
5430 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
5431 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
5434 static void zincrbyCommand(redisClient
*c
) {
5437 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
5438 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
5441 static void zremCommand(redisClient
*c
) {
5448 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5449 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5452 de
= dictFind(zs
->dict
,c
->argv
[2]);
5454 addReply(c
,shared
.czero
);
5457 /* Delete from the skiplist */
5458 oldscore
= dictGetEntryVal(de
);
5459 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
5460 redisAssert(deleted
!= 0);
5462 /* Delete from the hash table */
5463 dictDelete(zs
->dict
,c
->argv
[2]);
5464 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5465 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5467 addReply(c
,shared
.cone
);
5470 static void zremrangebyscoreCommand(redisClient
*c
) {
5471 double min
= strtod(c
->argv
[2]->ptr
,NULL
);
5472 double max
= strtod(c
->argv
[3]->ptr
,NULL
);
5477 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5478 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5481 deleted
= zslDeleteRangeByScore(zs
->zsl
,min
,max
,zs
->dict
);
5482 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5483 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5484 server
.dirty
+= deleted
;
5485 addReplyLong(c
,deleted
);
5488 static void zremrangebyrankCommand(redisClient
*c
) {
5489 int start
= atoi(c
->argv
[2]->ptr
);
5490 int end
= atoi(c
->argv
[3]->ptr
);
5496 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5497 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5499 llen
= zs
->zsl
->length
;
5501 /* convert negative indexes */
5502 if (start
< 0) start
= llen
+start
;
5503 if (end
< 0) end
= llen
+end
;
5504 if (start
< 0) start
= 0;
5505 if (end
< 0) end
= 0;
5507 /* indexes sanity checks */
5508 if (start
> end
|| start
>= llen
) {
5509 addReply(c
,shared
.czero
);
5512 if (end
>= llen
) end
= llen
-1;
5514 /* increment start and end because zsl*Rank functions
5515 * use 1-based rank */
5516 deleted
= zslDeleteRangeByRank(zs
->zsl
,start
+1,end
+1,zs
->dict
);
5517 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5518 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5519 server
.dirty
+= deleted
;
5520 addReplyLong(c
, deleted
);
5528 static int qsortCompareZsetopsrcByCardinality(const void *s1
, const void *s2
) {
5529 zsetopsrc
*d1
= (void*) s1
, *d2
= (void*) s2
;
5530 unsigned long size1
, size2
;
5531 size1
= d1
->dict
? dictSize(d1
->dict
) : 0;
5532 size2
= d2
->dict
? dictSize(d2
->dict
) : 0;
5533 return size1
- size2
;
5536 #define REDIS_AGGR_SUM 1
5537 #define REDIS_AGGR_MIN 2
5538 #define REDIS_AGGR_MAX 3
5540 inline static void zunionInterAggregate(double *target
, double val
, int aggregate
) {
5541 if (aggregate
== REDIS_AGGR_SUM
) {
5542 *target
= *target
+ val
;
5543 } else if (aggregate
== REDIS_AGGR_MIN
) {
5544 *target
= val
< *target
? val
: *target
;
5545 } else if (aggregate
== REDIS_AGGR_MAX
) {
5546 *target
= val
> *target
? val
: *target
;
5549 redisAssert(0 != 0);
5553 static void zunionInterGenericCommand(redisClient
*c
, robj
*dstkey
, int op
) {
5555 int aggregate
= REDIS_AGGR_SUM
;
5562 /* expect zsetnum input keys to be given */
5563 zsetnum
= atoi(c
->argv
[2]->ptr
);
5565 addReplySds(c
,sdsnew("-ERR at least 1 input key is needed for ZUNION/ZINTER\r\n"));
5569 /* test if the expected number of keys would overflow */
5570 if (3+zsetnum
> c
->argc
) {
5571 addReply(c
,shared
.syntaxerr
);
5575 /* read keys to be used for input */
5576 src
= zmalloc(sizeof(zsetopsrc
) * zsetnum
);
5577 for (i
= 0, j
= 3; i
< zsetnum
; i
++, j
++) {
5578 robj
*zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
5582 if (zsetobj
->type
!= REDIS_ZSET
) {
5584 addReply(c
,shared
.wrongtypeerr
);
5587 src
[i
].dict
= ((zset
*)zsetobj
->ptr
)->dict
;
5590 /* default all weights to 1 */
5591 src
[i
].weight
= 1.0;
5594 /* parse optional extra arguments */
5596 int remaining
= c
->argc
- j
;
5599 if (remaining
>= (zsetnum
+ 1) && !strcasecmp(c
->argv
[j
]->ptr
,"weights")) {
5601 for (i
= 0; i
< zsetnum
; i
++, j
++, remaining
--) {
5602 src
[i
].weight
= strtod(c
->argv
[j
]->ptr
, NULL
);
5604 } else if (remaining
>= 2 && !strcasecmp(c
->argv
[j
]->ptr
,"aggregate")) {
5606 if (!strcasecmp(c
->argv
[j
]->ptr
,"sum")) {
5607 aggregate
= REDIS_AGGR_SUM
;
5608 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"min")) {
5609 aggregate
= REDIS_AGGR_MIN
;
5610 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"max")) {
5611 aggregate
= REDIS_AGGR_MAX
;
5614 addReply(c
,shared
.syntaxerr
);
5620 addReply(c
,shared
.syntaxerr
);
5626 /* sort sets from the smallest to largest, this will improve our
5627 * algorithm's performance */
5628 qsort(src
,zsetnum
,sizeof(zsetopsrc
), qsortCompareZsetopsrcByCardinality
);
5630 dstobj
= createZsetObject();
5631 dstzset
= dstobj
->ptr
;
5633 if (op
== REDIS_OP_INTER
) {
5634 /* skip going over all entries if the smallest zset is NULL or empty */
5635 if (src
[0].dict
&& dictSize(src
[0].dict
) > 0) {
5636 /* precondition: as src[0].dict is non-empty and the zsets are ordered
5637 * from small to large, all src[i > 0].dict are non-empty too */
5638 di
= dictGetIterator(src
[0].dict
);
5639 while((de
= dictNext(di
)) != NULL
) {
5640 double *score
= zmalloc(sizeof(double)), value
;
5641 *score
= src
[0].weight
* (*(double*)dictGetEntryVal(de
));
5643 for (j
= 1; j
< zsetnum
; j
++) {
5644 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5646 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5647 zunionInterAggregate(score
, value
, aggregate
);
5653 /* skip entry when not present in every source dict */
5657 robj
*o
= dictGetEntryKey(de
);
5658 dictAdd(dstzset
->dict
,o
,score
);
5659 incrRefCount(o
); /* added to dictionary */
5660 zslInsert(dstzset
->zsl
,*score
,o
);
5661 incrRefCount(o
); /* added to skiplist */
5664 dictReleaseIterator(di
);
5666 } else if (op
== REDIS_OP_UNION
) {
5667 for (i
= 0; i
< zsetnum
; i
++) {
5668 if (!src
[i
].dict
) continue;
5670 di
= dictGetIterator(src
[i
].dict
);
5671 while((de
= dictNext(di
)) != NULL
) {
5672 /* skip key when already processed */
5673 if (dictFind(dstzset
->dict
,dictGetEntryKey(de
)) != NULL
) continue;
5675 double *score
= zmalloc(sizeof(double)), value
;
5676 *score
= src
[i
].weight
* (*(double*)dictGetEntryVal(de
));
5678 /* because the zsets are sorted by size, its only possible
5679 * for sets at larger indices to hold this entry */
5680 for (j
= (i
+1); j
< zsetnum
; j
++) {
5681 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5683 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5684 zunionInterAggregate(score
, value
, aggregate
);
5688 robj
*o
= dictGetEntryKey(de
);
5689 dictAdd(dstzset
->dict
,o
,score
);
5690 incrRefCount(o
); /* added to dictionary */
5691 zslInsert(dstzset
->zsl
,*score
,o
);
5692 incrRefCount(o
); /* added to skiplist */
5694 dictReleaseIterator(di
);
5697 /* unknown operator */
5698 redisAssert(op
== REDIS_OP_INTER
|| op
== REDIS_OP_UNION
);
5701 deleteKey(c
->db
,dstkey
);
5702 if (dstzset
->zsl
->length
) {
5703 dictAdd(c
->db
->dict
,dstkey
,dstobj
);
5704 incrRefCount(dstkey
);
5705 addReplyLong(c
, dstzset
->zsl
->length
);
5708 decrRefCount(dstobj
);
5709 addReply(c
, shared
.czero
);
5714 static void zunionCommand(redisClient
*c
) {
5715 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_UNION
);
5718 static void zinterCommand(redisClient
*c
) {
5719 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_INTER
);
5722 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
5724 int start
= atoi(c
->argv
[2]->ptr
);
5725 int end
= atoi(c
->argv
[3]->ptr
);
5734 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
5736 } else if (c
->argc
>= 5) {
5737 addReply(c
,shared
.syntaxerr
);
5741 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullmultibulk
)) == NULL
||
5742 checkType(c
,o
,REDIS_ZSET
)) return;
5747 /* convert negative indexes */
5748 if (start
< 0) start
= llen
+start
;
5749 if (end
< 0) end
= llen
+end
;
5750 if (start
< 0) start
= 0;
5751 if (end
< 0) end
= 0;
5753 /* indexes sanity checks */
5754 if (start
> end
|| start
>= llen
) {
5755 /* Out of range start or start > end result in empty list */
5756 addReply(c
,shared
.emptymultibulk
);
5759 if (end
>= llen
) end
= llen
-1;
5760 rangelen
= (end
-start
)+1;
5762 /* check if starting point is trivial, before searching
5763 * the element in log(N) time */
5765 ln
= start
== 0 ? zsl
->tail
: zslGetElementByRank(zsl
, llen
-start
);
5768 zsl
->header
->forward
[0] : zslGetElementByRank(zsl
, start
+1);
5771 /* Return the result in form of a multi-bulk reply */
5772 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
5773 withscores
? (rangelen
*2) : rangelen
));
5774 for (j
= 0; j
< rangelen
; j
++) {
5776 addReplyBulk(c
,ele
);
5778 addReplyDouble(c
,ln
->score
);
5779 ln
= reverse
? ln
->backward
: ln
->forward
[0];
5783 static void zrangeCommand(redisClient
*c
) {
5784 zrangeGenericCommand(c
,0);
5787 static void zrevrangeCommand(redisClient
*c
) {
5788 zrangeGenericCommand(c
,1);
5791 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
5792 * If justcount is non-zero, just the count is returned. */
5793 static void genericZrangebyscoreCommand(redisClient
*c
, int justcount
) {
5796 int minex
= 0, maxex
= 0; /* are min or max exclusive? */
5797 int offset
= 0, limit
= -1;
5801 /* Parse the min-max interval. If one of the values is prefixed
5802 * by the "(" character, it's considered "open". For instance
5803 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
5804 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
5805 if (((char*)c
->argv
[2]->ptr
)[0] == '(') {
5806 min
= strtod((char*)c
->argv
[2]->ptr
+1,NULL
);
5809 min
= strtod(c
->argv
[2]->ptr
,NULL
);
5811 if (((char*)c
->argv
[3]->ptr
)[0] == '(') {
5812 max
= strtod((char*)c
->argv
[3]->ptr
+1,NULL
);
5815 max
= strtod(c
->argv
[3]->ptr
,NULL
);
5818 /* Parse "WITHSCORES": note that if the command was called with
5819 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
5820 * enter the following paths to parse WITHSCORES and LIMIT. */
5821 if (c
->argc
== 5 || c
->argc
== 8) {
5822 if (strcasecmp(c
->argv
[c
->argc
-1]->ptr
,"withscores") == 0)
5827 if (c
->argc
!= (4 + withscores
) && c
->argc
!= (7 + withscores
))
5831 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
5836 if (c
->argc
== (7 + withscores
) && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
5837 addReply(c
,shared
.syntaxerr
);
5839 } else if (c
->argc
== (7 + withscores
)) {
5840 offset
= atoi(c
->argv
[5]->ptr
);
5841 limit
= atoi(c
->argv
[6]->ptr
);
5842 if (offset
< 0) offset
= 0;
5845 /* Ok, lookup the key and get the range */
5846 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5848 addReply(c
,justcount
? shared
.czero
: shared
.nullmultibulk
);
5850 if (o
->type
!= REDIS_ZSET
) {
5851 addReply(c
,shared
.wrongtypeerr
);
5853 zset
*zsetobj
= o
->ptr
;
5854 zskiplist
*zsl
= zsetobj
->zsl
;
5856 robj
*ele
, *lenobj
= NULL
;
5857 unsigned long rangelen
= 0;
5859 /* Get the first node with the score >= min, or with
5860 * score > min if 'minex' is true. */
5861 ln
= zslFirstWithScore(zsl
,min
);
5862 while (minex
&& ln
&& ln
->score
== min
) ln
= ln
->forward
[0];
5865 /* No element matching the speciifed interval */
5866 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
5870 /* We don't know in advance how many matching elements there
5871 * are in the list, so we push this object that will represent
5872 * the multi-bulk length in the output buffer, and will "fix"
5875 lenobj
= createObject(REDIS_STRING
,NULL
);
5877 decrRefCount(lenobj
);
5880 while(ln
&& (maxex
? (ln
->score
< max
) : (ln
->score
<= max
))) {
5883 ln
= ln
->forward
[0];
5886 if (limit
== 0) break;
5889 addReplyBulk(c
,ele
);
5891 addReplyDouble(c
,ln
->score
);
5893 ln
= ln
->forward
[0];
5895 if (limit
> 0) limit
--;
5898 addReplyLong(c
,(long)rangelen
);
5900 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",
5901 withscores
? (rangelen
*2) : rangelen
);
5907 static void zrangebyscoreCommand(redisClient
*c
) {
5908 genericZrangebyscoreCommand(c
,0);
5911 static void zcountCommand(redisClient
*c
) {
5912 genericZrangebyscoreCommand(c
,1);
5915 static void zcardCommand(redisClient
*c
) {
5919 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5920 checkType(c
,o
,REDIS_ZSET
)) return;
5923 addReplyUlong(c
,zs
->zsl
->length
);
5926 static void zscoreCommand(redisClient
*c
) {
5931 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5932 checkType(c
,o
,REDIS_ZSET
)) return;
5935 de
= dictFind(zs
->dict
,c
->argv
[2]);
5937 addReply(c
,shared
.nullbulk
);
5939 double *score
= dictGetEntryVal(de
);
5941 addReplyDouble(c
,*score
);
5945 static void zrankGenericCommand(redisClient
*c
, int reverse
) {
5953 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5954 checkType(c
,o
,REDIS_ZSET
)) return;
5958 de
= dictFind(zs
->dict
,c
->argv
[2]);
5960 addReply(c
,shared
.nullbulk
);
5964 score
= dictGetEntryVal(de
);
5965 rank
= zslGetRank(zsl
, *score
, c
->argv
[2]);
5968 addReplyLong(c
, zsl
->length
- rank
);
5970 addReplyLong(c
, rank
-1);
5973 addReply(c
,shared
.nullbulk
);
5977 static void zrankCommand(redisClient
*c
) {
5978 zrankGenericCommand(c
, 0);
5981 static void zrevrankCommand(redisClient
*c
) {
5982 zrankGenericCommand(c
, 1);
5985 /* =================================== Hashes =============================== */
5986 static void hsetCommand(redisClient
*c
) {
5988 robj
*o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5991 o
= createHashObject();
5992 dictAdd(c
->db
->dict
,c
->argv
[1],o
);
5993 incrRefCount(c
->argv
[1]);
5995 if (o
->type
!= REDIS_HASH
) {
5996 addReply(c
,shared
.wrongtypeerr
);
6000 /* We want to convert the zipmap into an hash table right now if the
6001 * entry to be added is too big. Note that we check if the object
6002 * is integer encoded before to try fetching the length in the test below.
6003 * This is because integers are small, but currently stringObjectLen()
6004 * performs a slow conversion: not worth it. */
6005 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
&&
6006 ((c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
&&
6007 sdslen(c
->argv
[2]->ptr
) > server
.hash_max_zipmap_value
) ||
6008 (c
->argv
[3]->encoding
== REDIS_ENCODING_RAW
&&
6009 sdslen(c
->argv
[3]->ptr
) > server
.hash_max_zipmap_value
)))
6011 convertToRealHash(o
);
6014 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6015 unsigned char *zm
= o
->ptr
;
6016 robj
*valobj
= getDecodedObject(c
->argv
[3]);
6018 zm
= zipmapSet(zm
,c
->argv
[2]->ptr
,sdslen(c
->argv
[2]->ptr
),
6019 valobj
->ptr
,sdslen(valobj
->ptr
),&update
);
6020 decrRefCount(valobj
);
6023 /* And here there is the second check for hash conversion. */
6024 if (zipmapLen(zm
) > server
.hash_max_zipmap_entries
)
6025 convertToRealHash(o
);
6027 tryObjectEncoding(c
->argv
[2]);
6028 /* note that c->argv[3] is already encoded, as the latest arg
6029 * of a bulk command is always integer encoded if possible. */
6030 if (dictReplace(o
->ptr
,c
->argv
[2],c
->argv
[3])) {
6031 incrRefCount(c
->argv
[2]);
6035 incrRefCount(c
->argv
[3]);
6038 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",update
== 0));
6041 static void hincrbyCommand(redisClient
*c
) {
6042 long long value
= 0, incr
= 0;
6043 robj
*o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
6046 o
= createHashObject();
6047 dictAdd(c
->db
->dict
,c
->argv
[1],o
);
6048 incrRefCount(c
->argv
[1]);
6050 if (o
->type
!= REDIS_HASH
) {
6051 addReply(c
,shared
.wrongtypeerr
);
6056 incr
= strtoll(c
->argv
[3]->ptr
, NULL
, 10);
6057 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6058 unsigned char *zm
= o
->ptr
;
6059 unsigned char *zval
;
6062 /* Find value if already present in hash */
6063 if (zipmapGet(zm
,c
->argv
[2]->ptr
,sdslen(c
->argv
[2]->ptr
),
6065 /* strtoll needs the char* to have a trailing \0, but
6066 * the zipmap doesn't include them. */
6067 sds szval
= sdsnewlen(zval
, zvlen
);
6068 value
= strtoll(szval
,NULL
,10);
6073 sds svalue
= sdscatprintf(sdsempty(),"%lld",value
);
6074 zm
= zipmapSet(zm
,c
->argv
[2]->ptr
,sdslen(c
->argv
[2]->ptr
),
6075 (unsigned char*)svalue
,sdslen(svalue
),NULL
);
6079 /* Check if the zipmap needs to be converted. */
6080 if (zipmapLen(zm
) > server
.hash_max_zipmap_entries
)
6081 convertToRealHash(o
);
6086 /* Find value if already present in hash */
6087 de
= dictFind(o
->ptr
,c
->argv
[2]);
6089 hval
= dictGetEntryVal(de
);
6090 if (hval
->encoding
== REDIS_ENCODING_RAW
)
6091 value
= strtoll(hval
->ptr
,NULL
,10);
6092 else if (hval
->encoding
== REDIS_ENCODING_INT
)
6093 value
= (long)hval
->ptr
;
6095 redisAssert(1 != 1);
6099 hval
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
6100 tryObjectEncoding(hval
);
6101 if (dictReplace(o
->ptr
,c
->argv
[2],hval
)) {
6102 incrRefCount(c
->argv
[2]);
6107 addReplyLongLong(c
, value
);
6110 static void hgetCommand(redisClient
*c
) {
6113 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6114 checkType(c
,o
,REDIS_HASH
)) return;
6116 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6117 unsigned char *zm
= o
->ptr
;
6122 field
= getDecodedObject(c
->argv
[2]);
6123 if (zipmapGet(zm
,field
->ptr
,sdslen(field
->ptr
), &val
,&vlen
)) {
6124 addReplySds(c
,sdscatprintf(sdsempty(),"$%u\r\n", vlen
));
6125 addReplySds(c
,sdsnewlen(val
,vlen
));
6126 addReply(c
,shared
.crlf
);
6127 decrRefCount(field
);
6130 addReply(c
,shared
.nullbulk
);
6131 decrRefCount(field
);
6135 struct dictEntry
*de
;
6137 de
= dictFind(o
->ptr
,c
->argv
[2]);
6139 addReply(c
,shared
.nullbulk
);
6141 robj
*e
= dictGetEntryVal(de
);
6148 static void hdelCommand(redisClient
*c
) {
6152 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6153 checkType(c
,o
,REDIS_HASH
)) return;
6155 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6156 robj
*field
= getDecodedObject(c
->argv
[2]);
6158 o
->ptr
= zipmapDel((unsigned char*) o
->ptr
,
6159 (unsigned char*) field
->ptr
,
6160 sdslen(field
->ptr
), &deleted
);
6161 decrRefCount(field
);
6162 if (zipmapLen((unsigned char*) o
->ptr
) == 0)
6163 deleteKey(c
->db
,c
->argv
[1]);
6165 deleted
= dictDelete((dict
*)o
->ptr
,c
->argv
[2]) == DICT_OK
;
6166 if (htNeedsResize(o
->ptr
)) dictResize(o
->ptr
);
6167 if (dictSize((dict
*)o
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
6169 if (deleted
) server
.dirty
++;
6170 addReply(c
,deleted
? shared
.cone
: shared
.czero
);
6173 static void hlenCommand(redisClient
*c
) {
6177 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6178 checkType(c
,o
,REDIS_HASH
)) return;
6180 len
= (o
->encoding
== REDIS_ENCODING_ZIPMAP
) ?
6181 zipmapLen((unsigned char*)o
->ptr
) : dictSize((dict
*)o
->ptr
);
6182 addReplyUlong(c
,len
);
6185 #define REDIS_GETALL_KEYS 1
6186 #define REDIS_GETALL_VALS 2
6187 static void genericHgetallCommand(redisClient
*c
, int flags
) {
6189 unsigned long count
= 0;
6191 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullmultibulk
)) == NULL
6192 || checkType(c
,o
,REDIS_HASH
)) return;
6194 lenobj
= createObject(REDIS_STRING
,NULL
);
6196 decrRefCount(lenobj
);
6198 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6199 unsigned char *p
= zipmapRewind(o
->ptr
);
6200 unsigned char *field
, *val
;
6201 unsigned int flen
, vlen
;
6203 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
6206 if (flags
& REDIS_GETALL_KEYS
) {
6207 aux
= createStringObject((char*)field
,flen
);
6208 addReplyBulk(c
,aux
);
6212 if (flags
& REDIS_GETALL_VALS
) {
6213 aux
= createStringObject((char*)val
,vlen
);
6214 addReplyBulk(c
,aux
);
6220 dictIterator
*di
= dictGetIterator(o
->ptr
);
6223 while((de
= dictNext(di
)) != NULL
) {
6224 robj
*fieldobj
= dictGetEntryKey(de
);
6225 robj
*valobj
= dictGetEntryVal(de
);
6227 if (flags
& REDIS_GETALL_KEYS
) {
6228 addReplyBulk(c
,fieldobj
);
6231 if (flags
& REDIS_GETALL_VALS
) {
6232 addReplyBulk(c
,valobj
);
6236 dictReleaseIterator(di
);
6238 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",count
);
6241 static void hkeysCommand(redisClient
*c
) {
6242 genericHgetallCommand(c
,REDIS_GETALL_KEYS
);
6245 static void hvalsCommand(redisClient
*c
) {
6246 genericHgetallCommand(c
,REDIS_GETALL_VALS
);
6249 static void hgetallCommand(redisClient
*c
) {
6250 genericHgetallCommand(c
,REDIS_GETALL_KEYS
|REDIS_GETALL_VALS
);
6253 static void hexistsCommand(redisClient
*c
) {
6257 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6258 checkType(c
,o
,REDIS_HASH
)) return;
6260 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6262 unsigned char *zm
= o
->ptr
;
6264 field
= getDecodedObject(c
->argv
[2]);
6265 exists
= zipmapExists(zm
,field
->ptr
,sdslen(field
->ptr
));
6266 decrRefCount(field
);
6268 exists
= dictFind(o
->ptr
,c
->argv
[2]) != NULL
;
6270 addReply(c
,exists
? shared
.cone
: shared
.czero
);
6273 static void convertToRealHash(robj
*o
) {
6274 unsigned char *key
, *val
, *p
, *zm
= o
->ptr
;
6275 unsigned int klen
, vlen
;
6276 dict
*dict
= dictCreate(&hashDictType
,NULL
);
6278 assert(o
->type
== REDIS_HASH
&& o
->encoding
!= REDIS_ENCODING_HT
);
6279 p
= zipmapRewind(zm
);
6280 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
6281 robj
*keyobj
, *valobj
;
6283 keyobj
= createStringObject((char*)key
,klen
);
6284 valobj
= createStringObject((char*)val
,vlen
);
6285 tryObjectEncoding(keyobj
);
6286 tryObjectEncoding(valobj
);
6287 dictAdd(dict
,keyobj
,valobj
);
6289 o
->encoding
= REDIS_ENCODING_HT
;
6294 /* ========================= Non type-specific commands ==================== */
6296 static void flushdbCommand(redisClient
*c
) {
6297 server
.dirty
+= dictSize(c
->db
->dict
);
6298 dictEmpty(c
->db
->dict
);
6299 dictEmpty(c
->db
->expires
);
6300 addReply(c
,shared
.ok
);
6303 static void flushallCommand(redisClient
*c
) {
6304 server
.dirty
+= emptyDb();
6305 addReply(c
,shared
.ok
);
6306 if (server
.bgsavechildpid
!= -1) {
6307 kill(server
.bgsavechildpid
,SIGKILL
);
6308 rdbRemoveTempFile(server
.bgsavechildpid
);
6310 rdbSave(server
.dbfilename
);
6314 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
6315 redisSortOperation
*so
= zmalloc(sizeof(*so
));
6317 so
->pattern
= pattern
;
6321 /* Return the value associated to the key with a name obtained
6322 * substituting the first occurence of '*' in 'pattern' with 'subst' */
6323 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
6327 int prefixlen
, sublen
, postfixlen
;
6328 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
6332 char buf
[REDIS_SORTKEY_MAX
+1];
6335 /* If the pattern is "#" return the substitution object itself in order
6336 * to implement the "SORT ... GET #" feature. */
6337 spat
= pattern
->ptr
;
6338 if (spat
[0] == '#' && spat
[1] == '\0') {
6342 /* The substitution object may be specially encoded. If so we create
6343 * a decoded object on the fly. Otherwise getDecodedObject will just
6344 * increment the ref count, that we'll decrement later. */
6345 subst
= getDecodedObject(subst
);
6348 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
6349 p
= strchr(spat
,'*');
6351 decrRefCount(subst
);
6356 sublen
= sdslen(ssub
);
6357 postfixlen
= sdslen(spat
)-(prefixlen
+1);
6358 memcpy(keyname
.buf
,spat
,prefixlen
);
6359 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
6360 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
6361 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
6362 keyname
.len
= prefixlen
+sublen
+postfixlen
;
6364 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2))
6365 decrRefCount(subst
);
6367 /* printf("lookup '%s' => %p\n", keyname.buf,de); */
6368 return lookupKeyRead(db
,&keyobj
);
6371 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
6372 * the additional parameter is not standard but a BSD-specific we have to
6373 * pass sorting parameters via the global 'server' structure */
6374 static int sortCompare(const void *s1
, const void *s2
) {
6375 const redisSortObject
*so1
= s1
, *so2
= s2
;
6378 if (!server
.sort_alpha
) {
6379 /* Numeric sorting. Here it's trivial as we precomputed scores */
6380 if (so1
->u
.score
> so2
->u
.score
) {
6382 } else if (so1
->u
.score
< so2
->u
.score
) {
6388 /* Alphanumeric sorting */
6389 if (server
.sort_bypattern
) {
6390 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
6391 /* At least one compare object is NULL */
6392 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
6394 else if (so1
->u
.cmpobj
== NULL
)
6399 /* We have both the objects, use strcoll */
6400 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
6403 /* Compare elements directly */
6406 dec1
= getDecodedObject(so1
->obj
);
6407 dec2
= getDecodedObject(so2
->obj
);
6408 cmp
= strcoll(dec1
->ptr
,dec2
->ptr
);
6413 return server
.sort_desc
? -cmp
: cmp
;
6416 /* The SORT command is the most complex command in Redis. Warning: this code
6417 * is optimized for speed and a bit less for readability */
6418 static void sortCommand(redisClient
*c
) {
6421 int desc
= 0, alpha
= 0;
6422 int limit_start
= 0, limit_count
= -1, start
, end
;
6423 int j
, dontsort
= 0, vectorlen
;
6424 int getop
= 0; /* GET operation counter */
6425 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
6426 redisSortObject
*vector
; /* Resulting vector to sort */
6428 /* Lookup the key to sort. It must be of the right types */
6429 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
6430 if (sortval
== NULL
) {
6431 addReply(c
,shared
.nullmultibulk
);
6434 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
6435 sortval
->type
!= REDIS_ZSET
)
6437 addReply(c
,shared
.wrongtypeerr
);
6441 /* Create a list of operations to perform for every sorted element.
6442 * Operations can be GET/DEL/INCR/DECR */
6443 operations
= listCreate();
6444 listSetFreeMethod(operations
,zfree
);
6447 /* Now we need to protect sortval incrementing its count, in the future
6448 * SORT may have options able to overwrite/delete keys during the sorting
6449 * and the sorted key itself may get destroied */
6450 incrRefCount(sortval
);
6452 /* The SORT command has an SQL-alike syntax, parse it */
6453 while(j
< c
->argc
) {
6454 int leftargs
= c
->argc
-j
-1;
6455 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
6457 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
6459 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
6461 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
6462 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
6463 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
6465 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
6466 storekey
= c
->argv
[j
+1];
6468 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
6469 sortby
= c
->argv
[j
+1];
6470 /* If the BY pattern does not contain '*', i.e. it is constant,
6471 * we don't need to sort nor to lookup the weight keys. */
6472 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
6474 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
6475 listAddNodeTail(operations
,createSortOperation(
6476 REDIS_SORT_GET
,c
->argv
[j
+1]));
6480 decrRefCount(sortval
);
6481 listRelease(operations
);
6482 addReply(c
,shared
.syntaxerr
);
6488 /* Load the sorting vector with all the objects to sort */
6489 switch(sortval
->type
) {
6490 case REDIS_LIST
: vectorlen
= listLength((list
*)sortval
->ptr
); break;
6491 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
6492 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
6493 default: vectorlen
= 0; redisAssert(0); /* Avoid GCC warning */
6495 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
6498 if (sortval
->type
== REDIS_LIST
) {
6499 list
*list
= sortval
->ptr
;
6503 listRewind(list
,&li
);
6504 while((ln
= listNext(&li
))) {
6505 robj
*ele
= ln
->value
;
6506 vector
[j
].obj
= ele
;
6507 vector
[j
].u
.score
= 0;
6508 vector
[j
].u
.cmpobj
= NULL
;
6516 if (sortval
->type
== REDIS_SET
) {
6519 zset
*zs
= sortval
->ptr
;
6523 di
= dictGetIterator(set
);
6524 while((setele
= dictNext(di
)) != NULL
) {
6525 vector
[j
].obj
= dictGetEntryKey(setele
);
6526 vector
[j
].u
.score
= 0;
6527 vector
[j
].u
.cmpobj
= NULL
;
6530 dictReleaseIterator(di
);
6532 redisAssert(j
== vectorlen
);
6534 /* Now it's time to load the right scores in the sorting vector */
6535 if (dontsort
== 0) {
6536 for (j
= 0; j
< vectorlen
; j
++) {
6540 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
6541 if (!byval
|| byval
->type
!= REDIS_STRING
) continue;
6543 vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
6545 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
6546 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
6548 /* Don't need to decode the object if it's
6549 * integer-encoded (the only encoding supported) so
6550 * far. We can just cast it */
6551 if (byval
->encoding
== REDIS_ENCODING_INT
) {
6552 vector
[j
].u
.score
= (long)byval
->ptr
;
6554 redisAssert(1 != 1);
6559 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_RAW
)
6560 vector
[j
].u
.score
= strtod(vector
[j
].obj
->ptr
,NULL
);
6562 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_INT
)
6563 vector
[j
].u
.score
= (long) vector
[j
].obj
->ptr
;
6565 redisAssert(1 != 1);
6572 /* We are ready to sort the vector... perform a bit of sanity check
6573 * on the LIMIT option too. We'll use a partial version of quicksort. */
6574 start
= (limit_start
< 0) ? 0 : limit_start
;
6575 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
6576 if (start
>= vectorlen
) {
6577 start
= vectorlen
-1;
6580 if (end
>= vectorlen
) end
= vectorlen
-1;
6582 if (dontsort
== 0) {
6583 server
.sort_desc
= desc
;
6584 server
.sort_alpha
= alpha
;
6585 server
.sort_bypattern
= sortby
? 1 : 0;
6586 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
6587 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
6589 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
6592 /* Send command output to the output buffer, performing the specified
6593 * GET/DEL/INCR/DECR operations if any. */
6594 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
6595 if (storekey
== NULL
) {
6596 /* STORE option not specified, sent the sorting result to client */
6597 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
6598 for (j
= start
; j
<= end
; j
++) {
6602 if (!getop
) addReplyBulk(c
,vector
[j
].obj
);
6603 listRewind(operations
,&li
);
6604 while((ln
= listNext(&li
))) {
6605 redisSortOperation
*sop
= ln
->value
;
6606 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
6609 if (sop
->type
== REDIS_SORT_GET
) {
6610 if (!val
|| val
->type
!= REDIS_STRING
) {
6611 addReply(c
,shared
.nullbulk
);
6613 addReplyBulk(c
,val
);
6616 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
6621 robj
*listObject
= createListObject();
6622 list
*listPtr
= (list
*) listObject
->ptr
;
6624 /* STORE option specified, set the sorting result as a List object */
6625 for (j
= start
; j
<= end
; j
++) {
6630 listAddNodeTail(listPtr
,vector
[j
].obj
);
6631 incrRefCount(vector
[j
].obj
);
6633 listRewind(operations
,&li
);
6634 while((ln
= listNext(&li
))) {
6635 redisSortOperation
*sop
= ln
->value
;
6636 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
6639 if (sop
->type
== REDIS_SORT_GET
) {
6640 if (!val
|| val
->type
!= REDIS_STRING
) {
6641 listAddNodeTail(listPtr
,createStringObject("",0));
6643 listAddNodeTail(listPtr
,val
);
6647 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
6651 if (dictReplace(c
->db
->dict
,storekey
,listObject
)) {
6652 incrRefCount(storekey
);
6654 /* Note: we add 1 because the DB is dirty anyway since even if the
6655 * SORT result is empty a new key is set and maybe the old content
6657 server
.dirty
+= 1+outputlen
;
6658 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
6662 decrRefCount(sortval
);
6663 listRelease(operations
);
6664 for (j
= 0; j
< vectorlen
; j
++) {
6665 if (sortby
&& alpha
&& vector
[j
].u
.cmpobj
)
6666 decrRefCount(vector
[j
].u
.cmpobj
);
6671 /* Convert an amount of bytes into a human readable string in the form
6672 * of 100B, 2G, 100M, 4K, and so forth. */
6673 static void bytesToHuman(char *s
, unsigned long long n
) {
6678 sprintf(s
,"%lluB",n
);
6680 } else if (n
< (1024*1024)) {
6681 d
= (double)n
/(1024);
6682 sprintf(s
,"%.2fK",d
);
6683 } else if (n
< (1024LL*1024*1024)) {
6684 d
= (double)n
/(1024*1024);
6685 sprintf(s
,"%.2fM",d
);
6686 } else if (n
< (1024LL*1024*1024*1024)) {
6687 d
= (double)n
/(1024LL*1024*1024);
6688 sprintf(s
,"%.2fG",d
);
6692 /* Create the string returned by the INFO command. This is decoupled
6693 * by the INFO command itself as we need to report the same information
6694 * on memory corruption problems. */
6695 static sds
genRedisInfoString(void) {
6697 time_t uptime
= time(NULL
)-server
.stat_starttime
;
6701 bytesToHuman(hmem
,zmalloc_used_memory());
6702 info
= sdscatprintf(sdsempty(),
6703 "redis_version:%s\r\n"
6705 "multiplexing_api:%s\r\n"
6706 "process_id:%ld\r\n"
6707 "uptime_in_seconds:%ld\r\n"
6708 "uptime_in_days:%ld\r\n"
6709 "connected_clients:%d\r\n"
6710 "connected_slaves:%d\r\n"
6711 "blocked_clients:%d\r\n"
6712 "used_memory:%zu\r\n"
6713 "used_memory_human:%s\r\n"
6714 "changes_since_last_save:%lld\r\n"
6715 "bgsave_in_progress:%d\r\n"
6716 "last_save_time:%ld\r\n"
6717 "bgrewriteaof_in_progress:%d\r\n"
6718 "total_connections_received:%lld\r\n"
6719 "total_commands_processed:%lld\r\n"
6720 "expired_keys:%lld\r\n"
6721 "hash_max_zipmap_entries:%ld\r\n"
6722 "hash_max_zipmap_value:%ld\r\n"
6723 "pubsub_channels:%ld\r\n"
6724 "pubsub_patterns:%u\r\n"
6728 (sizeof(long) == 8) ? "64" : "32",
6733 listLength(server
.clients
)-listLength(server
.slaves
),
6734 listLength(server
.slaves
),
6735 server
.blpop_blocked_clients
,
6736 zmalloc_used_memory(),
6739 server
.bgsavechildpid
!= -1,
6741 server
.bgrewritechildpid
!= -1,
6742 server
.stat_numconnections
,
6743 server
.stat_numcommands
,
6744 server
.stat_expiredkeys
,
6745 server
.hash_max_zipmap_entries
,
6746 server
.hash_max_zipmap_value
,
6747 dictSize(server
.pubsub_channels
),
6748 listLength(server
.pubsub_patterns
),
6749 server
.vm_enabled
!= 0,
6750 server
.masterhost
== NULL
? "master" : "slave"
6752 if (server
.masterhost
) {
6753 info
= sdscatprintf(info
,
6754 "master_host:%s\r\n"
6755 "master_port:%d\r\n"
6756 "master_link_status:%s\r\n"
6757 "master_last_io_seconds_ago:%d\r\n"
6760 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
6762 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
6765 if (server
.vm_enabled
) {
6767 info
= sdscatprintf(info
,
6768 "vm_conf_max_memory:%llu\r\n"
6769 "vm_conf_page_size:%llu\r\n"
6770 "vm_conf_pages:%llu\r\n"
6771 "vm_stats_used_pages:%llu\r\n"
6772 "vm_stats_swapped_objects:%llu\r\n"
6773 "vm_stats_swappin_count:%llu\r\n"
6774 "vm_stats_swappout_count:%llu\r\n"
6775 "vm_stats_io_newjobs_len:%lu\r\n"
6776 "vm_stats_io_processing_len:%lu\r\n"
6777 "vm_stats_io_processed_len:%lu\r\n"
6778 "vm_stats_io_active_threads:%lu\r\n"
6779 "vm_stats_blocked_clients:%lu\r\n"
6780 ,(unsigned long long) server
.vm_max_memory
,
6781 (unsigned long long) server
.vm_page_size
,
6782 (unsigned long long) server
.vm_pages
,
6783 (unsigned long long) server
.vm_stats_used_pages
,
6784 (unsigned long long) server
.vm_stats_swapped_objects
,
6785 (unsigned long long) server
.vm_stats_swapins
,
6786 (unsigned long long) server
.vm_stats_swapouts
,
6787 (unsigned long) listLength(server
.io_newjobs
),
6788 (unsigned long) listLength(server
.io_processing
),
6789 (unsigned long) listLength(server
.io_processed
),
6790 (unsigned long) server
.io_active_threads
,
6791 (unsigned long) server
.vm_blocked_clients
6795 for (j
= 0; j
< server
.dbnum
; j
++) {
6796 long long keys
, vkeys
;
6798 keys
= dictSize(server
.db
[j
].dict
);
6799 vkeys
= dictSize(server
.db
[j
].expires
);
6800 if (keys
|| vkeys
) {
6801 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
6808 static void infoCommand(redisClient
*c
) {
6809 sds info
= genRedisInfoString();
6810 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
6811 (unsigned long)sdslen(info
)));
6812 addReplySds(c
,info
);
6813 addReply(c
,shared
.crlf
);
6816 static void monitorCommand(redisClient
*c
) {
6817 /* ignore MONITOR if aleady slave or in monitor mode */
6818 if (c
->flags
& REDIS_SLAVE
) return;
6820 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
6822 listAddNodeTail(server
.monitors
,c
);
6823 addReply(c
,shared
.ok
);
6826 /* ================================= Expire ================================= */
6827 static int removeExpire(redisDb
*db
, robj
*key
) {
6828 if (dictDelete(db
->expires
,key
) == DICT_OK
) {
6835 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
6836 if (dictAdd(db
->expires
,key
,(void*)when
) == DICT_ERR
) {
6844 /* Return the expire time of the specified key, or -1 if no expire
6845 * is associated with this key (i.e. the key is non volatile) */
6846 static time_t getExpire(redisDb
*db
, robj
*key
) {
6849 /* No expire? return ASAP */
6850 if (dictSize(db
->expires
) == 0 ||
6851 (de
= dictFind(db
->expires
,key
)) == NULL
) return -1;
6853 return (time_t) dictGetEntryVal(de
);
6856 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
6860 /* No expire? return ASAP */
6861 if (dictSize(db
->expires
) == 0 ||
6862 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
6864 /* Lookup the expire */
6865 when
= (time_t) dictGetEntryVal(de
);
6866 if (time(NULL
) <= when
) return 0;
6868 /* Delete the key */
6869 dictDelete(db
->expires
,key
);
6870 server
.stat_expiredkeys
++;
6871 return dictDelete(db
->dict
,key
) == DICT_OK
;
6874 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
6877 /* No expire? return ASAP */
6878 if (dictSize(db
->expires
) == 0 ||
6879 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
6881 /* Delete the key */
6883 server
.stat_expiredkeys
++;
6884 dictDelete(db
->expires
,key
);
6885 return dictDelete(db
->dict
,key
) == DICT_OK
;
6888 static void expireGenericCommand(redisClient
*c
, robj
*key
, time_t seconds
) {
6891 de
= dictFind(c
->db
->dict
,key
);
6893 addReply(c
,shared
.czero
);
6897 if (deleteKey(c
->db
,key
)) server
.dirty
++;
6898 addReply(c
, shared
.cone
);
6901 time_t when
= time(NULL
)+seconds
;
6902 if (setExpire(c
->db
,key
,when
)) {
6903 addReply(c
,shared
.cone
);
6906 addReply(c
,shared
.czero
);
6912 static void expireCommand(redisClient
*c
) {
6913 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10));
6916 static void expireatCommand(redisClient
*c
) {
6917 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10)-time(NULL
));
6920 static void ttlCommand(redisClient
*c
) {
6924 expire
= getExpire(c
->db
,c
->argv
[1]);
6926 ttl
= (int) (expire
-time(NULL
));
6927 if (ttl
< 0) ttl
= -1;
6929 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
6932 /* ================================ MULTI/EXEC ============================== */
6934 /* Client state initialization for MULTI/EXEC */
6935 static void initClientMultiState(redisClient
*c
) {
6936 c
->mstate
.commands
= NULL
;
6937 c
->mstate
.count
= 0;
6940 /* Release all the resources associated with MULTI/EXEC state */
6941 static void freeClientMultiState(redisClient
*c
) {
6944 for (j
= 0; j
< c
->mstate
.count
; j
++) {
6946 multiCmd
*mc
= c
->mstate
.commands
+j
;
6948 for (i
= 0; i
< mc
->argc
; i
++)
6949 decrRefCount(mc
->argv
[i
]);
6952 zfree(c
->mstate
.commands
);
6955 /* Add a new command into the MULTI commands queue */
6956 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
6960 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
6961 sizeof(multiCmd
)*(c
->mstate
.count
+1));
6962 mc
= c
->mstate
.commands
+c
->mstate
.count
;
6965 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
6966 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
6967 for (j
= 0; j
< c
->argc
; j
++)
6968 incrRefCount(mc
->argv
[j
]);
6972 static void multiCommand(redisClient
*c
) {
6973 c
->flags
|= REDIS_MULTI
;
6974 addReply(c
,shared
.ok
);
6977 static void discardCommand(redisClient
*c
) {
6978 if (!(c
->flags
& REDIS_MULTI
)) {
6979 addReplySds(c
,sdsnew("-ERR DISCARD without MULTI\r\n"));
6983 freeClientMultiState(c
);
6984 initClientMultiState(c
);
6985 c
->flags
&= (~REDIS_MULTI
);
6986 addReply(c
,shared
.ok
);
6989 static void execCommand(redisClient
*c
) {
6994 if (!(c
->flags
& REDIS_MULTI
)) {
6995 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
6999 orig_argv
= c
->argv
;
7000 orig_argc
= c
->argc
;
7001 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
7002 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7003 c
->argc
= c
->mstate
.commands
[j
].argc
;
7004 c
->argv
= c
->mstate
.commands
[j
].argv
;
7005 call(c
,c
->mstate
.commands
[j
].cmd
);
7007 c
->argv
= orig_argv
;
7008 c
->argc
= orig_argc
;
7009 freeClientMultiState(c
);
7010 initClientMultiState(c
);
7011 c
->flags
&= (~REDIS_MULTI
);
7014 /* =========================== Blocking Operations ========================= */
7016 /* Currently Redis blocking operations support is limited to list POP ops,
7017 * so the current implementation is not fully generic, but it is also not
7018 * completely specific so it will not require a rewrite to support new
7019 * kind of blocking operations in the future.
7021 * Still it's important to note that list blocking operations can be already
7022 * used as a notification mechanism in order to implement other blocking
7023 * operations at application level, so there must be a very strong evidence
7024 * of usefulness and generality before new blocking operations are implemented.
7026 * This is how the current blocking POP works, we use BLPOP as example:
7027 * - If the user calls BLPOP and the key exists and contains a non empty list
7028 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
7029 * if there is not to block.
7030 * - If instead BLPOP is called and the key does not exists or the list is
7031 * empty we need to block. In order to do so we remove the notification for
7032 * new data to read in the client socket (so that we'll not serve new
7033 * requests if the blocking request is not served). Also we put the client
7034 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
7035 * blocking for this keys.
7036 * - If a PUSH operation against a key with blocked clients waiting is
7037 * performed, we serve the first in the list: basically instead to push
7038 * the new element inside the list we return it to the (first / oldest)
7039 * blocking client, unblock the client, and remove it form the list.
7041 * The above comment and the source code should be enough in order to understand
7042 * the implementation and modify / fix it later.
7045 /* Set a client in blocking mode for the specified key, with the specified
7047 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
7052 c
->blockingkeys
= zmalloc(sizeof(robj
*)*numkeys
);
7053 c
->blockingkeysnum
= numkeys
;
7054 c
->blockingto
= timeout
;
7055 for (j
= 0; j
< numkeys
; j
++) {
7056 /* Add the key in the client structure, to map clients -> keys */
7057 c
->blockingkeys
[j
] = keys
[j
];
7058 incrRefCount(keys
[j
]);
7060 /* And in the other "side", to map keys -> clients */
7061 de
= dictFind(c
->db
->blockingkeys
,keys
[j
]);
7065 /* For every key we take a list of clients blocked for it */
7067 retval
= dictAdd(c
->db
->blockingkeys
,keys
[j
],l
);
7068 incrRefCount(keys
[j
]);
7069 assert(retval
== DICT_OK
);
7071 l
= dictGetEntryVal(de
);
7073 listAddNodeTail(l
,c
);
7075 /* Mark the client as a blocked client */
7076 c
->flags
|= REDIS_BLOCKED
;
7077 server
.blpop_blocked_clients
++;
7080 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
7081 static void unblockClientWaitingData(redisClient
*c
) {
7086 assert(c
->blockingkeys
!= NULL
);
7087 /* The client may wait for multiple keys, so unblock it for every key. */
7088 for (j
= 0; j
< c
->blockingkeysnum
; j
++) {
7089 /* Remove this client from the list of clients waiting for this key. */
7090 de
= dictFind(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
7092 l
= dictGetEntryVal(de
);
7093 listDelNode(l
,listSearchKey(l
,c
));
7094 /* If the list is empty we need to remove it to avoid wasting memory */
7095 if (listLength(l
) == 0)
7096 dictDelete(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
7097 decrRefCount(c
->blockingkeys
[j
]);
7099 /* Cleanup the client structure */
7100 zfree(c
->blockingkeys
);
7101 c
->blockingkeys
= NULL
;
7102 c
->flags
&= (~REDIS_BLOCKED
);
7103 server
.blpop_blocked_clients
--;
7104 /* We want to process data if there is some command waiting
7105 * in the input buffer. Note that this is safe even if
7106 * unblockClientWaitingData() gets called from freeClient() because
7107 * freeClient() will be smart enough to call this function
7108 * *after* c->querybuf was set to NULL. */
7109 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
7112 /* This should be called from any function PUSHing into lists.
7113 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
7114 * 'ele' is the element pushed.
7116 * If the function returns 0 there was no client waiting for a list push
7119 * If the function returns 1 there was a client waiting for a list push
7120 * against this key, the element was passed to this client thus it's not
7121 * needed to actually add it to the list and the caller should return asap. */
7122 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
7123 struct dictEntry
*de
;
7124 redisClient
*receiver
;
7128 de
= dictFind(c
->db
->blockingkeys
,key
);
7129 if (de
== NULL
) return 0;
7130 l
= dictGetEntryVal(de
);
7133 receiver
= ln
->value
;
7135 addReplySds(receiver
,sdsnew("*2\r\n"));
7136 addReplyBulk(receiver
,key
);
7137 addReplyBulk(receiver
,ele
);
7138 unblockClientWaitingData(receiver
);
7142 /* Blocking RPOP/LPOP */
7143 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
7148 for (j
= 1; j
< c
->argc
-1; j
++) {
7149 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
7151 if (o
->type
!= REDIS_LIST
) {
7152 addReply(c
,shared
.wrongtypeerr
);
7155 list
*list
= o
->ptr
;
7156 if (listLength(list
) != 0) {
7157 /* If the list contains elements fall back to the usual
7158 * non-blocking POP operation */
7159 robj
*argv
[2], **orig_argv
;
7162 /* We need to alter the command arguments before to call
7163 * popGenericCommand() as the command takes a single key. */
7164 orig_argv
= c
->argv
;
7165 orig_argc
= c
->argc
;
7166 argv
[1] = c
->argv
[j
];
7170 /* Also the return value is different, we need to output
7171 * the multi bulk reply header and the key name. The
7172 * "real" command will add the last element (the value)
7173 * for us. If this souds like an hack to you it's just
7174 * because it is... */
7175 addReplySds(c
,sdsnew("*2\r\n"));
7176 addReplyBulk(c
,argv
[1]);
7177 popGenericCommand(c
,where
);
7179 /* Fix the client structure with the original stuff */
7180 c
->argv
= orig_argv
;
7181 c
->argc
= orig_argc
;
7187 /* If the list is empty or the key does not exists we must block */
7188 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
7189 if (timeout
> 0) timeout
+= time(NULL
);
7190 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
7193 static void blpopCommand(redisClient
*c
) {
7194 blockingPopGenericCommand(c
,REDIS_HEAD
);
7197 static void brpopCommand(redisClient
*c
) {
7198 blockingPopGenericCommand(c
,REDIS_TAIL
);
7201 /* =============================== Replication ============================= */
7203 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7204 ssize_t nwritten
, ret
= size
;
7205 time_t start
= time(NULL
);
7209 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
7210 nwritten
= write(fd
,ptr
,size
);
7211 if (nwritten
== -1) return -1;
7215 if ((time(NULL
)-start
) > timeout
) {
7223 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7224 ssize_t nread
, totread
= 0;
7225 time_t start
= time(NULL
);
7229 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
7230 nread
= read(fd
,ptr
,size
);
7231 if (nread
== -1) return -1;
7236 if ((time(NULL
)-start
) > timeout
) {
7244 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7251 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
7254 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
7265 static void syncCommand(redisClient
*c
) {
7266 /* ignore SYNC if aleady slave or in monitor mode */
7267 if (c
->flags
& REDIS_SLAVE
) return;
7269 /* SYNC can't be issued when the server has pending data to send to
7270 * the client about already issued commands. We need a fresh reply
7271 * buffer registering the differences between the BGSAVE and the current
7272 * dataset, so that we can copy to other slaves if needed. */
7273 if (listLength(c
->reply
) != 0) {
7274 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
7278 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
7279 /* Here we need to check if there is a background saving operation
7280 * in progress, or if it is required to start one */
7281 if (server
.bgsavechildpid
!= -1) {
7282 /* Ok a background save is in progress. Let's check if it is a good
7283 * one for replication, i.e. if there is another slave that is
7284 * registering differences since the server forked to save */
7289 listRewind(server
.slaves
,&li
);
7290 while((ln
= listNext(&li
))) {
7292 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
7295 /* Perfect, the server is already registering differences for
7296 * another slave. Set the right state, and copy the buffer. */
7297 listRelease(c
->reply
);
7298 c
->reply
= listDup(slave
->reply
);
7299 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7300 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
7302 /* No way, we need to wait for the next BGSAVE in order to
7303 * register differences */
7304 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7305 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
7308 /* Ok we don't have a BGSAVE in progress, let's start one */
7309 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
7310 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7311 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
7312 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
7315 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7318 c
->flags
|= REDIS_SLAVE
;
7320 listAddNodeTail(server
.slaves
,c
);
7324 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
7325 redisClient
*slave
= privdata
;
7327 REDIS_NOTUSED(mask
);
7328 char buf
[REDIS_IOBUF_LEN
];
7329 ssize_t nwritten
, buflen
;
7331 if (slave
->repldboff
== 0) {
7332 /* Write the bulk write count before to transfer the DB. In theory here
7333 * we don't know how much room there is in the output buffer of the
7334 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
7335 * operations) will never be smaller than the few bytes we need. */
7338 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
7340 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
7348 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
7349 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
7351 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
7352 (buflen
== 0) ? "premature EOF" : strerror(errno
));
7356 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
7357 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
7362 slave
->repldboff
+= nwritten
;
7363 if (slave
->repldboff
== slave
->repldbsize
) {
7364 close(slave
->repldbfd
);
7365 slave
->repldbfd
= -1;
7366 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7367 slave
->replstate
= REDIS_REPL_ONLINE
;
7368 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
7369 sendReplyToClient
, slave
) == AE_ERR
) {
7373 addReplySds(slave
,sdsempty());
7374 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
7378 /* This function is called at the end of every backgrond saving.
7379 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
7380 * otherwise REDIS_ERR is passed to the function.
7382 * The goal of this function is to handle slaves waiting for a successful
7383 * background saving in order to perform non-blocking synchronization. */
7384 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
7386 int startbgsave
= 0;
7389 listRewind(server
.slaves
,&li
);
7390 while((ln
= listNext(&li
))) {
7391 redisClient
*slave
= ln
->value
;
7393 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
7395 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7396 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
7397 struct redis_stat buf
;
7399 if (bgsaveerr
!= REDIS_OK
) {
7401 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
7404 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
7405 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
7407 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
7410 slave
->repldboff
= 0;
7411 slave
->repldbsize
= buf
.st_size
;
7412 slave
->replstate
= REDIS_REPL_SEND_BULK
;
7413 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7414 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
7421 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7424 listRewind(server
.slaves
,&li
);
7425 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
7426 while((ln
= listNext(&li
))) {
7427 redisClient
*slave
= ln
->value
;
7429 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
7436 static int syncWithMaster(void) {
7437 char buf
[1024], tmpfile
[256], authcmd
[1024];
7439 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
7440 int dfd
, maxtries
= 5;
7443 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
7448 /* AUTH with the master if required. */
7449 if(server
.masterauth
) {
7450 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
7451 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
7453 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
7457 /* Read the AUTH result. */
7458 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7460 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
7464 if (buf
[0] != '+') {
7466 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
7471 /* Issue the SYNC command */
7472 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
7474 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
7478 /* Read the bulk write count */
7479 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7481 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
7485 if (buf
[0] != '$') {
7487 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
7490 dumpsize
= strtol(buf
+1,NULL
,10);
7491 redisLog(REDIS_NOTICE
,"Receiving %ld bytes data dump from MASTER",dumpsize
);
7492 /* Read the bulk write data on a temp file */
7494 snprintf(tmpfile
,256,
7495 "temp-%d.%ld.rdb",(int)time(NULL
),(long int)getpid());
7496 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
|O_EXCL
,0644);
7497 if (dfd
!= -1) break;
7502 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
7506 int nread
, nwritten
;
7508 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
7510 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
7516 nwritten
= write(dfd
,buf
,nread
);
7517 if (nwritten
== -1) {
7518 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
7526 if (rename(tmpfile
,server
.dbfilename
) == -1) {
7527 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
7533 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
7534 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
7538 server
.master
= createClient(fd
);
7539 server
.master
->flags
|= REDIS_MASTER
;
7540 server
.master
->authenticated
= 1;
7541 server
.replstate
= REDIS_REPL_CONNECTED
;
7545 static void slaveofCommand(redisClient
*c
) {
7546 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
7547 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
7548 if (server
.masterhost
) {
7549 sdsfree(server
.masterhost
);
7550 server
.masterhost
= NULL
;
7551 if (server
.master
) freeClient(server
.master
);
7552 server
.replstate
= REDIS_REPL_NONE
;
7553 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
7556 sdsfree(server
.masterhost
);
7557 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
7558 server
.masterport
= atoi(c
->argv
[2]->ptr
);
7559 if (server
.master
) freeClient(server
.master
);
7560 server
.replstate
= REDIS_REPL_CONNECT
;
7561 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
7562 server
.masterhost
, server
.masterport
);
7564 addReply(c
,shared
.ok
);
7567 /* ============================ Maxmemory directive ======================== */
7569 /* Try to free one object form the pre-allocated objects free list.
7570 * This is useful under low mem conditions as by default we take 1 million
7571 * free objects allocated. On success REDIS_OK is returned, otherwise
7573 static int tryFreeOneObjectFromFreelist(void) {
7576 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
7577 if (listLength(server
.objfreelist
)) {
7578 listNode
*head
= listFirst(server
.objfreelist
);
7579 o
= listNodeValue(head
);
7580 listDelNode(server
.objfreelist
,head
);
7581 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7585 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7590 /* This function gets called when 'maxmemory' is set on the config file to limit
7591 * the max memory used by the server, and we are out of memory.
7592 * This function will try to, in order:
7594 * - Free objects from the free list
7595 * - Try to remove keys with an EXPIRE set
7597 * It is not possible to free enough memory to reach used-memory < maxmemory
7598 * the server will start refusing commands that will enlarge even more the
7601 static void freeMemoryIfNeeded(void) {
7602 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
7603 int j
, k
, freed
= 0;
7605 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
7606 for (j
= 0; j
< server
.dbnum
; j
++) {
7608 robj
*minkey
= NULL
;
7609 struct dictEntry
*de
;
7611 if (dictSize(server
.db
[j
].expires
)) {
7613 /* From a sample of three keys drop the one nearest to
7614 * the natural expire */
7615 for (k
= 0; k
< 3; k
++) {
7618 de
= dictGetRandomKey(server
.db
[j
].expires
);
7619 t
= (time_t) dictGetEntryVal(de
);
7620 if (minttl
== -1 || t
< minttl
) {
7621 minkey
= dictGetEntryKey(de
);
7625 deleteKey(server
.db
+j
,minkey
);
7628 if (!freed
) return; /* nothing to free... */
7632 /* ============================== Append Only file ========================== */
7634 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
7635 sds buf
= sdsempty();
7641 /* The DB this command was targetting is not the same as the last command
7642 * we appendend. To issue a SELECT command is needed. */
7643 if (dictid
!= server
.appendseldb
) {
7646 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
7647 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
7648 (unsigned long)strlen(seldb
),seldb
);
7649 server
.appendseldb
= dictid
;
7652 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
7653 * EXPIREs into EXPIREATs calls */
7654 if (cmd
->proc
== expireCommand
) {
7657 tmpargv
[0] = createStringObject("EXPIREAT",8);
7658 tmpargv
[1] = argv
[1];
7659 incrRefCount(argv
[1]);
7660 when
= time(NULL
)+strtol(argv
[2]->ptr
,NULL
,10);
7661 tmpargv
[2] = createObject(REDIS_STRING
,
7662 sdscatprintf(sdsempty(),"%ld",when
));
7666 /* Append the actual command */
7667 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
7668 for (j
= 0; j
< argc
; j
++) {
7671 o
= getDecodedObject(o
);
7672 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
7673 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
7674 buf
= sdscatlen(buf
,"\r\n",2);
7678 /* Free the objects from the modified argv for EXPIREAT */
7679 if (cmd
->proc
== expireCommand
) {
7680 for (j
= 0; j
< 3; j
++)
7681 decrRefCount(argv
[j
]);
7684 /* We want to perform a single write. This should be guaranteed atomic
7685 * at least if the filesystem we are writing is a real physical one.
7686 * While this will save us against the server being killed I don't think
7687 * there is much to do about the whole server stopping for power problems
7689 nwritten
= write(server
.appendfd
,buf
,sdslen(buf
));
7690 if (nwritten
!= (signed)sdslen(buf
)) {
7691 /* Ooops, we are in troubles. The best thing to do for now is
7692 * to simply exit instead to give the illusion that everything is
7693 * working as expected. */
7694 if (nwritten
== -1) {
7695 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
7697 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
7701 /* If a background append only file rewriting is in progress we want to
7702 * accumulate the differences between the child DB and the current one
7703 * in a buffer, so that when the child process will do its work we
7704 * can append the differences to the new append only file. */
7705 if (server
.bgrewritechildpid
!= -1)
7706 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
7710 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
7711 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
7712 now
-server
.lastfsync
> 1))
7714 fsync(server
.appendfd
); /* Let's try to get this data on the disk */
7715 server
.lastfsync
= now
;
7719 /* In Redis commands are always executed in the context of a client, so in
7720 * order to load the append only file we need to create a fake client. */
7721 static struct redisClient
*createFakeClient(void) {
7722 struct redisClient
*c
= zmalloc(sizeof(*c
));
7726 c
->querybuf
= sdsempty();
7730 /* We set the fake client as a slave waiting for the synchronization
7731 * so that Redis will not try to send replies to this client. */
7732 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7733 c
->reply
= listCreate();
7734 listSetFreeMethod(c
->reply
,decrRefCount
);
7735 listSetDupMethod(c
->reply
,dupClientReplyValue
);
7739 static void freeFakeClient(struct redisClient
*c
) {
7740 sdsfree(c
->querybuf
);
7741 listRelease(c
->reply
);
7745 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
7746 * error (the append only file is zero-length) REDIS_ERR is returned. On
7747 * fatal error an error message is logged and the program exists. */
7748 int loadAppendOnlyFile(char *filename
) {
7749 struct redisClient
*fakeClient
;
7750 FILE *fp
= fopen(filename
,"r");
7751 struct redis_stat sb
;
7752 unsigned long long loadedkeys
= 0;
7754 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
7758 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
7762 fakeClient
= createFakeClient();
7769 struct redisCommand
*cmd
;
7771 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
7777 if (buf
[0] != '*') goto fmterr
;
7779 argv
= zmalloc(sizeof(robj
*)*argc
);
7780 for (j
= 0; j
< argc
; j
++) {
7781 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
7782 if (buf
[0] != '$') goto fmterr
;
7783 len
= strtol(buf
+1,NULL
,10);
7784 argsds
= sdsnewlen(NULL
,len
);
7785 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
7786 argv
[j
] = createObject(REDIS_STRING
,argsds
);
7787 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
7790 /* Command lookup */
7791 cmd
= lookupCommand(argv
[0]->ptr
);
7793 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
7796 /* Try object sharing and encoding */
7797 if (server
.shareobjects
) {
7799 for(j
= 1; j
< argc
; j
++)
7800 argv
[j
] = tryObjectSharing(argv
[j
]);
7802 if (cmd
->flags
& REDIS_CMD_BULK
)
7803 tryObjectEncoding(argv
[argc
-1]);
7804 /* Run the command in the context of a fake client */
7805 fakeClient
->argc
= argc
;
7806 fakeClient
->argv
= argv
;
7807 cmd
->proc(fakeClient
);
7808 /* Discard the reply objects list from the fake client */
7809 while(listLength(fakeClient
->reply
))
7810 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
7811 /* Clean up, ready for the next command */
7812 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
7814 /* Handle swapping while loading big datasets when VM is on */
7816 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
7817 while (zmalloc_used_memory() > server
.vm_max_memory
) {
7818 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
7823 freeFakeClient(fakeClient
);
7828 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
7830 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
7834 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
7838 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
7839 static int fwriteBulkObject(FILE *fp
, robj
*obj
) {
7843 /* Avoid the incr/decr ref count business if possible to help
7844 * copy-on-write (we are often in a child process when this function
7846 * Also makes sure that key objects don't get incrRefCount-ed when VM
7848 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
7849 obj
= getDecodedObject(obj
);
7852 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
7853 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
7854 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
7856 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
7857 if (decrrc
) decrRefCount(obj
);
7860 if (decrrc
) decrRefCount(obj
);
7864 /* Write binary-safe string into a file in the bulkformat
7865 * $<count>\r\n<payload>\r\n */
7866 static int fwriteBulkString(FILE *fp
, char *s
, unsigned long len
) {
7869 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(unsigned long)len
);
7870 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
7871 if (len
&& fwrite(s
,len
,1,fp
) == 0) return 0;
7872 if (fwrite("\r\n",2,1,fp
) == 0) return 0;
7876 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
7877 static int fwriteBulkDouble(FILE *fp
, double d
) {
7878 char buf
[128], dbuf
[128];
7880 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
7881 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
7882 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
7883 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
7887 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
7888 static int fwriteBulkLong(FILE *fp
, long l
) {
7889 char buf
[128], lbuf
[128];
7891 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
7892 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
7893 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
7894 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
7898 /* Write a sequence of commands able to fully rebuild the dataset into
7899 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
7900 static int rewriteAppendOnlyFile(char *filename
) {
7901 dictIterator
*di
= NULL
;
7906 time_t now
= time(NULL
);
7908 /* Note that we have to use a different temp name here compared to the
7909 * one used by rewriteAppendOnlyFileBackground() function. */
7910 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
7911 fp
= fopen(tmpfile
,"w");
7913 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
7916 for (j
= 0; j
< server
.dbnum
; j
++) {
7917 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
7918 redisDb
*db
= server
.db
+j
;
7920 if (dictSize(d
) == 0) continue;
7921 di
= dictGetIterator(d
);
7927 /* SELECT the new DB */
7928 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
7929 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
7931 /* Iterate this DB writing every entry */
7932 while((de
= dictNext(di
)) != NULL
) {
7937 key
= dictGetEntryKey(de
);
7938 /* If the value for this key is swapped, load a preview in memory.
7939 * We use a "swapped" flag to remember if we need to free the
7940 * value object instead to just increment the ref count anyway
7941 * in order to avoid copy-on-write of pages if we are forked() */
7942 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
7943 key
->storage
== REDIS_VM_SWAPPING
) {
7944 o
= dictGetEntryVal(de
);
7947 o
= vmPreviewObject(key
);
7950 expiretime
= getExpire(db
,key
);
7952 /* Save the key and associated value */
7953 if (o
->type
== REDIS_STRING
) {
7954 /* Emit a SET command */
7955 char cmd
[]="*3\r\n$3\r\nSET\r\n";
7956 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7958 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7959 if (fwriteBulkObject(fp
,o
) == 0) goto werr
;
7960 } else if (o
->type
== REDIS_LIST
) {
7961 /* Emit the RPUSHes needed to rebuild the list */
7962 list
*list
= o
->ptr
;
7966 listRewind(list
,&li
);
7967 while((ln
= listNext(&li
))) {
7968 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
7969 robj
*eleobj
= listNodeValue(ln
);
7971 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7972 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7973 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
7975 } else if (o
->type
== REDIS_SET
) {
7976 /* Emit the SADDs needed to rebuild the set */
7978 dictIterator
*di
= dictGetIterator(set
);
7981 while((de
= dictNext(di
)) != NULL
) {
7982 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
7983 robj
*eleobj
= dictGetEntryKey(de
);
7985 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7986 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7987 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
7989 dictReleaseIterator(di
);
7990 } else if (o
->type
== REDIS_ZSET
) {
7991 /* Emit the ZADDs needed to rebuild the sorted set */
7993 dictIterator
*di
= dictGetIterator(zs
->dict
);
7996 while((de
= dictNext(di
)) != NULL
) {
7997 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
7998 robj
*eleobj
= dictGetEntryKey(de
);
7999 double *score
= dictGetEntryVal(de
);
8001 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8002 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8003 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
8004 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8006 dictReleaseIterator(di
);
8007 } else if (o
->type
== REDIS_HASH
) {
8008 char cmd
[]="*4\r\n$4\r\nHSET\r\n";
8010 /* Emit the HSETs needed to rebuild the hash */
8011 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
8012 unsigned char *p
= zipmapRewind(o
->ptr
);
8013 unsigned char *field
, *val
;
8014 unsigned int flen
, vlen
;
8016 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
8017 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8018 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8019 if (fwriteBulkString(fp
,(char*)field
,flen
) == -1)
8021 if (fwriteBulkString(fp
,(char*)val
,vlen
) == -1)
8025 dictIterator
*di
= dictGetIterator(o
->ptr
);
8028 while((de
= dictNext(di
)) != NULL
) {
8029 robj
*field
= dictGetEntryKey(de
);
8030 robj
*val
= dictGetEntryVal(de
);
8032 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8033 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8034 if (fwriteBulkObject(fp
,field
) == -1) return -1;
8035 if (fwriteBulkObject(fp
,val
) == -1) return -1;
8037 dictReleaseIterator(di
);
8042 /* Save the expire time */
8043 if (expiretime
!= -1) {
8044 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
8045 /* If this key is already expired skip it */
8046 if (expiretime
< now
) continue;
8047 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8048 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8049 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
8051 if (swapped
) decrRefCount(o
);
8053 dictReleaseIterator(di
);
8056 /* Make sure data will not remain on the OS's output buffers */
8061 /* Use RENAME to make sure the DB file is changed atomically only
8062 * if the generate DB file is ok. */
8063 if (rename(tmpfile
,filename
) == -1) {
8064 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
8068 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
8074 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
8075 if (di
) dictReleaseIterator(di
);
8079 /* This is how rewriting of the append only file in background works:
8081 * 1) The user calls BGREWRITEAOF
8082 * 2) Redis calls this function, that forks():
8083 * 2a) the child rewrite the append only file in a temp file.
8084 * 2b) the parent accumulates differences in server.bgrewritebuf.
8085 * 3) When the child finished '2a' exists.
8086 * 4) The parent will trap the exit code, if it's OK, will append the
8087 * data accumulated into server.bgrewritebuf into the temp file, and
8088 * finally will rename(2) the temp file in the actual file name.
8089 * The the new file is reopened as the new append only file. Profit!
8091 static int rewriteAppendOnlyFileBackground(void) {
8094 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
8095 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
8096 if ((childpid
= fork()) == 0) {
8100 if (server
.vm_enabled
) vmReopenSwapFile();
8102 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
8103 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
8110 if (childpid
== -1) {
8111 redisLog(REDIS_WARNING
,
8112 "Can't rewrite append only file in background: fork: %s",
8116 redisLog(REDIS_NOTICE
,
8117 "Background append only file rewriting started by pid %d",childpid
);
8118 server
.bgrewritechildpid
= childpid
;
8119 /* We set appendseldb to -1 in order to force the next call to the
8120 * feedAppendOnlyFile() to issue a SELECT command, so the differences
8121 * accumulated by the parent into server.bgrewritebuf will start
8122 * with a SELECT statement and it will be safe to merge. */
8123 server
.appendseldb
= -1;
8126 return REDIS_OK
; /* unreached */
8129 static void bgrewriteaofCommand(redisClient
*c
) {
8130 if (server
.bgrewritechildpid
!= -1) {
8131 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
8134 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
8135 char *status
= "+Background append only file rewriting started\r\n";
8136 addReplySds(c
,sdsnew(status
));
8138 addReply(c
,shared
.err
);
8142 static void aofRemoveTempFile(pid_t childpid
) {
8145 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
8149 /* Virtual Memory is composed mainly of two subsystems:
8150 * - Blocking Virutal Memory
8151 * - Threaded Virtual Memory I/O
8152 * The two parts are not fully decoupled, but functions are split among two
8153 * different sections of the source code (delimited by comments) in order to
8154 * make more clear what functionality is about the blocking VM and what about
8155 * the threaded (not blocking) VM.
8159 * Redis VM is a blocking VM (one that blocks reading swapped values from
8160 * disk into memory when a value swapped out is needed in memory) that is made
8161 * unblocking by trying to examine the command argument vector in order to
8162 * load in background values that will likely be needed in order to exec
8163 * the command. The command is executed only once all the relevant keys
8164 * are loaded into memory.
8166 * This basically is almost as simple of a blocking VM, but almost as parallel
8167 * as a fully non-blocking VM.
8170 /* =================== Virtual Memory - Blocking Side ====================== */
8172 /* substitute the first occurrence of '%p' with the process pid in the
8173 * swap file name. */
8174 static void expandVmSwapFilename(void) {
8175 char *p
= strstr(server
.vm_swap_file
,"%p");
8181 new = sdscat(new,server
.vm_swap_file
);
8182 new = sdscatprintf(new,"%ld",(long) getpid());
8183 new = sdscat(new,p
+2);
8184 zfree(server
.vm_swap_file
);
8185 server
.vm_swap_file
= new;
8188 static void vmInit(void) {
8193 if (server
.vm_max_threads
!= 0)
8194 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
8196 expandVmSwapFilename();
8197 redisLog(REDIS_NOTICE
,"Using '%s' as swap file",server
.vm_swap_file
);
8198 if ((server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b")) == NULL
) {
8199 server
.vm_fp
= fopen(server
.vm_swap_file
,"w+b");
8201 if (server
.vm_fp
== NULL
) {
8202 redisLog(REDIS_WARNING
,
8203 "Impossible to open the swap file: %s. Exiting.",
8207 server
.vm_fd
= fileno(server
.vm_fp
);
8208 server
.vm_next_page
= 0;
8209 server
.vm_near_pages
= 0;
8210 server
.vm_stats_used_pages
= 0;
8211 server
.vm_stats_swapped_objects
= 0;
8212 server
.vm_stats_swapouts
= 0;
8213 server
.vm_stats_swapins
= 0;
8214 totsize
= server
.vm_pages
*server
.vm_page_size
;
8215 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
8216 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
8217 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
8221 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
8223 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
8224 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
8225 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
8226 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
8228 /* Initialize threaded I/O (used by Virtual Memory) */
8229 server
.io_newjobs
= listCreate();
8230 server
.io_processing
= listCreate();
8231 server
.io_processed
= listCreate();
8232 server
.io_ready_clients
= listCreate();
8233 pthread_mutex_init(&server
.io_mutex
,NULL
);
8234 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
8235 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
8236 server
.io_active_threads
= 0;
8237 if (pipe(pipefds
) == -1) {
8238 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
8242 server
.io_ready_pipe_read
= pipefds
[0];
8243 server
.io_ready_pipe_write
= pipefds
[1];
8244 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
8245 /* LZF requires a lot of stack */
8246 pthread_attr_init(&server
.io_threads_attr
);
8247 pthread_attr_getstacksize(&server
.io_threads_attr
, &stacksize
);
8248 while (stacksize
< REDIS_THREAD_STACK_SIZE
) stacksize
*= 2;
8249 pthread_attr_setstacksize(&server
.io_threads_attr
, stacksize
);
8250 /* Listen for events in the threaded I/O pipe */
8251 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
8252 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
8253 oom("creating file event");
8256 /* Mark the page as used */
8257 static void vmMarkPageUsed(off_t page
) {
8258 off_t byte
= page
/8;
8260 redisAssert(vmFreePage(page
) == 1);
8261 server
.vm_bitmap
[byte
] |= 1<<bit
;
8264 /* Mark N contiguous pages as used, with 'page' being the first. */
8265 static void vmMarkPagesUsed(off_t page
, off_t count
) {
8268 for (j
= 0; j
< count
; j
++)
8269 vmMarkPageUsed(page
+j
);
8270 server
.vm_stats_used_pages
+= count
;
8271 redisLog(REDIS_DEBUG
,"Mark USED pages: %lld pages at %lld\n",
8272 (long long)count
, (long long)page
);
8275 /* Mark the page as free */
8276 static void vmMarkPageFree(off_t page
) {
8277 off_t byte
= page
/8;
8279 redisAssert(vmFreePage(page
) == 0);
8280 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
8283 /* Mark N contiguous pages as free, with 'page' being the first. */
8284 static void vmMarkPagesFree(off_t page
, off_t count
) {
8287 for (j
= 0; j
< count
; j
++)
8288 vmMarkPageFree(page
+j
);
8289 server
.vm_stats_used_pages
-= count
;
8290 redisLog(REDIS_DEBUG
,"Mark FREE pages: %lld pages at %lld\n",
8291 (long long)count
, (long long)page
);
8294 /* Test if the page is free */
8295 static int vmFreePage(off_t page
) {
8296 off_t byte
= page
/8;
8298 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
8301 /* Find N contiguous free pages storing the first page of the cluster in *first.
8302 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
8303 * REDIS_ERR is returned.
8305 * This function uses a simple algorithm: we try to allocate
8306 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
8307 * again from the start of the swap file searching for free spaces.
8309 * If it looks pretty clear that there are no free pages near our offset
8310 * we try to find less populated places doing a forward jump of
8311 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
8312 * without hurry, and then we jump again and so forth...
8314 * This function can be improved using a free list to avoid to guess
8315 * too much, since we could collect data about freed pages.
8317 * note: I implemented this function just after watching an episode of
8318 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
8320 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
8321 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
8323 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
8324 server
.vm_near_pages
= 0;
8325 server
.vm_next_page
= 0;
8327 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
8328 base
= server
.vm_next_page
;
8330 while(offset
< server
.vm_pages
) {
8331 off_t
this = base
+offset
;
8333 /* If we overflow, restart from page zero */
8334 if (this >= server
.vm_pages
) {
8335 this -= server
.vm_pages
;
8337 /* Just overflowed, what we found on tail is no longer
8338 * interesting, as it's no longer contiguous. */
8342 if (vmFreePage(this)) {
8343 /* This is a free page */
8345 /* Already got N free pages? Return to the caller, with success */
8347 *first
= this-(n
-1);
8348 server
.vm_next_page
= this+1;
8349 redisLog(REDIS_DEBUG
, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n
, (long long) *first
);
8353 /* The current one is not a free page */
8357 /* Fast-forward if the current page is not free and we already
8358 * searched enough near this place. */
8360 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
8361 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
8363 /* Note that even if we rewind after the jump, we are don't need
8364 * to make sure numfree is set to zero as we only jump *if* it
8365 * is set to zero. */
8367 /* Otherwise just check the next page */
8374 /* Write the specified object at the specified page of the swap file */
8375 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
8376 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8377 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8378 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8379 redisLog(REDIS_WARNING
,
8380 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
8384 rdbSaveObject(server
.vm_fp
,o
);
8385 fflush(server
.vm_fp
);
8386 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8390 /* Swap the 'val' object relative to 'key' into disk. Store all the information
8391 * needed to later retrieve the object into the key object.
8392 * If we can't find enough contiguous empty pages to swap the object on disk
8393 * REDIS_ERR is returned. */
8394 static int vmSwapObjectBlocking(robj
*key
, robj
*val
) {
8395 off_t pages
= rdbSavedObjectPages(val
,NULL
);
8398 assert(key
->storage
== REDIS_VM_MEMORY
);
8399 assert(key
->refcount
== 1);
8400 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
8401 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return REDIS_ERR
;
8402 key
->vm
.page
= page
;
8403 key
->vm
.usedpages
= pages
;
8404 key
->storage
= REDIS_VM_SWAPPED
;
8405 key
->vtype
= val
->type
;
8406 decrRefCount(val
); /* Deallocate the object from memory. */
8407 vmMarkPagesUsed(page
,pages
);
8408 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
8409 (unsigned char*) key
->ptr
,
8410 (unsigned long long) page
, (unsigned long long) pages
);
8411 server
.vm_stats_swapped_objects
++;
8412 server
.vm_stats_swapouts
++;
8416 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
8419 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8420 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8421 redisLog(REDIS_WARNING
,
8422 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
8426 o
= rdbLoadObject(type
,server
.vm_fp
);
8428 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno
));
8431 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8435 /* Load the value object relative to the 'key' object from swap to memory.
8436 * The newly allocated object is returned.
8438 * If preview is true the unserialized object is returned to the caller but
8439 * no changes are made to the key object, nor the pages are marked as freed */
8440 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
8443 redisAssert(key
->storage
== REDIS_VM_SWAPPED
|| key
->storage
== REDIS_VM_LOADING
);
8444 val
= vmReadObjectFromSwap(key
->vm
.page
,key
->vtype
);
8446 key
->storage
= REDIS_VM_MEMORY
;
8447 key
->vm
.atime
= server
.unixtime
;
8448 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8449 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
8450 (unsigned char*) key
->ptr
);
8451 server
.vm_stats_swapped_objects
--;
8453 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
8454 (unsigned char*) key
->ptr
);
8456 server
.vm_stats_swapins
++;
8460 /* Plain object loading, from swap to memory */
8461 static robj
*vmLoadObject(robj
*key
) {
8462 /* If we are loading the object in background, stop it, we
8463 * need to load this object synchronously ASAP. */
8464 if (key
->storage
== REDIS_VM_LOADING
)
8465 vmCancelThreadedIOJob(key
);
8466 return vmGenericLoadObject(key
,0);
8469 /* Just load the value on disk, without to modify the key.
8470 * This is useful when we want to perform some operation on the value
8471 * without to really bring it from swap to memory, like while saving the
8472 * dataset or rewriting the append only log. */
8473 static robj
*vmPreviewObject(robj
*key
) {
8474 return vmGenericLoadObject(key
,1);
8477 /* How a good candidate is this object for swapping?
8478 * The better candidate it is, the greater the returned value.
8480 * Currently we try to perform a fast estimation of the object size in
8481 * memory, and combine it with aging informations.
8483 * Basically swappability = idle-time * log(estimated size)
8485 * Bigger objects are preferred over smaller objects, but not
8486 * proportionally, this is why we use the logarithm. This algorithm is
8487 * just a first try and will probably be tuned later. */
8488 static double computeObjectSwappability(robj
*o
) {
8489 time_t age
= server
.unixtime
- o
->vm
.atime
;
8493 struct dictEntry
*de
;
8496 if (age
<= 0) return 0;
8499 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
8502 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
8507 listNode
*ln
= listFirst(l
);
8509 asize
= sizeof(list
);
8511 robj
*ele
= ln
->value
;
8514 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8515 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8517 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
8522 z
= (o
->type
== REDIS_ZSET
);
8523 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
8525 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
8526 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
8531 de
= dictGetRandomKey(d
);
8532 ele
= dictGetEntryKey(de
);
8533 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8534 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8536 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
8537 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
8541 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
8542 unsigned char *p
= zipmapRewind((unsigned char*)o
->ptr
);
8543 unsigned int len
= zipmapLen((unsigned char*)o
->ptr
);
8544 unsigned int klen
, vlen
;
8545 unsigned char *key
, *val
;
8547 if ((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) == NULL
) {
8551 asize
= len
*(klen
+vlen
+3);
8552 } else if (o
->encoding
== REDIS_ENCODING_HT
) {
8554 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
8559 de
= dictGetRandomKey(d
);
8560 ele
= dictGetEntryKey(de
);
8561 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8562 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8564 ele
= dictGetEntryVal(de
);
8565 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8566 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8568 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
8573 return (double)age
*log(1+asize
);
8576 /* Try to swap an object that's a good candidate for swapping.
8577 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
8578 * to swap any object at all.
8580 * If 'usethreaded' is true, Redis will try to swap the object in background
8581 * using I/O threads. */
8582 static int vmSwapOneObject(int usethreads
) {
8584 struct dictEntry
*best
= NULL
;
8585 double best_swappability
= 0;
8586 redisDb
*best_db
= NULL
;
8589 for (j
= 0; j
< server
.dbnum
; j
++) {
8590 redisDb
*db
= server
.db
+j
;
8591 /* Why maxtries is set to 100?
8592 * Because this way (usually) we'll find 1 object even if just 1% - 2%
8593 * are swappable objects */
8596 if (dictSize(db
->dict
) == 0) continue;
8597 for (i
= 0; i
< 5; i
++) {
8599 double swappability
;
8601 if (maxtries
) maxtries
--;
8602 de
= dictGetRandomKey(db
->dict
);
8603 key
= dictGetEntryKey(de
);
8604 val
= dictGetEntryVal(de
);
8605 /* Only swap objects that are currently in memory.
8607 * Also don't swap shared objects if threaded VM is on, as we
8608 * try to ensure that the main thread does not touch the
8609 * object while the I/O thread is using it, but we can't
8610 * control other keys without adding additional mutex. */
8611 if (key
->storage
!= REDIS_VM_MEMORY
||
8612 (server
.vm_max_threads
!= 0 && val
->refcount
!= 1)) {
8613 if (maxtries
) i
--; /* don't count this try */
8616 swappability
= computeObjectSwappability(val
);
8617 if (!best
|| swappability
> best_swappability
) {
8619 best_swappability
= swappability
;
8624 if (best
== NULL
) return REDIS_ERR
;
8625 key
= dictGetEntryKey(best
);
8626 val
= dictGetEntryVal(best
);
8628 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
8629 key
->ptr
, best_swappability
);
8631 /* Unshare the key if needed */
8632 if (key
->refcount
> 1) {
8633 robj
*newkey
= dupStringObject(key
);
8635 key
= dictGetEntryKey(best
) = newkey
;
8639 vmSwapObjectThreaded(key
,val
,best_db
);
8642 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
8643 dictGetEntryVal(best
) = NULL
;
8651 static int vmSwapOneObjectBlocking() {
8652 return vmSwapOneObject(0);
8655 static int vmSwapOneObjectThreaded() {
8656 return vmSwapOneObject(1);
8659 /* Return true if it's safe to swap out objects in a given moment.
8660 * Basically we don't want to swap objects out while there is a BGSAVE
8661 * or a BGAEOREWRITE running in backgroud. */
8662 static int vmCanSwapOut(void) {
8663 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
8666 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
8667 * and was deleted. Otherwise 0 is returned. */
8668 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
8672 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
8673 foundkey
= dictGetEntryKey(de
);
8674 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
8679 /* =================== Virtual Memory - Threaded I/O ======================= */
8681 static void freeIOJob(iojob
*j
) {
8682 if ((j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
8683 j
->type
== REDIS_IOJOB_DO_SWAP
||
8684 j
->type
== REDIS_IOJOB_LOAD
) && j
->val
!= NULL
)
8685 decrRefCount(j
->val
);
8686 decrRefCount(j
->key
);
8690 /* Every time a thread finished a Job, it writes a byte into the write side
8691 * of an unix pipe in order to "awake" the main thread, and this function
8693 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
8697 int retval
, processed
= 0, toprocess
= -1, trytoswap
= 1;
8699 REDIS_NOTUSED(mask
);
8700 REDIS_NOTUSED(privdata
);
8702 /* For every byte we read in the read side of the pipe, there is one
8703 * I/O job completed to process. */
8704 while((retval
= read(fd
,buf
,1)) == 1) {
8708 struct dictEntry
*de
;
8710 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
8712 /* Get the processed element (the oldest one) */
8714 assert(listLength(server
.io_processed
) != 0);
8715 if (toprocess
== -1) {
8716 toprocess
= (listLength(server
.io_processed
)*REDIS_MAX_COMPLETED_JOBS_PROCESSED
)/100;
8717 if (toprocess
<= 0) toprocess
= 1;
8719 ln
= listFirst(server
.io_processed
);
8721 listDelNode(server
.io_processed
,ln
);
8723 /* If this job is marked as canceled, just ignore it */
8728 /* Post process it in the main thread, as there are things we
8729 * can do just here to avoid race conditions and/or invasive locks */
8730 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
);
8731 de
= dictFind(j
->db
->dict
,j
->key
);
8733 key
= dictGetEntryKey(de
);
8734 if (j
->type
== REDIS_IOJOB_LOAD
) {
8737 /* Key loaded, bring it at home */
8738 key
->storage
= REDIS_VM_MEMORY
;
8739 key
->vm
.atime
= server
.unixtime
;
8740 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8741 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
8742 (unsigned char*) key
->ptr
);
8743 server
.vm_stats_swapped_objects
--;
8744 server
.vm_stats_swapins
++;
8745 dictGetEntryVal(de
) = j
->val
;
8746 incrRefCount(j
->val
);
8749 /* Handle clients waiting for this key to be loaded. */
8750 handleClientsBlockedOnSwappedKey(db
,key
);
8751 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
8752 /* Now we know the amount of pages required to swap this object.
8753 * Let's find some space for it, and queue this task again
8754 * rebranded as REDIS_IOJOB_DO_SWAP. */
8755 if (!vmCanSwapOut() ||
8756 vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
)
8758 /* Ooops... no space or we can't swap as there is
8759 * a fork()ed Redis trying to save stuff on disk. */
8761 key
->storage
= REDIS_VM_MEMORY
; /* undo operation */
8763 /* Note that we need to mark this pages as used now,
8764 * if the job will be canceled, we'll mark them as freed
8766 vmMarkPagesUsed(j
->page
,j
->pages
);
8767 j
->type
= REDIS_IOJOB_DO_SWAP
;
8772 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
8775 /* Key swapped. We can finally free some memory. */
8776 if (key
->storage
!= REDIS_VM_SWAPPING
) {
8777 printf("key->storage: %d\n",key
->storage
);
8778 printf("key->name: %s\n",(char*)key
->ptr
);
8779 printf("key->refcount: %d\n",key
->refcount
);
8780 printf("val: %p\n",(void*)j
->val
);
8781 printf("val->type: %d\n",j
->val
->type
);
8782 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
8784 redisAssert(key
->storage
== REDIS_VM_SWAPPING
);
8785 val
= dictGetEntryVal(de
);
8786 key
->vm
.page
= j
->page
;
8787 key
->vm
.usedpages
= j
->pages
;
8788 key
->storage
= REDIS_VM_SWAPPED
;
8789 key
->vtype
= j
->val
->type
;
8790 decrRefCount(val
); /* Deallocate the object from memory. */
8791 dictGetEntryVal(de
) = NULL
;
8792 redisLog(REDIS_DEBUG
,
8793 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
8794 (unsigned char*) key
->ptr
,
8795 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
8796 server
.vm_stats_swapped_objects
++;
8797 server
.vm_stats_swapouts
++;
8799 /* Put a few more swap requests in queue if we are still
8801 if (trytoswap
&& vmCanSwapOut() &&
8802 zmalloc_used_memory() > server
.vm_max_memory
)
8807 more
= listLength(server
.io_newjobs
) <
8808 (unsigned) server
.vm_max_threads
;
8810 /* Don't waste CPU time if swappable objects are rare. */
8811 if (vmSwapOneObjectThreaded() == REDIS_ERR
) {
8819 if (processed
== toprocess
) return;
8821 if (retval
< 0 && errno
!= EAGAIN
) {
8822 redisLog(REDIS_WARNING
,
8823 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
8828 static void lockThreadedIO(void) {
8829 pthread_mutex_lock(&server
.io_mutex
);
8832 static void unlockThreadedIO(void) {
8833 pthread_mutex_unlock(&server
.io_mutex
);
8836 /* Remove the specified object from the threaded I/O queue if still not
8837 * processed, otherwise make sure to flag it as canceled. */
8838 static void vmCancelThreadedIOJob(robj
*o
) {
8840 server
.io_newjobs
, /* 0 */
8841 server
.io_processing
, /* 1 */
8842 server
.io_processed
/* 2 */
8846 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
8849 /* Search for a matching key in one of the queues */
8850 for (i
= 0; i
< 3; i
++) {
8854 listRewind(lists
[i
],&li
);
8855 while ((ln
= listNext(&li
)) != NULL
) {
8856 iojob
*job
= ln
->value
;
8858 if (job
->canceled
) continue; /* Skip this, already canceled. */
8859 if (compareStringObjects(job
->key
,o
) == 0) {
8860 redisLog(REDIS_DEBUG
,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
8861 (void*)job
, (char*)o
->ptr
, job
->type
, i
);
8862 /* Mark the pages as free since the swap didn't happened
8863 * or happened but is now discarded. */
8864 if (i
!= 1 && job
->type
== REDIS_IOJOB_DO_SWAP
)
8865 vmMarkPagesFree(job
->page
,job
->pages
);
8866 /* Cancel the job. It depends on the list the job is
8869 case 0: /* io_newjobs */
8870 /* If the job was yet not processed the best thing to do
8871 * is to remove it from the queue at all */
8873 listDelNode(lists
[i
],ln
);
8875 case 1: /* io_processing */
8876 /* Oh Shi- the thread is messing with the Job:
8878 * Probably it's accessing the object if this is a
8879 * PREPARE_SWAP or DO_SWAP job.
8880 * If it's a LOAD job it may be reading from disk and
8881 * if we don't wait for the job to terminate before to
8882 * cancel it, maybe in a few microseconds data can be
8883 * corrupted in this pages. So the short story is:
8885 * Better to wait for the job to move into the
8886 * next queue (processed)... */
8888 /* We try again and again until the job is completed. */
8890 /* But let's wait some time for the I/O thread
8891 * to finish with this job. After all this condition
8892 * should be very rare. */
8895 case 2: /* io_processed */
8896 /* The job was already processed, that's easy...
8897 * just mark it as canceled so that we'll ignore it
8898 * when processing completed jobs. */
8902 /* Finally we have to adjust the storage type of the object
8903 * in order to "UNDO" the operaiton. */
8904 if (o
->storage
== REDIS_VM_LOADING
)
8905 o
->storage
= REDIS_VM_SWAPPED
;
8906 else if (o
->storage
== REDIS_VM_SWAPPING
)
8907 o
->storage
= REDIS_VM_MEMORY
;
8914 assert(1 != 1); /* We should never reach this */
8917 static void *IOThreadEntryPoint(void *arg
) {
8922 pthread_detach(pthread_self());
8924 /* Get a new job to process */
8926 if (listLength(server
.io_newjobs
) == 0) {
8927 /* No new jobs in queue, exit. */
8928 redisLog(REDIS_DEBUG
,"Thread %ld exiting, nothing to do",
8929 (long) pthread_self());
8930 server
.io_active_threads
--;
8934 ln
= listFirst(server
.io_newjobs
);
8936 listDelNode(server
.io_newjobs
,ln
);
8937 /* Add the job in the processing queue */
8938 j
->thread
= pthread_self();
8939 listAddNodeTail(server
.io_processing
,j
);
8940 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
8942 redisLog(REDIS_DEBUG
,"Thread %ld got a new job (type %d): %p about key '%s'",
8943 (long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
8945 /* Process the Job */
8946 if (j
->type
== REDIS_IOJOB_LOAD
) {
8947 j
->val
= vmReadObjectFromSwap(j
->page
,j
->key
->vtype
);
8948 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
8949 FILE *fp
= fopen("/dev/null","w+");
8950 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
8952 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
8953 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
8957 /* Done: insert the job into the processed queue */
8958 redisLog(REDIS_DEBUG
,"Thread %ld completed the job: %p (key %s)",
8959 (long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
8961 listDelNode(server
.io_processing
,ln
);
8962 listAddNodeTail(server
.io_processed
,j
);
8965 /* Signal the main thread there is new stuff to process */
8966 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
8968 return NULL
; /* never reached */
8971 static void spawnIOThread(void) {
8973 sigset_t mask
, omask
;
8977 sigaddset(&mask
,SIGCHLD
);
8978 sigaddset(&mask
,SIGHUP
);
8979 sigaddset(&mask
,SIGPIPE
);
8980 pthread_sigmask(SIG_SETMASK
, &mask
, &omask
);
8981 while ((err
= pthread_create(&thread
,&server
.io_threads_attr
,IOThreadEntryPoint
,NULL
)) != 0) {
8982 redisLog(REDIS_WARNING
,"Unable to spawn an I/O thread: %s",
8986 pthread_sigmask(SIG_SETMASK
, &omask
, NULL
);
8987 server
.io_active_threads
++;
8990 /* We need to wait for the last thread to exit before we are able to
8991 * fork() in order to BGSAVE or BGREWRITEAOF. */
8992 static void waitEmptyIOJobsQueue(void) {
8994 int io_processed_len
;
8997 if (listLength(server
.io_newjobs
) == 0 &&
8998 listLength(server
.io_processing
) == 0 &&
8999 server
.io_active_threads
== 0)
9004 /* While waiting for empty jobs queue condition we post-process some
9005 * finshed job, as I/O threads may be hanging trying to write against
9006 * the io_ready_pipe_write FD but there are so much pending jobs that
9008 io_processed_len
= listLength(server
.io_processed
);
9010 if (io_processed_len
) {
9011 vmThreadedIOCompletedJob(NULL
,server
.io_ready_pipe_read
,NULL
,0);
9012 usleep(1000); /* 1 millisecond */
9014 usleep(10000); /* 10 milliseconds */
9019 static void vmReopenSwapFile(void) {
9020 /* Note: we don't close the old one as we are in the child process
9021 * and don't want to mess at all with the original file object. */
9022 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
9023 if (server
.vm_fp
== NULL
) {
9024 redisLog(REDIS_WARNING
,"Can't re-open the VM swap file: %s. Exiting.",
9025 server
.vm_swap_file
);
9028 server
.vm_fd
= fileno(server
.vm_fp
);
9031 /* This function must be called while with threaded IO locked */
9032 static void queueIOJob(iojob
*j
) {
9033 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
9034 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
9035 listAddNodeTail(server
.io_newjobs
,j
);
9036 if (server
.io_active_threads
< server
.vm_max_threads
)
9040 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
9043 assert(key
->storage
== REDIS_VM_MEMORY
);
9044 assert(key
->refcount
== 1);
9046 j
= zmalloc(sizeof(*j
));
9047 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
9049 j
->key
= dupStringObject(key
);
9053 j
->thread
= (pthread_t
) -1;
9054 key
->storage
= REDIS_VM_SWAPPING
;
9062 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
9064 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
9065 * If there is not already a job loading the key, it is craeted.
9066 * The key is added to the io_keys list in the client structure, and also
9067 * in the hash table mapping swapped keys to waiting clients, that is,
9068 * server.io_waited_keys. */
9069 static int waitForSwappedKey(redisClient
*c
, robj
*key
) {
9070 struct dictEntry
*de
;
9074 /* If the key does not exist or is already in RAM we don't need to
9075 * block the client at all. */
9076 de
= dictFind(c
->db
->dict
,key
);
9077 if (de
== NULL
) return 0;
9078 o
= dictGetEntryKey(de
);
9079 if (o
->storage
== REDIS_VM_MEMORY
) {
9081 } else if (o
->storage
== REDIS_VM_SWAPPING
) {
9082 /* We were swapping the key, undo it! */
9083 vmCancelThreadedIOJob(o
);
9087 /* OK: the key is either swapped, or being loaded just now. */
9089 /* Add the key to the list of keys this client is waiting for.
9090 * This maps clients to keys they are waiting for. */
9091 listAddNodeTail(c
->io_keys
,key
);
9094 /* Add the client to the swapped keys => clients waiting map. */
9095 de
= dictFind(c
->db
->io_keys
,key
);
9099 /* For every key we take a list of clients blocked for it */
9101 retval
= dictAdd(c
->db
->io_keys
,key
,l
);
9103 assert(retval
== DICT_OK
);
9105 l
= dictGetEntryVal(de
);
9107 listAddNodeTail(l
,c
);
9109 /* Are we already loading the key from disk? If not create a job */
9110 if (o
->storage
== REDIS_VM_SWAPPED
) {
9113 o
->storage
= REDIS_VM_LOADING
;
9114 j
= zmalloc(sizeof(*j
));
9115 j
->type
= REDIS_IOJOB_LOAD
;
9117 j
->key
= dupStringObject(key
);
9118 j
->key
->vtype
= o
->vtype
;
9119 j
->page
= o
->vm
.page
;
9122 j
->thread
= (pthread_t
) -1;
9130 /* Preload keys needed for the ZUNION and ZINTER commands. */
9131 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
) {
9133 num
= atoi(c
->argv
[2]->ptr
);
9134 for (i
= 0; i
< num
; i
++) {
9135 waitForSwappedKey(c
,c
->argv
[3+i
]);
9139 /* Is this client attempting to run a command against swapped keys?
9140 * If so, block it ASAP, load the keys in background, then resume it.
9142 * The important idea about this function is that it can fail! If keys will
9143 * still be swapped when the client is resumed, this key lookups will
9144 * just block loading keys from disk. In practical terms this should only
9145 * happen with SORT BY command or if there is a bug in this function.
9147 * Return 1 if the client is marked as blocked, 0 if the client can
9148 * continue as the keys it is going to access appear to be in memory. */
9149 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
) {
9152 if (cmd
->vm_preload_proc
!= NULL
) {
9153 cmd
->vm_preload_proc(c
);
9155 if (cmd
->vm_firstkey
== 0) return 0;
9156 last
= cmd
->vm_lastkey
;
9157 if (last
< 0) last
= c
->argc
+last
;
9158 for (j
= cmd
->vm_firstkey
; j
<= last
; j
+= cmd
->vm_keystep
)
9159 waitForSwappedKey(c
,c
->argv
[j
]);
9162 /* If the client was blocked for at least one key, mark it as blocked. */
9163 if (listLength(c
->io_keys
)) {
9164 c
->flags
|= REDIS_IO_WAIT
;
9165 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
9166 server
.vm_blocked_clients
++;
9173 /* Remove the 'key' from the list of blocked keys for a given client.
9175 * The function returns 1 when there are no longer blocking keys after
9176 * the current one was removed (and the client can be unblocked). */
9177 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
) {
9181 struct dictEntry
*de
;
9183 /* Remove the key from the list of keys this client is waiting for. */
9184 listRewind(c
->io_keys
,&li
);
9185 while ((ln
= listNext(&li
)) != NULL
) {
9186 if (compareStringObjects(ln
->value
,key
) == 0) {
9187 listDelNode(c
->io_keys
,ln
);
9193 /* Remove the client form the key => waiting clients map. */
9194 de
= dictFind(c
->db
->io_keys
,key
);
9196 l
= dictGetEntryVal(de
);
9197 ln
= listSearchKey(l
,c
);
9200 if (listLength(l
) == 0)
9201 dictDelete(c
->db
->io_keys
,key
);
9203 return listLength(c
->io_keys
) == 0;
9206 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
) {
9207 struct dictEntry
*de
;
9212 de
= dictFind(db
->io_keys
,key
);
9215 l
= dictGetEntryVal(de
);
9216 len
= listLength(l
);
9217 /* Note: we can't use something like while(listLength(l)) as the list
9218 * can be freed by the calling function when we remove the last element. */
9221 redisClient
*c
= ln
->value
;
9223 if (dontWaitForSwappedKey(c
,key
)) {
9224 /* Put the client in the list of clients ready to go as we
9225 * loaded all the keys about it. */
9226 listAddNodeTail(server
.io_ready_clients
,c
);
9231 /* =========================== Remote Configuration ========================= */
9233 static void configSetCommand(redisClient
*c
) {
9234 robj
*o
= getDecodedObject(c
->argv
[3]);
9235 if (!strcasecmp(c
->argv
[2]->ptr
,"dbfilename")) {
9236 zfree(server
.dbfilename
);
9237 server
.dbfilename
= zstrdup(o
->ptr
);
9238 } else if (!strcasecmp(c
->argv
[2]->ptr
,"requirepass")) {
9239 zfree(server
.requirepass
);
9240 server
.requirepass
= zstrdup(o
->ptr
);
9241 } else if (!strcasecmp(c
->argv
[2]->ptr
,"masterauth")) {
9242 zfree(server
.masterauth
);
9243 server
.masterauth
= zstrdup(o
->ptr
);
9244 } else if (!strcasecmp(c
->argv
[2]->ptr
,"maxmemory")) {
9245 server
.maxmemory
= strtoll(o
->ptr
, NULL
, 10);
9247 addReplySds(c
,sdscatprintf(sdsempty(),
9248 "-ERR not supported CONFIG parameter %s\r\n",
9249 (char*)c
->argv
[2]->ptr
));
9254 addReply(c
,shared
.ok
);
9257 static void configGetCommand(redisClient
*c
) {
9258 robj
*o
= getDecodedObject(c
->argv
[2]);
9259 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
9260 char *pattern
= o
->ptr
;
9264 decrRefCount(lenobj
);
9266 if (stringmatch(pattern
,"dbfilename",0)) {
9267 addReplyBulkCString(c
,"dbfilename");
9268 addReplyBulkCString(c
,server
.dbfilename
);
9271 if (stringmatch(pattern
,"requirepass",0)) {
9272 addReplyBulkCString(c
,"requirepass");
9273 addReplyBulkCString(c
,server
.requirepass
);
9276 if (stringmatch(pattern
,"masterauth",0)) {
9277 addReplyBulkCString(c
,"masterauth");
9278 addReplyBulkCString(c
,server
.masterauth
);
9281 if (stringmatch(pattern
,"maxmemory",0)) {
9284 snprintf(buf
,128,"%llu\n",server
.maxmemory
);
9285 addReplyBulkCString(c
,"maxmemory");
9286 addReplyBulkCString(c
,buf
);
9290 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%d\r\n",matches
*2);
9293 static void configCommand(redisClient
*c
) {
9294 if (!strcasecmp(c
->argv
[1]->ptr
,"set")) {
9295 if (c
->argc
!= 4) goto badarity
;
9296 configSetCommand(c
);
9297 } else if (!strcasecmp(c
->argv
[1]->ptr
,"get")) {
9298 if (c
->argc
!= 3) goto badarity
;
9299 configGetCommand(c
);
9300 } else if (!strcasecmp(c
->argv
[1]->ptr
,"resetstat")) {
9301 if (c
->argc
!= 2) goto badarity
;
9302 server
.stat_numcommands
= 0;
9303 server
.stat_numconnections
= 0;
9304 server
.stat_expiredkeys
= 0;
9305 server
.stat_starttime
= time(NULL
);
9306 addReply(c
,shared
.ok
);
9308 addReplySds(c
,sdscatprintf(sdsempty(),
9309 "-ERR CONFIG subcommand must be one of GET, SET, RESETSTAT\r\n"));
9314 addReplySds(c
,sdscatprintf(sdsempty(),
9315 "-ERR Wrong number of arguments for CONFIG %s\r\n",
9316 (char*) c
->argv
[1]->ptr
));
9319 /* =========================== Pubsub implementation ======================== */
9321 static void freePubsubPattern(void *p
) {
9322 pubsubPattern
*pat
= p
;
9324 decrRefCount(pat
->pattern
);
9328 static int listMatchPubsubPattern(void *a
, void *b
) {
9329 pubsubPattern
*pa
= a
, *pb
= b
;
9331 return (pa
->client
== pb
->client
) &&
9332 (compareStringObjects(pa
->pattern
,pb
->pattern
) == 0);
9335 /* Subscribe a client to a channel. Returns 1 if the operation succeeded, or
9336 * 0 if the client was already subscribed to that channel. */
9337 static int pubsubSubscribeChannel(redisClient
*c
, robj
*channel
) {
9338 struct dictEntry
*de
;
9339 list
*clients
= NULL
;
9342 /* Add the channel to the client -> channels hash table */
9343 if (dictAdd(c
->pubsub_channels
,channel
,NULL
) == DICT_OK
) {
9345 incrRefCount(channel
);
9346 /* Add the client to the channel -> list of clients hash table */
9347 de
= dictFind(server
.pubsub_channels
,channel
);
9349 clients
= listCreate();
9350 dictAdd(server
.pubsub_channels
,channel
,clients
);
9351 incrRefCount(channel
);
9353 clients
= dictGetEntryVal(de
);
9355 listAddNodeTail(clients
,c
);
9357 /* Notify the client */
9358 addReply(c
,shared
.mbulk3
);
9359 addReply(c
,shared
.subscribebulk
);
9360 addReplyBulk(c
,channel
);
9361 addReplyLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
9365 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9366 * 0 if the client was not subscribed to the specified channel. */
9367 static int pubsubUnsubscribeChannel(redisClient
*c
, robj
*channel
, int notify
) {
9368 struct dictEntry
*de
;
9373 /* Remove the channel from the client -> channels hash table */
9374 incrRefCount(channel
); /* channel may be just a pointer to the same object
9375 we have in the hash tables. Protect it... */
9376 if (dictDelete(c
->pubsub_channels
,channel
) == DICT_OK
) {
9378 /* Remove the client from the channel -> clients list hash table */
9379 de
= dictFind(server
.pubsub_channels
,channel
);
9381 clients
= dictGetEntryVal(de
);
9382 ln
= listSearchKey(clients
,c
);
9384 listDelNode(clients
,ln
);
9385 if (listLength(clients
) == 0) {
9386 /* Free the list and associated hash entry at all if this was
9387 * the latest client, so that it will be possible to abuse
9388 * Redis PUBSUB creating millions of channels. */
9389 dictDelete(server
.pubsub_channels
,channel
);
9392 /* Notify the client */
9394 addReply(c
,shared
.mbulk3
);
9395 addReply(c
,shared
.unsubscribebulk
);
9396 addReplyBulk(c
,channel
);
9397 addReplyLong(c
,dictSize(c
->pubsub_channels
)+
9398 listLength(c
->pubsub_patterns
));
9401 decrRefCount(channel
); /* it is finally safe to release it */
9405 /* Subscribe a client to a pattern. Returns 1 if the operation succeeded, or 0 if the clinet was already subscribed to that pattern. */
9406 static int pubsubSubscribePattern(redisClient
*c
, robj
*pattern
) {
9409 if (listSearchKey(c
->pubsub_patterns
,pattern
) == NULL
) {
9412 listAddNodeTail(c
->pubsub_patterns
,pattern
);
9413 incrRefCount(pattern
);
9414 pat
= zmalloc(sizeof(*pat
));
9415 pat
->pattern
= getDecodedObject(pattern
);
9417 listAddNodeTail(server
.pubsub_patterns
,pat
);
9419 /* Notify the client */
9420 addReply(c
,shared
.mbulk3
);
9421 addReply(c
,shared
.psubscribebulk
);
9422 addReplyBulk(c
,pattern
);
9423 addReplyLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
9427 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9428 * 0 if the client was not subscribed to the specified channel. */
9429 static int pubsubUnsubscribePattern(redisClient
*c
, robj
*pattern
, int notify
) {
9434 incrRefCount(pattern
); /* Protect the object. May be the same we remove */
9435 if ((ln
= listSearchKey(c
->pubsub_patterns
,pattern
)) != NULL
) {
9437 listDelNode(c
->pubsub_patterns
,ln
);
9439 pat
.pattern
= pattern
;
9440 ln
= listSearchKey(server
.pubsub_patterns
,&pat
);
9441 listDelNode(server
.pubsub_patterns
,ln
);
9443 /* Notify the client */
9445 addReply(c
,shared
.mbulk3
);
9446 addReply(c
,shared
.punsubscribebulk
);
9447 addReplyBulk(c
,pattern
);
9448 addReplyLong(c
,dictSize(c
->pubsub_channels
)+
9449 listLength(c
->pubsub_patterns
));
9451 decrRefCount(pattern
);
9455 /* Unsubscribe from all the channels. Return the number of channels the
9456 * client was subscribed from. */
9457 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
) {
9458 dictIterator
*di
= dictGetIterator(c
->pubsub_channels
);
9462 while((de
= dictNext(di
)) != NULL
) {
9463 robj
*channel
= dictGetEntryKey(de
);
9465 count
+= pubsubUnsubscribeChannel(c
,channel
,notify
);
9467 dictReleaseIterator(di
);
9471 /* Unsubscribe from all the patterns. Return the number of patterns the
9472 * client was subscribed from. */
9473 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
) {
9478 listRewind(c
->pubsub_patterns
,&li
);
9479 while ((ln
= listNext(&li
)) != NULL
) {
9480 robj
*pattern
= ln
->value
;
9482 count
+= pubsubUnsubscribePattern(c
,pattern
,notify
);
9487 /* Publish a message */
9488 static int pubsubPublishMessage(robj
*channel
, robj
*message
) {
9490 struct dictEntry
*de
;
9494 /* Send to clients listening for that channel */
9495 de
= dictFind(server
.pubsub_channels
,channel
);
9497 list
*list
= dictGetEntryVal(de
);
9501 listRewind(list
,&li
);
9502 while ((ln
= listNext(&li
)) != NULL
) {
9503 redisClient
*c
= ln
->value
;
9505 addReply(c
,shared
.mbulk3
);
9506 addReply(c
,shared
.messagebulk
);
9507 addReplyBulk(c
,channel
);
9508 addReplyBulk(c
,message
);
9512 /* Send to clients listening to matching channels */
9513 if (listLength(server
.pubsub_patterns
)) {
9514 listRewind(server
.pubsub_patterns
,&li
);
9515 channel
= getDecodedObject(channel
);
9516 while ((ln
= listNext(&li
)) != NULL
) {
9517 pubsubPattern
*pat
= ln
->value
;
9519 if (stringmatchlen((char*)pat
->pattern
->ptr
,
9520 sdslen(pat
->pattern
->ptr
),
9521 (char*)channel
->ptr
,
9522 sdslen(channel
->ptr
),0)) {
9523 addReply(pat
->client
,shared
.mbulk3
);
9524 addReply(pat
->client
,shared
.messagebulk
);
9525 addReplyBulk(pat
->client
,channel
);
9526 addReplyBulk(pat
->client
,message
);
9530 decrRefCount(channel
);
9535 static void subscribeCommand(redisClient
*c
) {
9538 for (j
= 1; j
< c
->argc
; j
++)
9539 pubsubSubscribeChannel(c
,c
->argv
[j
]);
9542 static void unsubscribeCommand(redisClient
*c
) {
9544 pubsubUnsubscribeAllChannels(c
,1);
9549 for (j
= 1; j
< c
->argc
; j
++)
9550 pubsubUnsubscribeChannel(c
,c
->argv
[j
],1);
9554 static void psubscribeCommand(redisClient
*c
) {
9557 for (j
= 1; j
< c
->argc
; j
++)
9558 pubsubSubscribePattern(c
,c
->argv
[j
]);
9561 static void punsubscribeCommand(redisClient
*c
) {
9563 pubsubUnsubscribeAllPatterns(c
,1);
9568 for (j
= 1; j
< c
->argc
; j
++)
9569 pubsubUnsubscribePattern(c
,c
->argv
[j
],1);
9573 static void publishCommand(redisClient
*c
) {
9574 int receivers
= pubsubPublishMessage(c
->argv
[1],c
->argv
[2]);
9575 addReplyLong(c
,receivers
);
9578 /* ================================= Debugging ============================== */
9580 static void debugCommand(redisClient
*c
) {
9581 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
9583 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
9584 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
9585 addReply(c
,shared
.err
);
9589 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
9590 addReply(c
,shared
.err
);
9593 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
9594 addReply(c
,shared
.ok
);
9595 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
9597 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
9598 addReply(c
,shared
.err
);
9601 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
9602 addReply(c
,shared
.ok
);
9603 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
9604 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
9608 addReply(c
,shared
.nokeyerr
);
9611 key
= dictGetEntryKey(de
);
9612 val
= dictGetEntryVal(de
);
9613 if (!server
.vm_enabled
|| (key
->storage
== REDIS_VM_MEMORY
||
9614 key
->storage
== REDIS_VM_SWAPPING
)) {
9618 if (val
->encoding
< (sizeof(strencoding
)/sizeof(char*))) {
9619 strenc
= strencoding
[val
->encoding
];
9621 snprintf(buf
,64,"unknown encoding %d\n", val
->encoding
);
9624 addReplySds(c
,sdscatprintf(sdsempty(),
9625 "+Key at:%p refcount:%d, value at:%p refcount:%d "
9626 "encoding:%s serializedlength:%lld\r\n",
9627 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
9628 strenc
, (long long) rdbSavedObjectLen(val
,NULL
)));
9630 addReplySds(c
,sdscatprintf(sdsempty(),
9631 "+Key at:%p refcount:%d, value swapped at: page %llu "
9632 "using %llu pages\r\n",
9633 (void*)key
, key
->refcount
, (unsigned long long) key
->vm
.page
,
9634 (unsigned long long) key
->vm
.usedpages
));
9636 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
9637 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
9640 if (!server
.vm_enabled
) {
9641 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
9645 addReply(c
,shared
.nokeyerr
);
9648 key
= dictGetEntryKey(de
);
9649 val
= dictGetEntryVal(de
);
9650 /* If the key is shared we want to create a copy */
9651 if (key
->refcount
> 1) {
9652 robj
*newkey
= dupStringObject(key
);
9654 key
= dictGetEntryKey(de
) = newkey
;
9657 if (key
->storage
!= REDIS_VM_MEMORY
) {
9658 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
9659 } else if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
9660 dictGetEntryVal(de
) = NULL
;
9661 addReply(c
,shared
.ok
);
9663 addReply(c
,shared
.err
);
9666 addReplySds(c
,sdsnew(
9667 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPOUT <key>|RELOAD]\r\n"));
9671 static void _redisAssert(char *estr
, char *file
, int line
) {
9672 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
9673 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true\n",file
,line
,estr
);
9674 #ifdef HAVE_BACKTRACE
9675 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
9680 /* =================================== Main! ================================ */
9683 int linuxOvercommitMemoryValue(void) {
9684 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
9688 if (fgets(buf
,64,fp
) == NULL
) {
9697 void linuxOvercommitMemoryWarning(void) {
9698 if (linuxOvercommitMemoryValue() == 0) {
9699 redisLog(REDIS_WARNING
,"WARNING overcommit_memory is set to 0! Background save may fail under low condition memory. To fix this issue add 'vm.overcommit_memory = 1' to /etc/sysctl.conf and then reboot or run the command 'sysctl vm.overcommit_memory=1' for this to take effect.");
9702 #endif /* __linux__ */
9704 static void daemonize(void) {
9708 if (fork() != 0) exit(0); /* parent exits */
9709 setsid(); /* create a new session */
9711 /* Every output goes to /dev/null. If Redis is daemonized but
9712 * the 'logfile' is set to 'stdout' in the configuration file
9713 * it will not log at all. */
9714 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
9715 dup2(fd
, STDIN_FILENO
);
9716 dup2(fd
, STDOUT_FILENO
);
9717 dup2(fd
, STDERR_FILENO
);
9718 if (fd
> STDERR_FILENO
) close(fd
);
9720 /* Try to write the pid file */
9721 fp
= fopen(server
.pidfile
,"w");
9723 fprintf(fp
,"%d\n",getpid());
9728 static void version() {
9729 printf("Redis server version %s\n", REDIS_VERSION
);
9733 static void usage() {
9734 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
9735 fprintf(stderr
," ./redis-server - (read config from stdin)\n");
9739 int main(int argc
, char **argv
) {
9744 if (strcmp(argv
[1], "-v") == 0 ||
9745 strcmp(argv
[1], "--version") == 0) version();
9746 if (strcmp(argv
[1], "--help") == 0) usage();
9747 resetServerSaveParams();
9748 loadServerConfig(argv
[1]);
9749 } else if ((argc
> 2)) {
9752 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'");
9754 if (server
.daemonize
) daemonize();
9756 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
9758 linuxOvercommitMemoryWarning();
9761 if (server
.appendonly
) {
9762 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
9763 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %ld seconds",time(NULL
)-start
);
9765 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
9766 redisLog(REDIS_NOTICE
,"DB loaded from disk: %ld seconds",time(NULL
)-start
);
9768 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
9769 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
9771 aeDeleteEventLoop(server
.el
);
9775 /* ============================= Backtrace support ========================= */
9777 #ifdef HAVE_BACKTRACE
9778 static char *findFuncName(void *pointer
, unsigned long *offset
);
9780 static void *getMcontextEip(ucontext_t
*uc
) {
9781 #if defined(__FreeBSD__)
9782 return (void*) uc
->uc_mcontext
.mc_eip
;
9783 #elif defined(__dietlibc__)
9784 return (void*) uc
->uc_mcontext
.eip
;
9785 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
9787 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
9789 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
9791 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
9792 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
9793 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
9795 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
9797 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
9798 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
9799 #elif defined(__ia64__) /* Linux IA64 */
9800 return (void*) uc
->uc_mcontext
.sc_ip
;
9806 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
9808 char **messages
= NULL
;
9809 int i
, trace_size
= 0;
9810 unsigned long offset
=0;
9811 ucontext_t
*uc
= (ucontext_t
*) secret
;
9813 REDIS_NOTUSED(info
);
9815 redisLog(REDIS_WARNING
,
9816 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
9817 infostring
= genRedisInfoString();
9818 redisLog(REDIS_WARNING
, "%s",infostring
);
9819 /* It's not safe to sdsfree() the returned string under memory
9820 * corruption conditions. Let it leak as we are going to abort */
9822 trace_size
= backtrace(trace
, 100);
9823 /* overwrite sigaction with caller's address */
9824 if (getMcontextEip(uc
) != NULL
) {
9825 trace
[1] = getMcontextEip(uc
);
9827 messages
= backtrace_symbols(trace
, trace_size
);
9829 for (i
=1; i
<trace_size
; ++i
) {
9830 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
9832 p
= strchr(messages
[i
],'+');
9833 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
9834 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
9836 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
9839 /* free(messages); Don't call free() with possibly corrupted memory. */
9843 static void setupSigSegvAction(void) {
9844 struct sigaction act
;
9846 sigemptyset (&act
.sa_mask
);
9847 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
9848 * is used. Otherwise, sa_handler is used */
9849 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
9850 act
.sa_sigaction
= segvHandler
;
9851 sigaction (SIGSEGV
, &act
, NULL
);
9852 sigaction (SIGBUS
, &act
, NULL
);
9853 sigaction (SIGFPE
, &act
, NULL
);
9854 sigaction (SIGILL
, &act
, NULL
);
9855 sigaction (SIGBUS
, &act
, NULL
);
9859 #include "staticsymbols.h"
9860 /* This function try to convert a pointer into a function name. It's used in
9861 * oreder to provide a backtrace under segmentation fault that's able to
9862 * display functions declared as static (otherwise the backtrace is useless). */
9863 static char *findFuncName(void *pointer
, unsigned long *offset
){
9865 unsigned long off
, minoff
= 0;
9867 /* Try to match against the Symbol with the smallest offset */
9868 for (i
=0; symsTable
[i
].pointer
; i
++) {
9869 unsigned long lp
= (unsigned long) pointer
;
9871 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
9872 off
=lp
-symsTable
[i
].pointer
;
9873 if (ret
< 0 || off
< minoff
) {
9879 if (ret
== -1) return NULL
;
9881 return symsTable
[ret
].name
;
9883 #else /* HAVE_BACKTRACE */
9884 static void setupSigSegvAction(void) {
9886 #endif /* HAVE_BACKTRACE */