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");
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");
1290 sdsfree(server
.bgrewritebuf
);
1291 server
.bgrewritebuf
= sdsempty();
1292 aofRemoveTempFile(server
.bgrewritechildpid
);
1293 server
.bgrewritechildpid
= -1;
1296 static int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
1297 int j
, loops
= server
.cronloops
++;
1298 REDIS_NOTUSED(eventLoop
);
1300 REDIS_NOTUSED(clientData
);
1302 /* We take a cached value of the unix time in the global state because
1303 * with virtual memory and aging there is to store the current time
1304 * in objects at every object access, and accuracy is not needed.
1305 * To access a global var is faster than calling time(NULL) */
1306 server
.unixtime
= time(NULL
);
1308 /* Show some info about non-empty databases */
1309 for (j
= 0; j
< server
.dbnum
; j
++) {
1310 long long size
, used
, vkeys
;
1312 size
= dictSlots(server
.db
[j
].dict
);
1313 used
= dictSize(server
.db
[j
].dict
);
1314 vkeys
= dictSize(server
.db
[j
].expires
);
1315 if (!(loops
% 50) && (used
|| vkeys
)) {
1316 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
1317 /* dictPrintStats(server.dict); */
1321 /* We don't want to resize the hash tables while a bacground saving
1322 * is in progress: the saving child is created using fork() that is
1323 * implemented with a copy-on-write semantic in most modern systems, so
1324 * if we resize the HT while there is the saving child at work actually
1325 * a lot of memory movements in the parent will cause a lot of pages
1327 if (server
.bgsavechildpid
== -1 && !(loops
% 10)) tryResizeHashTables();
1329 /* Show information about connected clients */
1330 if (!(loops
% 50)) {
1331 redisLog(REDIS_VERBOSE
,"%d clients connected (%d slaves), %zu bytes in use, %d shared objects",
1332 listLength(server
.clients
)-listLength(server
.slaves
),
1333 listLength(server
.slaves
),
1334 zmalloc_used_memory(),
1335 dictSize(server
.sharingpool
));
1338 /* Close connections of timedout clients */
1339 if ((server
.maxidletime
&& !(loops
% 100)) || server
.blpop_blocked_clients
)
1340 closeTimedoutClients();
1342 /* Check if a background saving or AOF rewrite in progress terminated */
1343 if (server
.bgsavechildpid
!= -1 || server
.bgrewritechildpid
!= -1) {
1347 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
1348 if (pid
== server
.bgsavechildpid
) {
1349 backgroundSaveDoneHandler(statloc
);
1351 backgroundRewriteDoneHandler(statloc
);
1355 /* If there is not a background saving in progress check if
1356 * we have to save now */
1357 time_t now
= time(NULL
);
1358 for (j
= 0; j
< server
.saveparamslen
; j
++) {
1359 struct saveparam
*sp
= server
.saveparams
+j
;
1361 if (server
.dirty
>= sp
->changes
&&
1362 now
-server
.lastsave
> sp
->seconds
) {
1363 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
1364 sp
->changes
, sp
->seconds
);
1365 rdbSaveBackground(server
.dbfilename
);
1371 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1372 * will use few CPU cycles if there are few expiring keys, otherwise
1373 * it will get more aggressive to avoid that too much memory is used by
1374 * keys that can be removed from the keyspace. */
1375 for (j
= 0; j
< server
.dbnum
; j
++) {
1377 redisDb
*db
= server
.db
+j
;
1379 /* Continue to expire if at the end of the cycle more than 25%
1380 * of the keys were expired. */
1382 long num
= dictSize(db
->expires
);
1383 time_t now
= time(NULL
);
1386 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
1387 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
1392 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
1393 t
= (time_t) dictGetEntryVal(de
);
1395 deleteKey(db
,dictGetEntryKey(de
));
1397 server
.stat_expiredkeys
++;
1400 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
1403 /* Swap a few keys on disk if we are over the memory limit and VM
1404 * is enbled. Try to free objects from the free list first. */
1405 if (vmCanSwapOut()) {
1406 while (server
.vm_enabled
&& zmalloc_used_memory() >
1407 server
.vm_max_memory
)
1411 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
1412 retval
= (server
.vm_max_threads
== 0) ?
1413 vmSwapOneObjectBlocking() :
1414 vmSwapOneObjectThreaded();
1415 if (retval
== REDIS_ERR
&& !(loops
% 300) &&
1416 zmalloc_used_memory() >
1417 (server
.vm_max_memory
+server
.vm_max_memory
/10))
1419 redisLog(REDIS_WARNING
,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1421 /* Note that when using threade I/O we free just one object,
1422 * because anyway when the I/O thread in charge to swap this
1423 * object out will finish, the handler of completed jobs
1424 * will try to swap more objects if we are still out of memory. */
1425 if (retval
== REDIS_ERR
|| server
.vm_max_threads
> 0) break;
1429 /* Check if we should connect to a MASTER */
1430 if (server
.replstate
== REDIS_REPL_CONNECT
&& !(loops
% 10)) {
1431 redisLog(REDIS_NOTICE
,"Connecting to MASTER...");
1432 if (syncWithMaster() == REDIS_OK
) {
1433 redisLog(REDIS_NOTICE
,"MASTER <-> SLAVE sync succeeded");
1439 /* This function gets called every time Redis is entering the
1440 * main loop of the event driven library, that is, before to sleep
1441 * for ready file descriptors. */
1442 static void beforeSleep(struct aeEventLoop
*eventLoop
) {
1443 REDIS_NOTUSED(eventLoop
);
1445 if (server
.vm_enabled
&& listLength(server
.io_ready_clients
)) {
1449 listRewind(server
.io_ready_clients
,&li
);
1450 while((ln
= listNext(&li
))) {
1451 redisClient
*c
= ln
->value
;
1452 struct redisCommand
*cmd
;
1454 /* Resume the client. */
1455 listDelNode(server
.io_ready_clients
,ln
);
1456 c
->flags
&= (~REDIS_IO_WAIT
);
1457 server
.vm_blocked_clients
--;
1458 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
1459 readQueryFromClient
, c
);
1460 cmd
= lookupCommand(c
->argv
[0]->ptr
);
1461 assert(cmd
!= NULL
);
1464 /* There may be more data to process in the input buffer. */
1465 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0)
1466 processInputBuffer(c
);
1471 static void createSharedObjects(void) {
1472 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1473 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1474 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1475 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1476 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1477 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1478 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1479 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1480 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1481 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1482 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1483 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1484 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1485 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1486 "-ERR no such key\r\n"));
1487 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1488 "-ERR syntax error\r\n"));
1489 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1490 "-ERR source and destination objects are the same\r\n"));
1491 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1492 "-ERR index out of range\r\n"));
1493 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1494 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1495 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1496 shared
.select0
= createStringObject("select 0\r\n",10);
1497 shared
.select1
= createStringObject("select 1\r\n",10);
1498 shared
.select2
= createStringObject("select 2\r\n",10);
1499 shared
.select3
= createStringObject("select 3\r\n",10);
1500 shared
.select4
= createStringObject("select 4\r\n",10);
1501 shared
.select5
= createStringObject("select 5\r\n",10);
1502 shared
.select6
= createStringObject("select 6\r\n",10);
1503 shared
.select7
= createStringObject("select 7\r\n",10);
1504 shared
.select8
= createStringObject("select 8\r\n",10);
1505 shared
.select9
= createStringObject("select 9\r\n",10);
1506 shared
.messagebulk
= createStringObject("$7\r\nmessage\r\n",13);
1507 shared
.subscribebulk
= createStringObject("$9\r\nsubscribe\r\n",15);
1508 shared
.unsubscribebulk
= createStringObject("$11\r\nunsubscribe\r\n",18);
1509 shared
.psubscribebulk
= createStringObject("$10\r\npsubscribe\r\n",17);
1510 shared
.punsubscribebulk
= createStringObject("$12\r\npunsubscribe\r\n",19);
1511 shared
.mbulk3
= createStringObject("*3\r\n",4);
1514 static void appendServerSaveParams(time_t seconds
, int changes
) {
1515 server
.saveparams
= zrealloc(server
.saveparams
,sizeof(struct saveparam
)*(server
.saveparamslen
+1));
1516 server
.saveparams
[server
.saveparamslen
].seconds
= seconds
;
1517 server
.saveparams
[server
.saveparamslen
].changes
= changes
;
1518 server
.saveparamslen
++;
1521 static void resetServerSaveParams() {
1522 zfree(server
.saveparams
);
1523 server
.saveparams
= NULL
;
1524 server
.saveparamslen
= 0;
1527 static void initServerConfig() {
1528 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1529 server
.port
= REDIS_SERVERPORT
;
1530 server
.verbosity
= REDIS_VERBOSE
;
1531 server
.maxidletime
= REDIS_MAXIDLETIME
;
1532 server
.saveparams
= NULL
;
1533 server
.logfile
= NULL
; /* NULL = log on standard output */
1534 server
.bindaddr
= NULL
;
1535 server
.glueoutputbuf
= 1;
1536 server
.daemonize
= 0;
1537 server
.appendonly
= 0;
1538 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1539 server
.lastfsync
= time(NULL
);
1540 server
.appendfd
= -1;
1541 server
.appendseldb
= -1; /* Make sure the first time will not match */
1542 server
.pidfile
= zstrdup("/var/run/redis.pid");
1543 server
.dbfilename
= zstrdup("dump.rdb");
1544 server
.appendfilename
= zstrdup("appendonly.aof");
1545 server
.requirepass
= NULL
;
1546 server
.shareobjects
= 0;
1547 server
.rdbcompression
= 1;
1548 server
.sharingpoolsize
= 1024;
1549 server
.maxclients
= 0;
1550 server
.blpop_blocked_clients
= 0;
1551 server
.maxmemory
= 0;
1552 server
.vm_enabled
= 0;
1553 server
.vm_swap_file
= zstrdup("/tmp/redis-%p.vm");
1554 server
.vm_page_size
= 256; /* 256 bytes per page */
1555 server
.vm_pages
= 1024*1024*100; /* 104 millions of pages */
1556 server
.vm_max_memory
= 1024LL*1024*1024*1; /* 1 GB of RAM */
1557 server
.vm_max_threads
= 4;
1558 server
.vm_blocked_clients
= 0;
1559 server
.hash_max_zipmap_entries
= REDIS_HASH_MAX_ZIPMAP_ENTRIES
;
1560 server
.hash_max_zipmap_value
= REDIS_HASH_MAX_ZIPMAP_VALUE
;
1562 resetServerSaveParams();
1564 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1565 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1566 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1567 /* Replication related */
1569 server
.masterauth
= NULL
;
1570 server
.masterhost
= NULL
;
1571 server
.masterport
= 6379;
1572 server
.master
= NULL
;
1573 server
.replstate
= REDIS_REPL_NONE
;
1575 /* Double constants initialization */
1577 R_PosInf
= 1.0/R_Zero
;
1578 R_NegInf
= -1.0/R_Zero
;
1579 R_Nan
= R_Zero
/R_Zero
;
1582 static void initServer() {
1585 signal(SIGHUP
, SIG_IGN
);
1586 signal(SIGPIPE
, SIG_IGN
);
1587 setupSigSegvAction();
1589 server
.devnull
= fopen("/dev/null","w");
1590 if (server
.devnull
== NULL
) {
1591 redisLog(REDIS_WARNING
, "Can't open /dev/null: %s", server
.neterr
);
1594 server
.clients
= listCreate();
1595 server
.slaves
= listCreate();
1596 server
.monitors
= listCreate();
1597 server
.objfreelist
= listCreate();
1598 createSharedObjects();
1599 server
.el
= aeCreateEventLoop();
1600 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1601 server
.sharingpool
= dictCreate(&setDictType
,NULL
);
1602 server
.fd
= anetTcpServer(server
.neterr
, server
.port
, server
.bindaddr
);
1603 if (server
.fd
== -1) {
1604 redisLog(REDIS_WARNING
, "Opening TCP port: %s", server
.neterr
);
1607 for (j
= 0; j
< server
.dbnum
; j
++) {
1608 server
.db
[j
].dict
= dictCreate(&dbDictType
,NULL
);
1609 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1610 server
.db
[j
].blockingkeys
= dictCreate(&keylistDictType
,NULL
);
1611 if (server
.vm_enabled
)
1612 server
.db
[j
].io_keys
= dictCreate(&keylistDictType
,NULL
);
1613 server
.db
[j
].id
= j
;
1615 server
.pubsub_channels
= dictCreate(&keylistDictType
,NULL
);
1616 server
.pubsub_patterns
= listCreate();
1617 listSetFreeMethod(server
.pubsub_patterns
,freePubsubPattern
);
1618 listSetMatchMethod(server
.pubsub_patterns
,listMatchPubsubPattern
);
1619 server
.cronloops
= 0;
1620 server
.bgsavechildpid
= -1;
1621 server
.bgrewritechildpid
= -1;
1622 server
.bgrewritebuf
= sdsempty();
1623 server
.lastsave
= time(NULL
);
1625 server
.stat_numcommands
= 0;
1626 server
.stat_numconnections
= 0;
1627 server
.stat_expiredkeys
= 0;
1628 server
.stat_starttime
= time(NULL
);
1629 server
.unixtime
= time(NULL
);
1630 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1631 if (aeCreateFileEvent(server
.el
, server
.fd
, AE_READABLE
,
1632 acceptHandler
, NULL
) == AE_ERR
) oom("creating file event");
1634 if (server
.appendonly
) {
1635 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1636 if (server
.appendfd
== -1) {
1637 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1643 if (server
.vm_enabled
) vmInit();
1646 /* Empty the whole database */
1647 static long long emptyDb() {
1649 long long removed
= 0;
1651 for (j
= 0; j
< server
.dbnum
; j
++) {
1652 removed
+= dictSize(server
.db
[j
].dict
);
1653 dictEmpty(server
.db
[j
].dict
);
1654 dictEmpty(server
.db
[j
].expires
);
1659 static int yesnotoi(char *s
) {
1660 if (!strcasecmp(s
,"yes")) return 1;
1661 else if (!strcasecmp(s
,"no")) return 0;
1665 /* I agree, this is a very rudimental way to load a configuration...
1666 will improve later if the config gets more complex */
1667 static void loadServerConfig(char *filename
) {
1669 char buf
[REDIS_CONFIGLINE_MAX
+1], *err
= NULL
;
1672 char *errormsg
= "Fatal error, can't open config file '%s'";
1673 char *errorbuf
= zmalloc(sizeof(char)*(strlen(errormsg
)+strlen(filename
)));
1674 sprintf(errorbuf
, errormsg
, filename
);
1676 if (filename
[0] == '-' && filename
[1] == '\0')
1679 if ((fp
= fopen(filename
,"r")) == NULL
) {
1680 redisLog(REDIS_WARNING
, errorbuf
);
1685 while(fgets(buf
,REDIS_CONFIGLINE_MAX
+1,fp
) != NULL
) {
1691 line
= sdstrim(line
," \t\r\n");
1693 /* Skip comments and blank lines*/
1694 if (line
[0] == '#' || line
[0] == '\0') {
1699 /* Split into arguments */
1700 argv
= sdssplitlen(line
,sdslen(line
)," ",1,&argc
);
1701 sdstolower(argv
[0]);
1703 /* Execute config directives */
1704 if (!strcasecmp(argv
[0],"timeout") && argc
== 2) {
1705 server
.maxidletime
= atoi(argv
[1]);
1706 if (server
.maxidletime
< 0) {
1707 err
= "Invalid timeout value"; goto loaderr
;
1709 } else if (!strcasecmp(argv
[0],"port") && argc
== 2) {
1710 server
.port
= atoi(argv
[1]);
1711 if (server
.port
< 1 || server
.port
> 65535) {
1712 err
= "Invalid port"; goto loaderr
;
1714 } else if (!strcasecmp(argv
[0],"bind") && argc
== 2) {
1715 server
.bindaddr
= zstrdup(argv
[1]);
1716 } else if (!strcasecmp(argv
[0],"save") && argc
== 3) {
1717 int seconds
= atoi(argv
[1]);
1718 int changes
= atoi(argv
[2]);
1719 if (seconds
< 1 || changes
< 0) {
1720 err
= "Invalid save parameters"; goto loaderr
;
1722 appendServerSaveParams(seconds
,changes
);
1723 } else if (!strcasecmp(argv
[0],"dir") && argc
== 2) {
1724 if (chdir(argv
[1]) == -1) {
1725 redisLog(REDIS_WARNING
,"Can't chdir to '%s': %s",
1726 argv
[1], strerror(errno
));
1729 } else if (!strcasecmp(argv
[0],"loglevel") && argc
== 2) {
1730 if (!strcasecmp(argv
[1],"debug")) server
.verbosity
= REDIS_DEBUG
;
1731 else if (!strcasecmp(argv
[1],"verbose")) server
.verbosity
= REDIS_VERBOSE
;
1732 else if (!strcasecmp(argv
[1],"notice")) server
.verbosity
= REDIS_NOTICE
;
1733 else if (!strcasecmp(argv
[1],"warning")) server
.verbosity
= REDIS_WARNING
;
1735 err
= "Invalid log level. Must be one of debug, notice, warning";
1738 } else if (!strcasecmp(argv
[0],"logfile") && argc
== 2) {
1741 server
.logfile
= zstrdup(argv
[1]);
1742 if (!strcasecmp(server
.logfile
,"stdout")) {
1743 zfree(server
.logfile
);
1744 server
.logfile
= NULL
;
1746 if (server
.logfile
) {
1747 /* Test if we are able to open the file. The server will not
1748 * be able to abort just for this problem later... */
1749 logfp
= fopen(server
.logfile
,"a");
1750 if (logfp
== NULL
) {
1751 err
= sdscatprintf(sdsempty(),
1752 "Can't open the log file: %s", strerror(errno
));
1757 } else if (!strcasecmp(argv
[0],"databases") && argc
== 2) {
1758 server
.dbnum
= atoi(argv
[1]);
1759 if (server
.dbnum
< 1) {
1760 err
= "Invalid number of databases"; goto loaderr
;
1762 } else if (!strcasecmp(argv
[0],"include") && argc
== 2) {
1763 loadServerConfig(argv
[1]);
1764 } else if (!strcasecmp(argv
[0],"maxclients") && argc
== 2) {
1765 server
.maxclients
= atoi(argv
[1]);
1766 } else if (!strcasecmp(argv
[0],"maxmemory") && argc
== 2) {
1767 server
.maxmemory
= strtoll(argv
[1], NULL
, 10);
1768 } else if (!strcasecmp(argv
[0],"slaveof") && argc
== 3) {
1769 server
.masterhost
= sdsnew(argv
[1]);
1770 server
.masterport
= atoi(argv
[2]);
1771 server
.replstate
= REDIS_REPL_CONNECT
;
1772 } else if (!strcasecmp(argv
[0],"masterauth") && argc
== 2) {
1773 server
.masterauth
= zstrdup(argv
[1]);
1774 } else if (!strcasecmp(argv
[0],"glueoutputbuf") && argc
== 2) {
1775 if ((server
.glueoutputbuf
= yesnotoi(argv
[1])) == -1) {
1776 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1778 } else if (!strcasecmp(argv
[0],"shareobjects") && argc
== 2) {
1779 if ((server
.shareobjects
= yesnotoi(argv
[1])) == -1) {
1780 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1782 } else if (!strcasecmp(argv
[0],"rdbcompression") && argc
== 2) {
1783 if ((server
.rdbcompression
= yesnotoi(argv
[1])) == -1) {
1784 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1786 } else if (!strcasecmp(argv
[0],"shareobjectspoolsize") && argc
== 2) {
1787 server
.sharingpoolsize
= atoi(argv
[1]);
1788 if (server
.sharingpoolsize
< 1) {
1789 err
= "invalid object sharing pool size"; goto loaderr
;
1791 } else if (!strcasecmp(argv
[0],"daemonize") && argc
== 2) {
1792 if ((server
.daemonize
= yesnotoi(argv
[1])) == -1) {
1793 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1795 } else if (!strcasecmp(argv
[0],"appendonly") && argc
== 2) {
1796 if ((server
.appendonly
= yesnotoi(argv
[1])) == -1) {
1797 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1799 } else if (!strcasecmp(argv
[0],"appendfsync") && argc
== 2) {
1800 if (!strcasecmp(argv
[1],"no")) {
1801 server
.appendfsync
= APPENDFSYNC_NO
;
1802 } else if (!strcasecmp(argv
[1],"always")) {
1803 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1804 } else if (!strcasecmp(argv
[1],"everysec")) {
1805 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1807 err
= "argument must be 'no', 'always' or 'everysec'";
1810 } else if (!strcasecmp(argv
[0],"requirepass") && argc
== 2) {
1811 server
.requirepass
= zstrdup(argv
[1]);
1812 } else if (!strcasecmp(argv
[0],"pidfile") && argc
== 2) {
1813 zfree(server
.pidfile
);
1814 server
.pidfile
= zstrdup(argv
[1]);
1815 } else if (!strcasecmp(argv
[0],"dbfilename") && argc
== 2) {
1816 zfree(server
.dbfilename
);
1817 server
.dbfilename
= zstrdup(argv
[1]);
1818 } else if (!strcasecmp(argv
[0],"vm-enabled") && argc
== 2) {
1819 if ((server
.vm_enabled
= yesnotoi(argv
[1])) == -1) {
1820 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1822 } else if (!strcasecmp(argv
[0],"vm-swap-file") && argc
== 2) {
1823 zfree(server
.vm_swap_file
);
1824 server
.vm_swap_file
= zstrdup(argv
[1]);
1825 } else if (!strcasecmp(argv
[0],"vm-max-memory") && argc
== 2) {
1826 server
.vm_max_memory
= strtoll(argv
[1], NULL
, 10);
1827 } else if (!strcasecmp(argv
[0],"vm-page-size") && argc
== 2) {
1828 server
.vm_page_size
= strtoll(argv
[1], NULL
, 10);
1829 } else if (!strcasecmp(argv
[0],"vm-pages") && argc
== 2) {
1830 server
.vm_pages
= strtoll(argv
[1], NULL
, 10);
1831 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1832 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1833 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-entries") && argc
== 2){
1834 server
.hash_max_zipmap_entries
= strtol(argv
[1], NULL
, 10);
1835 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-value") && argc
== 2){
1836 server
.hash_max_zipmap_value
= strtol(argv
[1], NULL
, 10);
1837 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1838 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1840 err
= "Bad directive or wrong number of arguments"; goto loaderr
;
1842 for (j
= 0; j
< argc
; j
++)
1847 if (fp
!= stdin
) fclose(fp
);
1851 fprintf(stderr
, "\n*** FATAL CONFIG FILE ERROR ***\n");
1852 fprintf(stderr
, "Reading the configuration file, at line %d\n", linenum
);
1853 fprintf(stderr
, ">>> '%s'\n", line
);
1854 fprintf(stderr
, "%s\n", err
);
1858 static void freeClientArgv(redisClient
*c
) {
1861 for (j
= 0; j
< c
->argc
; j
++)
1862 decrRefCount(c
->argv
[j
]);
1863 for (j
= 0; j
< c
->mbargc
; j
++)
1864 decrRefCount(c
->mbargv
[j
]);
1869 static void freeClient(redisClient
*c
) {
1872 /* Note that if the client we are freeing is blocked into a blocking
1873 * call, we have to set querybuf to NULL *before* to call
1874 * unblockClientWaitingData() to avoid processInputBuffer() will get
1875 * called. Also it is important to remove the file events after
1876 * this, because this call adds the READABLE event. */
1877 sdsfree(c
->querybuf
);
1879 if (c
->flags
& REDIS_BLOCKED
)
1880 unblockClientWaitingData(c
);
1882 /* Unsubscribe from all the pubsub channels */
1883 pubsubUnsubscribeAllChannels(c
,0);
1884 pubsubUnsubscribeAllPatterns(c
,0);
1885 dictRelease(c
->pubsub_channels
);
1886 listRelease(c
->pubsub_patterns
);
1887 /* Obvious cleanup */
1888 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
1889 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1890 listRelease(c
->reply
);
1893 /* Remove from the list of clients */
1894 ln
= listSearchKey(server
.clients
,c
);
1895 redisAssert(ln
!= NULL
);
1896 listDelNode(server
.clients
,ln
);
1897 /* Remove from the list of clients waiting for swapped keys */
1898 if (c
->flags
& REDIS_IO_WAIT
&& listLength(c
->io_keys
) == 0) {
1899 ln
= listSearchKey(server
.io_ready_clients
,c
);
1901 listDelNode(server
.io_ready_clients
,ln
);
1902 server
.vm_blocked_clients
--;
1905 while (server
.vm_enabled
&& listLength(c
->io_keys
)) {
1906 ln
= listFirst(c
->io_keys
);
1907 dontWaitForSwappedKey(c
,ln
->value
);
1909 listRelease(c
->io_keys
);
1910 /* Master/slave cleanup */
1911 if (c
->flags
& REDIS_SLAVE
) {
1912 if (c
->replstate
== REDIS_REPL_SEND_BULK
&& c
->repldbfd
!= -1)
1914 list
*l
= (c
->flags
& REDIS_MONITOR
) ? server
.monitors
: server
.slaves
;
1915 ln
= listSearchKey(l
,c
);
1916 redisAssert(ln
!= NULL
);
1919 if (c
->flags
& REDIS_MASTER
) {
1920 server
.master
= NULL
;
1921 server
.replstate
= REDIS_REPL_CONNECT
;
1923 /* Release memory */
1926 freeClientMultiState(c
);
1930 #define GLUEREPLY_UP_TO (1024)
1931 static void glueReplyBuffersIfNeeded(redisClient
*c
) {
1933 char buf
[GLUEREPLY_UP_TO
];
1938 listRewind(c
->reply
,&li
);
1939 while((ln
= listNext(&li
))) {
1943 objlen
= sdslen(o
->ptr
);
1944 if (copylen
+ objlen
<= GLUEREPLY_UP_TO
) {
1945 memcpy(buf
+copylen
,o
->ptr
,objlen
);
1947 listDelNode(c
->reply
,ln
);
1949 if (copylen
== 0) return;
1953 /* Now the output buffer is empty, add the new single element */
1954 o
= createObject(REDIS_STRING
,sdsnewlen(buf
,copylen
));
1955 listAddNodeHead(c
->reply
,o
);
1958 static void sendReplyToClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
1959 redisClient
*c
= privdata
;
1960 int nwritten
= 0, totwritten
= 0, objlen
;
1963 REDIS_NOTUSED(mask
);
1965 /* Use writev() if we have enough buffers to send */
1966 if (!server
.glueoutputbuf
&&
1967 listLength(c
->reply
) > REDIS_WRITEV_THRESHOLD
&&
1968 !(c
->flags
& REDIS_MASTER
))
1970 sendReplyToClientWritev(el
, fd
, privdata
, mask
);
1974 while(listLength(c
->reply
)) {
1975 if (server
.glueoutputbuf
&& listLength(c
->reply
) > 1)
1976 glueReplyBuffersIfNeeded(c
);
1978 o
= listNodeValue(listFirst(c
->reply
));
1979 objlen
= sdslen(o
->ptr
);
1982 listDelNode(c
->reply
,listFirst(c
->reply
));
1986 if (c
->flags
& REDIS_MASTER
) {
1987 /* Don't reply to a master */
1988 nwritten
= objlen
- c
->sentlen
;
1990 nwritten
= write(fd
, ((char*)o
->ptr
)+c
->sentlen
, objlen
- c
->sentlen
);
1991 if (nwritten
<= 0) break;
1993 c
->sentlen
+= nwritten
;
1994 totwritten
+= nwritten
;
1995 /* If we fully sent the object on head go to the next one */
1996 if (c
->sentlen
== objlen
) {
1997 listDelNode(c
->reply
,listFirst(c
->reply
));
2000 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
2001 * bytes, in a single threaded server it's a good idea to serve
2002 * other clients as well, even if a very large request comes from
2003 * super fast link that is always able to accept data (in real world
2004 * scenario think about 'KEYS *' against the loopback interfae) */
2005 if (totwritten
> REDIS_MAX_WRITE_PER_EVENT
) break;
2007 if (nwritten
== -1) {
2008 if (errno
== EAGAIN
) {
2011 redisLog(REDIS_VERBOSE
,
2012 "Error writing to client: %s", strerror(errno
));
2017 if (totwritten
> 0) c
->lastinteraction
= time(NULL
);
2018 if (listLength(c
->reply
) == 0) {
2020 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2024 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
)
2026 redisClient
*c
= privdata
;
2027 int nwritten
= 0, totwritten
= 0, objlen
, willwrite
;
2029 struct iovec iov
[REDIS_WRITEV_IOVEC_COUNT
];
2030 int offset
, ion
= 0;
2032 REDIS_NOTUSED(mask
);
2035 while (listLength(c
->reply
)) {
2036 offset
= c
->sentlen
;
2040 /* fill-in the iov[] array */
2041 for(node
= listFirst(c
->reply
); node
; node
= listNextNode(node
)) {
2042 o
= listNodeValue(node
);
2043 objlen
= sdslen(o
->ptr
);
2045 if (totwritten
+ objlen
- offset
> REDIS_MAX_WRITE_PER_EVENT
)
2048 if(ion
== REDIS_WRITEV_IOVEC_COUNT
)
2049 break; /* no more iovecs */
2051 iov
[ion
].iov_base
= ((char*)o
->ptr
) + offset
;
2052 iov
[ion
].iov_len
= objlen
- offset
;
2053 willwrite
+= objlen
- offset
;
2054 offset
= 0; /* just for the first item */
2061 /* write all collected blocks at once */
2062 if((nwritten
= writev(fd
, iov
, ion
)) < 0) {
2063 if (errno
!= EAGAIN
) {
2064 redisLog(REDIS_VERBOSE
,
2065 "Error writing to client: %s", strerror(errno
));
2072 totwritten
+= nwritten
;
2073 offset
= c
->sentlen
;
2075 /* remove written robjs from c->reply */
2076 while (nwritten
&& listLength(c
->reply
)) {
2077 o
= listNodeValue(listFirst(c
->reply
));
2078 objlen
= sdslen(o
->ptr
);
2080 if(nwritten
>= objlen
- offset
) {
2081 listDelNode(c
->reply
, listFirst(c
->reply
));
2082 nwritten
-= objlen
- offset
;
2086 c
->sentlen
+= nwritten
;
2094 c
->lastinteraction
= time(NULL
);
2096 if (listLength(c
->reply
) == 0) {
2098 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2102 static struct redisCommand
*lookupCommand(char *name
) {
2104 while(cmdTable
[j
].name
!= NULL
) {
2105 if (!strcasecmp(name
,cmdTable
[j
].name
)) return &cmdTable
[j
];
2111 /* resetClient prepare the client to process the next command */
2112 static void resetClient(redisClient
*c
) {
2118 /* Call() is the core of Redis execution of a command */
2119 static void call(redisClient
*c
, struct redisCommand
*cmd
) {
2122 dirty
= server
.dirty
;
2124 dirty
= server
.dirty
-dirty
;
2126 if (server
.appendonly
&& dirty
)
2127 feedAppendOnlyFile(cmd
,c
->db
->id
,c
->argv
,c
->argc
);
2128 if ((dirty
|| cmd
->flags
& REDIS_CMD_FORCE_REPLICATION
) &&
2129 listLength(server
.slaves
))
2130 replicationFeedSlaves(server
.slaves
,c
->db
->id
,c
->argv
,c
->argc
);
2131 if (listLength(server
.monitors
))
2132 replicationFeedSlaves(server
.monitors
,c
->db
->id
,c
->argv
,c
->argc
);
2133 server
.stat_numcommands
++;
2136 /* If this function gets called we already read a whole
2137 * command, argments are in the client argv/argc fields.
2138 * processCommand() execute the command or prepare the
2139 * server for a bulk read from the client.
2141 * If 1 is returned the client is still alive and valid and
2142 * and other operations can be performed by the caller. Otherwise
2143 * if 0 is returned the client was destroied (i.e. after QUIT). */
2144 static int processCommand(redisClient
*c
) {
2145 struct redisCommand
*cmd
;
2147 /* Free some memory if needed (maxmemory setting) */
2148 if (server
.maxmemory
) freeMemoryIfNeeded();
2150 /* Handle the multi bulk command type. This is an alternative protocol
2151 * supported by Redis in order to receive commands that are composed of
2152 * multiple binary-safe "bulk" arguments. The latency of processing is
2153 * a bit higher but this allows things like multi-sets, so if this
2154 * protocol is used only for MSET and similar commands this is a big win. */
2155 if (c
->multibulk
== 0 && c
->argc
== 1 && ((char*)(c
->argv
[0]->ptr
))[0] == '*') {
2156 c
->multibulk
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2157 if (c
->multibulk
<= 0) {
2161 decrRefCount(c
->argv
[c
->argc
-1]);
2165 } else if (c
->multibulk
) {
2166 if (c
->bulklen
== -1) {
2167 if (((char*)c
->argv
[0]->ptr
)[0] != '$') {
2168 addReplySds(c
,sdsnew("-ERR multi bulk protocol error\r\n"));
2172 int bulklen
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2173 decrRefCount(c
->argv
[0]);
2174 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2176 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2181 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2185 c
->mbargv
= zrealloc(c
->mbargv
,(sizeof(robj
*))*(c
->mbargc
+1));
2186 c
->mbargv
[c
->mbargc
] = c
->argv
[0];
2190 if (c
->multibulk
== 0) {
2194 /* Here we need to swap the multi-bulk argc/argv with the
2195 * normal argc/argv of the client structure. */
2197 c
->argv
= c
->mbargv
;
2198 c
->mbargv
= auxargv
;
2201 c
->argc
= c
->mbargc
;
2202 c
->mbargc
= auxargc
;
2204 /* We need to set bulklen to something different than -1
2205 * in order for the code below to process the command without
2206 * to try to read the last argument of a bulk command as
2207 * a special argument. */
2209 /* continue below and process the command */
2216 /* -- end of multi bulk commands processing -- */
2218 /* The QUIT command is handled as a special case. Normal command
2219 * procs are unable to close the client connection safely */
2220 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
2225 /* Now lookup the command and check ASAP about trivial error conditions
2226 * such wrong arity, bad command name and so forth. */
2227 cmd
= lookupCommand(c
->argv
[0]->ptr
);
2230 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2231 (char*)c
->argv
[0]->ptr
));
2234 } else if ((cmd
->arity
> 0 && cmd
->arity
!= c
->argc
) ||
2235 (c
->argc
< -cmd
->arity
)) {
2237 sdscatprintf(sdsempty(),
2238 "-ERR wrong number of arguments for '%s' command\r\n",
2242 } else if (cmd
->flags
& REDIS_CMD_BULK
&& c
->bulklen
== -1) {
2243 /* This is a bulk command, we have to read the last argument yet. */
2244 int bulklen
= atoi(c
->argv
[c
->argc
-1]->ptr
);
2246 decrRefCount(c
->argv
[c
->argc
-1]);
2247 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2249 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2254 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2255 /* It is possible that the bulk read is already in the
2256 * buffer. Check this condition and handle it accordingly.
2257 * This is just a fast path, alternative to call processInputBuffer().
2258 * It's a good idea since the code is small and this condition
2259 * happens most of the times. */
2260 if ((signed)sdslen(c
->querybuf
) >= c
->bulklen
) {
2261 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2263 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2265 /* Otherwise return... there is to read the last argument
2266 * from the socket. */
2270 /* Let's try to share objects on the command arguments vector */
2271 if (server
.shareobjects
) {
2273 for(j
= 1; j
< c
->argc
; j
++)
2274 c
->argv
[j
] = tryObjectSharing(c
->argv
[j
]);
2276 /* Let's try to encode the bulk object to save space. */
2277 if (cmd
->flags
& REDIS_CMD_BULK
)
2278 tryObjectEncoding(c
->argv
[c
->argc
-1]);
2280 /* Check if the user is authenticated */
2281 if (server
.requirepass
&& !c
->authenticated
&& cmd
->proc
!= authCommand
) {
2282 addReplySds(c
,sdsnew("-ERR operation not permitted\r\n"));
2287 /* Handle the maxmemory directive */
2288 if (server
.maxmemory
&& (cmd
->flags
& REDIS_CMD_DENYOOM
) &&
2289 zmalloc_used_memory() > server
.maxmemory
)
2291 addReplySds(c
,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2296 /* Only allow SUBSCRIBE and UNSUBSCRIBE in the context of Pub/Sub */
2297 if (dictSize(c
->pubsub_channels
) > 0 &&
2298 cmd
->proc
!= subscribeCommand
&& cmd
->proc
!= unsubscribeCommand
&&
2299 cmd
->proc
!= psubscribeCommand
&& cmd
->proc
!= punsubscribeCommand
) {
2300 addReplySds(c
,sdsnew("-ERR only (P)SUBSCRIBE / (P)UNSUBSCRIBE / QUIT allowed in this context\r\n"));
2305 /* Exec the command */
2306 if (c
->flags
& REDIS_MULTI
&& cmd
->proc
!= execCommand
&& cmd
->proc
!= discardCommand
) {
2307 queueMultiCommand(c
,cmd
);
2308 addReply(c
,shared
.queued
);
2310 if (server
.vm_enabled
&& server
.vm_max_threads
> 0 &&
2311 blockClientOnSwappedKeys(cmd
,c
)) return 1;
2315 /* Prepare the client for the next command */
2320 static void replicationFeedSlaves(list
*slaves
, int dictid
, robj
**argv
, int argc
) {
2325 /* We need 1+(ARGS*3) objects since commands are using the new protocol
2326 * and we one 1 object for the first "*<count>\r\n" multibulk count, then
2327 * for every additional object we have "$<count>\r\n" + object + "\r\n". */
2328 robj
*static_outv
[REDIS_STATIC_ARGS
*3+1];
2331 if (argc
<= REDIS_STATIC_ARGS
) {
2334 outv
= zmalloc(sizeof(robj
*)*(argc
*3+1));
2337 lenobj
= createObject(REDIS_STRING
,
2338 sdscatprintf(sdsempty(), "*%d\r\n", argc
));
2339 lenobj
->refcount
= 0;
2340 outv
[outc
++] = lenobj
;
2341 for (j
= 0; j
< argc
; j
++) {
2342 lenobj
= createObject(REDIS_STRING
,
2343 sdscatprintf(sdsempty(),"$%lu\r\n",
2344 (unsigned long) stringObjectLen(argv
[j
])));
2345 lenobj
->refcount
= 0;
2346 outv
[outc
++] = lenobj
;
2347 outv
[outc
++] = argv
[j
];
2348 outv
[outc
++] = shared
.crlf
;
2351 /* Increment all the refcounts at start and decrement at end in order to
2352 * be sure to free objects if there is no slave in a replication state
2353 * able to be feed with commands */
2354 for (j
= 0; j
< outc
; j
++) incrRefCount(outv
[j
]);
2355 listRewind(slaves
,&li
);
2356 while((ln
= listNext(&li
))) {
2357 redisClient
*slave
= ln
->value
;
2359 /* Don't feed slaves that are still waiting for BGSAVE to start */
2360 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) continue;
2362 /* Feed all the other slaves, MONITORs and so on */
2363 if (slave
->slaveseldb
!= dictid
) {
2367 case 0: selectcmd
= shared
.select0
; break;
2368 case 1: selectcmd
= shared
.select1
; break;
2369 case 2: selectcmd
= shared
.select2
; break;
2370 case 3: selectcmd
= shared
.select3
; break;
2371 case 4: selectcmd
= shared
.select4
; break;
2372 case 5: selectcmd
= shared
.select5
; break;
2373 case 6: selectcmd
= shared
.select6
; break;
2374 case 7: selectcmd
= shared
.select7
; break;
2375 case 8: selectcmd
= shared
.select8
; break;
2376 case 9: selectcmd
= shared
.select9
; break;
2378 selectcmd
= createObject(REDIS_STRING
,
2379 sdscatprintf(sdsempty(),"select %d\r\n",dictid
));
2380 selectcmd
->refcount
= 0;
2383 addReply(slave
,selectcmd
);
2384 slave
->slaveseldb
= dictid
;
2386 for (j
= 0; j
< outc
; j
++) addReply(slave
,outv
[j
]);
2388 for (j
= 0; j
< outc
; j
++) decrRefCount(outv
[j
]);
2389 if (outv
!= static_outv
) zfree(outv
);
2392 static void processInputBuffer(redisClient
*c
) {
2394 /* Before to process the input buffer, make sure the client is not
2395 * waitig for a blocking operation such as BLPOP. Note that the first
2396 * iteration the client is never blocked, otherwise the processInputBuffer
2397 * would not be called at all, but after the execution of the first commands
2398 * in the input buffer the client may be blocked, and the "goto again"
2399 * will try to reiterate. The following line will make it return asap. */
2400 if (c
->flags
& REDIS_BLOCKED
|| c
->flags
& REDIS_IO_WAIT
) return;
2401 if (c
->bulklen
== -1) {
2402 /* Read the first line of the query */
2403 char *p
= strchr(c
->querybuf
,'\n');
2410 query
= c
->querybuf
;
2411 c
->querybuf
= sdsempty();
2412 querylen
= 1+(p
-(query
));
2413 if (sdslen(query
) > querylen
) {
2414 /* leave data after the first line of the query in the buffer */
2415 c
->querybuf
= sdscatlen(c
->querybuf
,query
+querylen
,sdslen(query
)-querylen
);
2417 *p
= '\0'; /* remove "\n" */
2418 if (*(p
-1) == '\r') *(p
-1) = '\0'; /* and "\r" if any */
2419 sdsupdatelen(query
);
2421 /* Now we can split the query in arguments */
2422 argv
= sdssplitlen(query
,sdslen(query
)," ",1,&argc
);
2425 if (c
->argv
) zfree(c
->argv
);
2426 c
->argv
= zmalloc(sizeof(robj
*)*argc
);
2428 for (j
= 0; j
< argc
; j
++) {
2429 if (sdslen(argv
[j
])) {
2430 c
->argv
[c
->argc
] = createObject(REDIS_STRING
,argv
[j
]);
2438 /* Execute the command. If the client is still valid
2439 * after processCommand() return and there is something
2440 * on the query buffer try to process the next command. */
2441 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2443 /* Nothing to process, argc == 0. Just process the query
2444 * buffer if it's not empty or return to the caller */
2445 if (sdslen(c
->querybuf
)) goto again
;
2448 } else if (sdslen(c
->querybuf
) >= REDIS_REQUEST_MAX_SIZE
) {
2449 redisLog(REDIS_VERBOSE
, "Client protocol error");
2454 /* Bulk read handling. Note that if we are at this point
2455 the client already sent a command terminated with a newline,
2456 we are reading the bulk data that is actually the last
2457 argument of the command. */
2458 int qbl
= sdslen(c
->querybuf
);
2460 if (c
->bulklen
<= qbl
) {
2461 /* Copy everything but the final CRLF as final argument */
2462 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2464 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2465 /* Process the command. If the client is still valid after
2466 * the processing and there is more data in the buffer
2467 * try to parse it. */
2468 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2474 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2475 redisClient
*c
= (redisClient
*) privdata
;
2476 char buf
[REDIS_IOBUF_LEN
];
2479 REDIS_NOTUSED(mask
);
2481 nread
= read(fd
, buf
, REDIS_IOBUF_LEN
);
2483 if (errno
== EAGAIN
) {
2486 redisLog(REDIS_VERBOSE
, "Reading from client: %s",strerror(errno
));
2490 } else if (nread
== 0) {
2491 redisLog(REDIS_VERBOSE
, "Client closed connection");
2496 c
->querybuf
= sdscatlen(c
->querybuf
, buf
, nread
);
2497 c
->lastinteraction
= time(NULL
);
2501 processInputBuffer(c
);
2504 static int selectDb(redisClient
*c
, int id
) {
2505 if (id
< 0 || id
>= server
.dbnum
)
2507 c
->db
= &server
.db
[id
];
2511 static void *dupClientReplyValue(void *o
) {
2512 incrRefCount((robj
*)o
);
2516 static int listMatchObjects(void *a
, void *b
) {
2517 return compareStringObjects(a
,b
) == 0;
2520 static redisClient
*createClient(int fd
) {
2521 redisClient
*c
= zmalloc(sizeof(*c
));
2523 anetNonBlock(NULL
,fd
);
2524 anetTcpNoDelay(NULL
,fd
);
2525 if (!c
) return NULL
;
2528 c
->querybuf
= sdsempty();
2537 c
->lastinteraction
= time(NULL
);
2538 c
->authenticated
= 0;
2539 c
->replstate
= REDIS_REPL_NONE
;
2540 c
->reply
= listCreate();
2541 listSetFreeMethod(c
->reply
,decrRefCount
);
2542 listSetDupMethod(c
->reply
,dupClientReplyValue
);
2543 c
->blockingkeys
= NULL
;
2544 c
->blockingkeysnum
= 0;
2545 c
->io_keys
= listCreate();
2546 listSetFreeMethod(c
->io_keys
,decrRefCount
);
2547 c
->pubsub_channels
= dictCreate(&setDictType
,NULL
);
2548 c
->pubsub_patterns
= listCreate();
2549 listSetFreeMethod(c
->pubsub_patterns
,decrRefCount
);
2550 listSetMatchMethod(c
->pubsub_patterns
,listMatchObjects
);
2551 if (aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
2552 readQueryFromClient
, c
) == AE_ERR
) {
2556 listAddNodeTail(server
.clients
,c
);
2557 initClientMultiState(c
);
2561 static void addReply(redisClient
*c
, robj
*obj
) {
2562 if (listLength(c
->reply
) == 0 &&
2563 (c
->replstate
== REDIS_REPL_NONE
||
2564 c
->replstate
== REDIS_REPL_ONLINE
) &&
2565 aeCreateFileEvent(server
.el
, c
->fd
, AE_WRITABLE
,
2566 sendReplyToClient
, c
) == AE_ERR
) return;
2568 if (server
.vm_enabled
&& obj
->storage
!= REDIS_VM_MEMORY
) {
2569 obj
= dupStringObject(obj
);
2570 obj
->refcount
= 0; /* getDecodedObject() will increment the refcount */
2572 listAddNodeTail(c
->reply
,getDecodedObject(obj
));
2575 static void addReplySds(redisClient
*c
, sds s
) {
2576 robj
*o
= createObject(REDIS_STRING
,s
);
2581 static void addReplyDouble(redisClient
*c
, double d
) {
2584 snprintf(buf
,sizeof(buf
),"%.17g",d
);
2585 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2586 (unsigned long) strlen(buf
),buf
));
2589 static void addReplyLong(redisClient
*c
, long l
) {
2594 addReply(c
,shared
.czero
);
2596 } else if (l
== 1) {
2597 addReply(c
,shared
.cone
);
2600 len
= snprintf(buf
,sizeof(buf
),":%ld\r\n",l
);
2601 addReplySds(c
,sdsnewlen(buf
,len
));
2604 static void addReplyUlong(redisClient
*c
, unsigned long ul
) {
2609 addReply(c
,shared
.czero
);
2611 } else if (ul
== 1) {
2612 addReply(c
,shared
.cone
);
2615 len
= snprintf(buf
,sizeof(buf
),":%lu\r\n",ul
);
2616 addReplySds(c
,sdsnewlen(buf
,len
));
2619 static void addReplyBulkLen(redisClient
*c
, robj
*obj
) {
2622 if (obj
->encoding
== REDIS_ENCODING_RAW
) {
2623 len
= sdslen(obj
->ptr
);
2625 long n
= (long)obj
->ptr
;
2627 /* Compute how many bytes will take this integer as a radix 10 string */
2633 while((n
= n
/10) != 0) {
2637 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",(unsigned long)len
));
2640 static void addReplyBulk(redisClient
*c
, robj
*obj
) {
2641 addReplyBulkLen(c
,obj
);
2643 addReply(c
,shared
.crlf
);
2646 /* In the CONFIG command we need to add vanilla C string as bulk replies */
2647 static void addReplyBulkCString(redisClient
*c
, char *s
) {
2649 addReply(c
,shared
.nullbulk
);
2651 robj
*o
= createStringObject(s
,strlen(s
));
2657 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2662 REDIS_NOTUSED(mask
);
2663 REDIS_NOTUSED(privdata
);
2665 cfd
= anetAccept(server
.neterr
, fd
, cip
, &cport
);
2666 if (cfd
== AE_ERR
) {
2667 redisLog(REDIS_VERBOSE
,"Accepting client connection: %s", server
.neterr
);
2670 redisLog(REDIS_VERBOSE
,"Accepted %s:%d", cip
, cport
);
2671 if ((c
= createClient(cfd
)) == NULL
) {
2672 redisLog(REDIS_WARNING
,"Error allocating resoures for the client");
2673 close(cfd
); /* May be already closed, just ingore errors */
2676 /* If maxclient directive is set and this is one client more... close the
2677 * connection. Note that we create the client instead to check before
2678 * for this condition, since now the socket is already set in nonblocking
2679 * mode and we can send an error for free using the Kernel I/O */
2680 if (server
.maxclients
&& listLength(server
.clients
) > server
.maxclients
) {
2681 char *err
= "-ERR max number of clients reached\r\n";
2683 /* That's a best effort error message, don't check write errors */
2684 if (write(c
->fd
,err
,strlen(err
)) == -1) {
2685 /* Nothing to do, Just to avoid the warning... */
2690 server
.stat_numconnections
++;
2693 /* ======================= Redis objects implementation ===================== */
2695 static robj
*createObject(int type
, void *ptr
) {
2698 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2699 if (listLength(server
.objfreelist
)) {
2700 listNode
*head
= listFirst(server
.objfreelist
);
2701 o
= listNodeValue(head
);
2702 listDelNode(server
.objfreelist
,head
);
2703 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2705 if (server
.vm_enabled
) {
2706 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2707 o
= zmalloc(sizeof(*o
));
2709 o
= zmalloc(sizeof(*o
)-sizeof(struct redisObjectVM
));
2713 o
->encoding
= REDIS_ENCODING_RAW
;
2716 if (server
.vm_enabled
) {
2717 /* Note that this code may run in the context of an I/O thread
2718 * and accessing to server.unixtime in theory is an error
2719 * (no locks). But in practice this is safe, and even if we read
2720 * garbage Redis will not fail, as it's just a statistical info */
2721 o
->vm
.atime
= server
.unixtime
;
2722 o
->storage
= REDIS_VM_MEMORY
;
2727 static robj
*createStringObject(char *ptr
, size_t len
) {
2728 return createObject(REDIS_STRING
,sdsnewlen(ptr
,len
));
2731 static robj
*dupStringObject(robj
*o
) {
2732 assert(o
->encoding
== REDIS_ENCODING_RAW
);
2733 return createStringObject(o
->ptr
,sdslen(o
->ptr
));
2736 static robj
*createListObject(void) {
2737 list
*l
= listCreate();
2739 listSetFreeMethod(l
,decrRefCount
);
2740 return createObject(REDIS_LIST
,l
);
2743 static robj
*createSetObject(void) {
2744 dict
*d
= dictCreate(&setDictType
,NULL
);
2745 return createObject(REDIS_SET
,d
);
2748 static robj
*createHashObject(void) {
2749 /* All the Hashes start as zipmaps. Will be automatically converted
2750 * into hash tables if there are enough elements or big elements
2752 unsigned char *zm
= zipmapNew();
2753 robj
*o
= createObject(REDIS_HASH
,zm
);
2754 o
->encoding
= REDIS_ENCODING_ZIPMAP
;
2758 static robj
*createZsetObject(void) {
2759 zset
*zs
= zmalloc(sizeof(*zs
));
2761 zs
->dict
= dictCreate(&zsetDictType
,NULL
);
2762 zs
->zsl
= zslCreate();
2763 return createObject(REDIS_ZSET
,zs
);
2766 static void freeStringObject(robj
*o
) {
2767 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2772 static void freeListObject(robj
*o
) {
2773 listRelease((list
*) o
->ptr
);
2776 static void freeSetObject(robj
*o
) {
2777 dictRelease((dict
*) o
->ptr
);
2780 static void freeZsetObject(robj
*o
) {
2783 dictRelease(zs
->dict
);
2788 static void freeHashObject(robj
*o
) {
2789 switch (o
->encoding
) {
2790 case REDIS_ENCODING_HT
:
2791 dictRelease((dict
*) o
->ptr
);
2793 case REDIS_ENCODING_ZIPMAP
:
2802 static void incrRefCount(robj
*o
) {
2803 redisAssert(!server
.vm_enabled
|| o
->storage
== REDIS_VM_MEMORY
);
2807 static void decrRefCount(void *obj
) {
2810 /* Object is a key of a swapped out value, or in the process of being
2812 if (server
.vm_enabled
&&
2813 (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
))
2815 if (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
) {
2816 redisAssert(o
->refcount
== 1);
2818 if (o
->storage
== REDIS_VM_LOADING
) vmCancelThreadedIOJob(obj
);
2819 redisAssert(o
->type
== REDIS_STRING
);
2820 freeStringObject(o
);
2821 vmMarkPagesFree(o
->vm
.page
,o
->vm
.usedpages
);
2822 pthread_mutex_lock(&server
.obj_freelist_mutex
);
2823 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2824 !listAddNodeHead(server
.objfreelist
,o
))
2826 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2827 server
.vm_stats_swapped_objects
--;
2830 /* Object is in memory, or in the process of being swapped out. */
2831 if (--(o
->refcount
) == 0) {
2832 if (server
.vm_enabled
&& o
->storage
== REDIS_VM_SWAPPING
)
2833 vmCancelThreadedIOJob(obj
);
2835 case REDIS_STRING
: freeStringObject(o
); break;
2836 case REDIS_LIST
: freeListObject(o
); break;
2837 case REDIS_SET
: freeSetObject(o
); break;
2838 case REDIS_ZSET
: freeZsetObject(o
); break;
2839 case REDIS_HASH
: freeHashObject(o
); break;
2840 default: redisAssert(0); break;
2842 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2843 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2844 !listAddNodeHead(server
.objfreelist
,o
))
2846 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2850 static robj
*lookupKey(redisDb
*db
, robj
*key
) {
2851 dictEntry
*de
= dictFind(db
->dict
,key
);
2853 robj
*key
= dictGetEntryKey(de
);
2854 robj
*val
= dictGetEntryVal(de
);
2856 if (server
.vm_enabled
) {
2857 if (key
->storage
== REDIS_VM_MEMORY
||
2858 key
->storage
== REDIS_VM_SWAPPING
)
2860 /* If we were swapping the object out, stop it, this key
2862 if (key
->storage
== REDIS_VM_SWAPPING
)
2863 vmCancelThreadedIOJob(key
);
2864 /* Update the access time of the key for the aging algorithm. */
2865 key
->vm
.atime
= server
.unixtime
;
2867 int notify
= (key
->storage
== REDIS_VM_LOADING
);
2869 /* Our value was swapped on disk. Bring it at home. */
2870 redisAssert(val
== NULL
);
2871 val
= vmLoadObject(key
);
2872 dictGetEntryVal(de
) = val
;
2874 /* Clients blocked by the VM subsystem may be waiting for
2876 if (notify
) handleClientsBlockedOnSwappedKey(db
,key
);
2885 static robj
*lookupKeyRead(redisDb
*db
, robj
*key
) {
2886 expireIfNeeded(db
,key
);
2887 return lookupKey(db
,key
);
2890 static robj
*lookupKeyWrite(redisDb
*db
, robj
*key
) {
2891 deleteIfVolatile(db
,key
);
2892 return lookupKey(db
,key
);
2895 static robj
*lookupKeyReadOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
2896 robj
*o
= lookupKeyRead(c
->db
, key
);
2897 if (!o
) addReply(c
,reply
);
2901 static robj
*lookupKeyWriteOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
2902 robj
*o
= lookupKeyWrite(c
->db
, key
);
2903 if (!o
) addReply(c
,reply
);
2907 static int checkType(redisClient
*c
, robj
*o
, int type
) {
2908 if (o
->type
!= type
) {
2909 addReply(c
,shared
.wrongtypeerr
);
2915 static int deleteKey(redisDb
*db
, robj
*key
) {
2918 /* We need to protect key from destruction: after the first dictDelete()
2919 * it may happen that 'key' is no longer valid if we don't increment
2920 * it's count. This may happen when we get the object reference directly
2921 * from the hash table with dictRandomKey() or dict iterators */
2923 if (dictSize(db
->expires
)) dictDelete(db
->expires
,key
);
2924 retval
= dictDelete(db
->dict
,key
);
2927 return retval
== DICT_OK
;
2930 /* Try to share an object against the shared objects pool */
2931 static robj
*tryObjectSharing(robj
*o
) {
2932 struct dictEntry
*de
;
2935 if (o
== NULL
|| server
.shareobjects
== 0) return o
;
2937 redisAssert(o
->type
== REDIS_STRING
);
2938 de
= dictFind(server
.sharingpool
,o
);
2940 robj
*shared
= dictGetEntryKey(de
);
2942 c
= ((unsigned long) dictGetEntryVal(de
))+1;
2943 dictGetEntryVal(de
) = (void*) c
;
2944 incrRefCount(shared
);
2948 /* Here we are using a stream algorihtm: Every time an object is
2949 * shared we increment its count, everytime there is a miss we
2950 * recrement the counter of a random object. If this object reaches
2951 * zero we remove the object and put the current object instead. */
2952 if (dictSize(server
.sharingpool
) >=
2953 server
.sharingpoolsize
) {
2954 de
= dictGetRandomKey(server
.sharingpool
);
2955 redisAssert(de
!= NULL
);
2956 c
= ((unsigned long) dictGetEntryVal(de
))-1;
2957 dictGetEntryVal(de
) = (void*) c
;
2959 dictDelete(server
.sharingpool
,de
->key
);
2962 c
= 0; /* If the pool is empty we want to add this object */
2967 retval
= dictAdd(server
.sharingpool
,o
,(void*)1);
2968 redisAssert(retval
== DICT_OK
);
2975 /* Check if the nul-terminated string 's' can be represented by a long
2976 * (that is, is a number that fits into long without any other space or
2977 * character before or after the digits).
2979 * If so, the function returns REDIS_OK and *longval is set to the value
2980 * of the number. Otherwise REDIS_ERR is returned */
2981 static int isStringRepresentableAsLong(sds s
, long *longval
) {
2982 char buf
[32], *endptr
;
2986 value
= strtol(s
, &endptr
, 10);
2987 if (endptr
[0] != '\0') return REDIS_ERR
;
2988 slen
= snprintf(buf
,32,"%ld",value
);
2990 /* If the number converted back into a string is not identical
2991 * then it's not possible to encode the string as integer */
2992 if (sdslen(s
) != (unsigned)slen
|| memcmp(buf
,s
,slen
)) return REDIS_ERR
;
2993 if (longval
) *longval
= value
;
2997 /* Try to encode a string object in order to save space */
2998 static int tryObjectEncoding(robj
*o
) {
3002 if (o
->encoding
!= REDIS_ENCODING_RAW
)
3003 return REDIS_ERR
; /* Already encoded */
3005 /* It's not save to encode shared objects: shared objects can be shared
3006 * everywhere in the "object space" of Redis. Encoded objects can only
3007 * appear as "values" (and not, for instance, as keys) */
3008 if (o
->refcount
> 1) return REDIS_ERR
;
3010 /* Currently we try to encode only strings */
3011 redisAssert(o
->type
== REDIS_STRING
);
3013 /* Check if we can represent this string as a long integer */
3014 if (isStringRepresentableAsLong(s
,&value
) == REDIS_ERR
) return REDIS_ERR
;
3016 /* Ok, this object can be encoded */
3017 o
->encoding
= REDIS_ENCODING_INT
;
3019 o
->ptr
= (void*) value
;
3023 /* Get a decoded version of an encoded object (returned as a new object).
3024 * If the object is already raw-encoded just increment the ref count. */
3025 static robj
*getDecodedObject(robj
*o
) {
3028 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3032 if (o
->type
== REDIS_STRING
&& o
->encoding
== REDIS_ENCODING_INT
) {
3035 snprintf(buf
,32,"%ld",(long)o
->ptr
);
3036 dec
= createStringObject(buf
,strlen(buf
));
3039 redisAssert(1 != 1);
3043 /* Compare two string objects via strcmp() or alike.
3044 * Note that the objects may be integer-encoded. In such a case we
3045 * use snprintf() to get a string representation of the numbers on the stack
3046 * and compare the strings, it's much faster than calling getDecodedObject().
3048 * Important note: if objects are not integer encoded, but binary-safe strings,
3049 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
3051 static int compareStringObjects(robj
*a
, robj
*b
) {
3052 redisAssert(a
->type
== REDIS_STRING
&& b
->type
== REDIS_STRING
);
3053 char bufa
[128], bufb
[128], *astr
, *bstr
;
3056 if (a
== b
) return 0;
3057 if (a
->encoding
!= REDIS_ENCODING_RAW
) {
3058 snprintf(bufa
,sizeof(bufa
),"%ld",(long) a
->ptr
);
3064 if (b
->encoding
!= REDIS_ENCODING_RAW
) {
3065 snprintf(bufb
,sizeof(bufb
),"%ld",(long) b
->ptr
);
3071 return bothsds
? sdscmp(astr
,bstr
) : strcmp(astr
,bstr
);
3074 static size_t stringObjectLen(robj
*o
) {
3075 redisAssert(o
->type
== REDIS_STRING
);
3076 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3077 return sdslen(o
->ptr
);
3081 return snprintf(buf
,32,"%ld",(long)o
->ptr
);
3085 /*============================ RDB saving/loading =========================== */
3087 static int rdbSaveType(FILE *fp
, unsigned char type
) {
3088 if (fwrite(&type
,1,1,fp
) == 0) return -1;
3092 static int rdbSaveTime(FILE *fp
, time_t t
) {
3093 int32_t t32
= (int32_t) t
;
3094 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
3098 /* check rdbLoadLen() comments for more info */
3099 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
3100 unsigned char buf
[2];
3103 /* Save a 6 bit len */
3104 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
3105 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3106 } else if (len
< (1<<14)) {
3107 /* Save a 14 bit len */
3108 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
3110 if (fwrite(buf
,2,1,fp
) == 0) return -1;
3112 /* Save a 32 bit len */
3113 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
3114 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3116 if (fwrite(&len
,4,1,fp
) == 0) return -1;
3121 /* String objects in the form "2391" "-100" without any space and with a
3122 * range of values that can fit in an 8, 16 or 32 bit signed value can be
3123 * encoded as integers to save space */
3124 static int rdbTryIntegerEncoding(char *s
, size_t len
, unsigned char *enc
) {
3126 char *endptr
, buf
[32];
3128 /* Check if it's possible to encode this value as a number */
3129 value
= strtoll(s
, &endptr
, 10);
3130 if (endptr
[0] != '\0') return 0;
3131 snprintf(buf
,32,"%lld",value
);
3133 /* If the number converted back into a string is not identical
3134 * then it's not possible to encode the string as integer */
3135 if (strlen(buf
) != len
|| memcmp(buf
,s
,len
)) return 0;
3137 /* Finally check if it fits in our ranges */
3138 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
3139 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
3140 enc
[1] = value
&0xFF;
3142 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
3143 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
3144 enc
[1] = value
&0xFF;
3145 enc
[2] = (value
>>8)&0xFF;
3147 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
3148 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
3149 enc
[1] = value
&0xFF;
3150 enc
[2] = (value
>>8)&0xFF;
3151 enc
[3] = (value
>>16)&0xFF;
3152 enc
[4] = (value
>>24)&0xFF;
3159 static int rdbSaveLzfStringObject(FILE *fp
, unsigned char *s
, size_t len
) {
3160 size_t comprlen
, outlen
;
3164 /* We require at least four bytes compression for this to be worth it */
3165 if (len
<= 4) return 0;
3167 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
3168 comprlen
= lzf_compress(s
, len
, out
, outlen
);
3169 if (comprlen
== 0) {
3173 /* Data compressed! Let's save it on disk */
3174 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
3175 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
3176 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
3177 if (rdbSaveLen(fp
,len
) == -1) goto writeerr
;
3178 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
3187 /* Save a string objet as [len][data] on disk. If the object is a string
3188 * representation of an integer value we try to safe it in a special form */
3189 static int rdbSaveRawString(FILE *fp
, unsigned char *s
, size_t len
) {
3192 /* Try integer encoding */
3194 unsigned char buf
[5];
3195 if ((enclen
= rdbTryIntegerEncoding((char*)s
,len
,buf
)) > 0) {
3196 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3201 /* Try LZF compression - under 20 bytes it's unable to compress even
3202 * aaaaaaaaaaaaaaaaaa so skip it */
3203 if (server
.rdbcompression
&& len
> 20) {
3206 retval
= rdbSaveLzfStringObject(fp
,s
,len
);
3207 if (retval
== -1) return -1;
3208 if (retval
> 0) return 0;
3209 /* retval == 0 means data can't be compressed, save the old way */
3212 /* Store verbatim */
3213 if (rdbSaveLen(fp
,len
) == -1) return -1;
3214 if (len
&& fwrite(s
,len
,1,fp
) == 0) return -1;
3218 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
3219 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
3222 /* Avoid incr/decr ref count business when possible.
3223 * This plays well with copy-on-write given that we are probably
3224 * in a child process (BGSAVE). Also this makes sure key objects
3225 * of swapped objects are not incRefCount-ed (an assert does not allow
3226 * this in order to avoid bugs) */
3227 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
3228 obj
= getDecodedObject(obj
);
3229 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3232 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3237 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
3238 * 8 bit integer specifing the length of the representation.
3239 * This 8 bit integer has special values in order to specify the following
3245 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
3246 unsigned char buf
[128];
3252 } else if (!isfinite(val
)) {
3254 buf
[0] = (val
< 0) ? 255 : 254;
3256 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
3257 buf
[0] = strlen((char*)buf
+1);
3260 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
3264 /* Save a Redis object. */
3265 static int rdbSaveObject(FILE *fp
, robj
*o
) {
3266 if (o
->type
== REDIS_STRING
) {
3267 /* Save a string value */
3268 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
3269 } else if (o
->type
== REDIS_LIST
) {
3270 /* Save a list value */
3271 list
*list
= o
->ptr
;
3275 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
3276 listRewind(list
,&li
);
3277 while((ln
= listNext(&li
))) {
3278 robj
*eleobj
= listNodeValue(ln
);
3280 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3282 } else if (o
->type
== REDIS_SET
) {
3283 /* Save a set value */
3285 dictIterator
*di
= dictGetIterator(set
);
3288 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
3289 while((de
= dictNext(di
)) != NULL
) {
3290 robj
*eleobj
= dictGetEntryKey(de
);
3292 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3294 dictReleaseIterator(di
);
3295 } else if (o
->type
== REDIS_ZSET
) {
3296 /* Save a set value */
3298 dictIterator
*di
= dictGetIterator(zs
->dict
);
3301 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
3302 while((de
= dictNext(di
)) != NULL
) {
3303 robj
*eleobj
= dictGetEntryKey(de
);
3304 double *score
= dictGetEntryVal(de
);
3306 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3307 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
3309 dictReleaseIterator(di
);
3310 } else if (o
->type
== REDIS_HASH
) {
3311 /* Save a hash value */
3312 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3313 unsigned char *p
= zipmapRewind(o
->ptr
);
3314 unsigned int count
= zipmapLen(o
->ptr
);
3315 unsigned char *key
, *val
;
3316 unsigned int klen
, vlen
;
3318 if (rdbSaveLen(fp
,count
) == -1) return -1;
3319 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
3320 if (rdbSaveRawString(fp
,key
,klen
) == -1) return -1;
3321 if (rdbSaveRawString(fp
,val
,vlen
) == -1) return -1;
3324 dictIterator
*di
= dictGetIterator(o
->ptr
);
3327 if (rdbSaveLen(fp
,dictSize((dict
*)o
->ptr
)) == -1) return -1;
3328 while((de
= dictNext(di
)) != NULL
) {
3329 robj
*key
= dictGetEntryKey(de
);
3330 robj
*val
= dictGetEntryVal(de
);
3332 if (rdbSaveStringObject(fp
,key
) == -1) return -1;
3333 if (rdbSaveStringObject(fp
,val
) == -1) return -1;
3335 dictReleaseIterator(di
);
3343 /* Return the length the object will have on disk if saved with
3344 * the rdbSaveObject() function. Currently we use a trick to get
3345 * this length with very little changes to the code. In the future
3346 * we could switch to a faster solution. */
3347 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
3348 if (fp
== NULL
) fp
= server
.devnull
;
3350 assert(rdbSaveObject(fp
,o
) != 1);
3354 /* Return the number of pages required to save this object in the swap file */
3355 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
3356 off_t bytes
= rdbSavedObjectLen(o
,fp
);
3358 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
3361 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3362 static int rdbSave(char *filename
) {
3363 dictIterator
*di
= NULL
;
3368 time_t now
= time(NULL
);
3370 /* Wait for I/O therads to terminate, just in case this is a
3371 * foreground-saving, to avoid seeking the swap file descriptor at the
3373 if (server
.vm_enabled
)
3374 waitEmptyIOJobsQueue();
3376 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3377 fp
= fopen(tmpfile
,"w");
3379 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3382 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3383 for (j
= 0; j
< server
.dbnum
; j
++) {
3384 redisDb
*db
= server
.db
+j
;
3386 if (dictSize(d
) == 0) continue;
3387 di
= dictGetIterator(d
);
3393 /* Write the SELECT DB opcode */
3394 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3395 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3397 /* Iterate this DB writing every entry */
3398 while((de
= dictNext(di
)) != NULL
) {
3399 robj
*key
= dictGetEntryKey(de
);
3400 robj
*o
= dictGetEntryVal(de
);
3401 time_t expiretime
= getExpire(db
,key
);
3403 /* Save the expire time */
3404 if (expiretime
!= -1) {
3405 /* If this key is already expired skip it */
3406 if (expiretime
< now
) continue;
3407 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3408 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3410 /* Save the key and associated value. This requires special
3411 * handling if the value is swapped out. */
3412 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
3413 key
->storage
== REDIS_VM_SWAPPING
) {
3414 /* Save type, key, value */
3415 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3416 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3417 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3419 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3421 /* Get a preview of the object in memory */
3422 po
= vmPreviewObject(key
);
3423 /* Save type, key, value */
3424 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
3425 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3426 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3427 /* Remove the loaded object from memory */
3431 dictReleaseIterator(di
);
3434 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3436 /* Make sure data will not remain on the OS's output buffers */
3441 /* Use RENAME to make sure the DB file is changed atomically only
3442 * if the generate DB file is ok. */
3443 if (rename(tmpfile
,filename
) == -1) {
3444 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3448 redisLog(REDIS_NOTICE
,"DB saved on disk");
3450 server
.lastsave
= time(NULL
);
3456 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3457 if (di
) dictReleaseIterator(di
);
3461 static int rdbSaveBackground(char *filename
) {
3464 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3465 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
3466 if ((childpid
= fork()) == 0) {
3468 if (server
.vm_enabled
) vmReopenSwapFile();
3470 if (rdbSave(filename
) == REDIS_OK
) {
3477 if (childpid
== -1) {
3478 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3482 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3483 server
.bgsavechildpid
= childpid
;
3486 return REDIS_OK
; /* unreached */
3489 static void rdbRemoveTempFile(pid_t childpid
) {
3492 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
3496 static int rdbLoadType(FILE *fp
) {
3498 if (fread(&type
,1,1,fp
) == 0) return -1;
3502 static time_t rdbLoadTime(FILE *fp
) {
3504 if (fread(&t32
,4,1,fp
) == 0) return -1;
3505 return (time_t) t32
;
3508 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3509 * of this file for a description of how this are stored on disk.
3511 * isencoded is set to 1 if the readed length is not actually a length but
3512 * an "encoding type", check the above comments for more info */
3513 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3514 unsigned char buf
[2];
3518 if (isencoded
) *isencoded
= 0;
3519 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3520 type
= (buf
[0]&0xC0)>>6;
3521 if (type
== REDIS_RDB_6BITLEN
) {
3522 /* Read a 6 bit len */
3524 } else if (type
== REDIS_RDB_ENCVAL
) {
3525 /* Read a 6 bit len encoding type */
3526 if (isencoded
) *isencoded
= 1;
3528 } else if (type
== REDIS_RDB_14BITLEN
) {
3529 /* Read a 14 bit len */
3530 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3531 return ((buf
[0]&0x3F)<<8)|buf
[1];
3533 /* Read a 32 bit len */
3534 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3539 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
) {
3540 unsigned char enc
[4];
3543 if (enctype
== REDIS_RDB_ENC_INT8
) {
3544 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3545 val
= (signed char)enc
[0];
3546 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3548 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3549 v
= enc
[0]|(enc
[1]<<8);
3551 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3553 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3554 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3557 val
= 0; /* anti-warning */
3560 return createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",val
));
3563 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3564 unsigned int len
, clen
;
3565 unsigned char *c
= NULL
;
3568 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3569 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3570 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3571 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3572 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3573 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3575 return createObject(REDIS_STRING
,val
);
3582 static robj
*rdbLoadStringObject(FILE*fp
) {
3587 len
= rdbLoadLen(fp
,&isencoded
);
3590 case REDIS_RDB_ENC_INT8
:
3591 case REDIS_RDB_ENC_INT16
:
3592 case REDIS_RDB_ENC_INT32
:
3593 return tryObjectSharing(rdbLoadIntegerObject(fp
,len
));
3594 case REDIS_RDB_ENC_LZF
:
3595 return tryObjectSharing(rdbLoadLzfStringObject(fp
));
3601 if (len
== REDIS_RDB_LENERR
) return NULL
;
3602 val
= sdsnewlen(NULL
,len
);
3603 if (len
&& fread(val
,len
,1,fp
) == 0) {
3607 return tryObjectSharing(createObject(REDIS_STRING
,val
));
3610 /* For information about double serialization check rdbSaveDoubleValue() */
3611 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
3615 if (fread(&len
,1,1,fp
) == 0) return -1;
3617 case 255: *val
= R_NegInf
; return 0;
3618 case 254: *val
= R_PosInf
; return 0;
3619 case 253: *val
= R_Nan
; return 0;
3621 if (fread(buf
,len
,1,fp
) == 0) return -1;
3623 sscanf(buf
, "%lg", val
);
3628 /* Load a Redis object of the specified type from the specified file.
3629 * On success a newly allocated object is returned, otherwise NULL. */
3630 static robj
*rdbLoadObject(int type
, FILE *fp
) {
3633 redisLog(REDIS_DEBUG
,"LOADING OBJECT %d (at %d)\n",type
,ftell(fp
));
3634 if (type
== REDIS_STRING
) {
3635 /* Read string value */
3636 if ((o
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3637 tryObjectEncoding(o
);
3638 } else if (type
== REDIS_LIST
|| type
== REDIS_SET
) {
3639 /* Read list/set value */
3642 if ((listlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3643 o
= (type
== REDIS_LIST
) ? createListObject() : createSetObject();
3644 /* It's faster to expand the dict to the right size asap in order
3645 * to avoid rehashing */
3646 if (type
== REDIS_SET
&& listlen
> DICT_HT_INITIAL_SIZE
)
3647 dictExpand(o
->ptr
,listlen
);
3648 /* Load every single element of the list/set */
3652 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3653 tryObjectEncoding(ele
);
3654 if (type
== REDIS_LIST
) {
3655 listAddNodeTail((list
*)o
->ptr
,ele
);
3657 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
3660 } else if (type
== REDIS_ZSET
) {
3661 /* Read list/set value */
3665 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3666 o
= createZsetObject();
3668 /* Load every single element of the list/set */
3671 double *score
= zmalloc(sizeof(double));
3673 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3674 tryObjectEncoding(ele
);
3675 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
3676 dictAdd(zs
->dict
,ele
,score
);
3677 zslInsert(zs
->zsl
,*score
,ele
);
3678 incrRefCount(ele
); /* added to skiplist */
3680 } else if (type
== REDIS_HASH
) {
3683 if ((hashlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3684 o
= createHashObject();
3685 /* Too many entries? Use an hash table. */
3686 if (hashlen
> server
.hash_max_zipmap_entries
)
3687 convertToRealHash(o
);
3688 /* Load every key/value, then set it into the zipmap or hash
3689 * table, as needed. */
3693 if ((key
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3694 if ((val
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3695 /* If we are using a zipmap and there are too big values
3696 * the object is converted to real hash table encoding. */
3697 if (o
->encoding
!= REDIS_ENCODING_HT
&&
3698 (sdslen(key
->ptr
) > server
.hash_max_zipmap_value
||
3699 sdslen(val
->ptr
) > server
.hash_max_zipmap_value
))
3701 convertToRealHash(o
);
3704 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3705 unsigned char *zm
= o
->ptr
;
3707 zm
= zipmapSet(zm
,key
->ptr
,sdslen(key
->ptr
),
3708 val
->ptr
,sdslen(val
->ptr
),NULL
);
3713 tryObjectEncoding(key
);
3714 tryObjectEncoding(val
);
3715 dictAdd((dict
*)o
->ptr
,key
,val
);
3724 static int rdbLoad(char *filename
) {
3726 robj
*keyobj
= NULL
;
3728 int type
, retval
, rdbver
;
3729 dict
*d
= server
.db
[0].dict
;
3730 redisDb
*db
= server
.db
+0;
3732 time_t expiretime
= -1, now
= time(NULL
);
3733 long long loadedkeys
= 0;
3735 fp
= fopen(filename
,"r");
3736 if (!fp
) return REDIS_ERR
;
3737 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
3739 if (memcmp(buf
,"REDIS",5) != 0) {
3741 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
3744 rdbver
= atoi(buf
+5);
3747 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
3754 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3755 if (type
== REDIS_EXPIRETIME
) {
3756 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
3757 /* We read the time so we need to read the object type again */
3758 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3760 if (type
== REDIS_EOF
) break;
3761 /* Handle SELECT DB opcode as a special case */
3762 if (type
== REDIS_SELECTDB
) {
3763 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
3765 if (dbid
>= (unsigned)server
.dbnum
) {
3766 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
3769 db
= server
.db
+dbid
;
3774 if ((keyobj
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
3776 if ((o
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
3777 /* Add the new object in the hash table */
3778 retval
= dictAdd(d
,keyobj
,o
);
3779 if (retval
== DICT_ERR
) {
3780 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", keyobj
->ptr
);
3783 /* Set the expire time if needed */
3784 if (expiretime
!= -1) {
3785 setExpire(db
,keyobj
,expiretime
);
3786 /* Delete this key if already expired */
3787 if (expiretime
< now
) deleteKey(db
,keyobj
);
3791 /* Handle swapping while loading big datasets when VM is on */
3793 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
3794 while (zmalloc_used_memory() > server
.vm_max_memory
) {
3795 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
3802 eoferr
: /* unexpected end of file is handled here with a fatal exit */
3803 if (keyobj
) decrRefCount(keyobj
);
3804 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
3806 return REDIS_ERR
; /* Just to avoid warning */
3809 /*================================== Commands =============================== */
3811 static void authCommand(redisClient
*c
) {
3812 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
3813 c
->authenticated
= 1;
3814 addReply(c
,shared
.ok
);
3816 c
->authenticated
= 0;
3817 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
3821 static void pingCommand(redisClient
*c
) {
3822 addReply(c
,shared
.pong
);
3825 static void echoCommand(redisClient
*c
) {
3826 addReplyBulk(c
,c
->argv
[1]);
3829 /*=================================== Strings =============================== */
3831 static void setGenericCommand(redisClient
*c
, int nx
) {
3834 if (nx
) deleteIfVolatile(c
->db
,c
->argv
[1]);
3835 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3836 if (retval
== DICT_ERR
) {
3838 /* If the key is about a swapped value, we want a new key object
3839 * to overwrite the old. So we delete the old key in the database.
3840 * This will also make sure that swap pages about the old object
3841 * will be marked as free. */
3842 if (server
.vm_enabled
&& deleteIfSwapped(c
->db
,c
->argv
[1]))
3843 incrRefCount(c
->argv
[1]);
3844 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3845 incrRefCount(c
->argv
[2]);
3847 addReply(c
,shared
.czero
);
3851 incrRefCount(c
->argv
[1]);
3852 incrRefCount(c
->argv
[2]);
3855 removeExpire(c
->db
,c
->argv
[1]);
3856 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3859 static void setCommand(redisClient
*c
) {
3860 setGenericCommand(c
,0);
3863 static void setnxCommand(redisClient
*c
) {
3864 setGenericCommand(c
,1);
3867 static int getGenericCommand(redisClient
*c
) {
3870 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
)
3873 if (o
->type
!= REDIS_STRING
) {
3874 addReply(c
,shared
.wrongtypeerr
);
3882 static void getCommand(redisClient
*c
) {
3883 getGenericCommand(c
);
3886 static void getsetCommand(redisClient
*c
) {
3887 if (getGenericCommand(c
) == REDIS_ERR
) return;
3888 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
3889 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3891 incrRefCount(c
->argv
[1]);
3893 incrRefCount(c
->argv
[2]);
3895 removeExpire(c
->db
,c
->argv
[1]);
3898 static void mgetCommand(redisClient
*c
) {
3901 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
3902 for (j
= 1; j
< c
->argc
; j
++) {
3903 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
3905 addReply(c
,shared
.nullbulk
);
3907 if (o
->type
!= REDIS_STRING
) {
3908 addReply(c
,shared
.nullbulk
);
3916 static void msetGenericCommand(redisClient
*c
, int nx
) {
3917 int j
, busykeys
= 0;
3919 if ((c
->argc
% 2) == 0) {
3920 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
3923 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
3924 * set nothing at all if at least one already key exists. */
3926 for (j
= 1; j
< c
->argc
; j
+= 2) {
3927 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
3933 addReply(c
, shared
.czero
);
3937 for (j
= 1; j
< c
->argc
; j
+= 2) {
3940 tryObjectEncoding(c
->argv
[j
+1]);
3941 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3942 if (retval
== DICT_ERR
) {
3943 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3944 incrRefCount(c
->argv
[j
+1]);
3946 incrRefCount(c
->argv
[j
]);
3947 incrRefCount(c
->argv
[j
+1]);
3949 removeExpire(c
->db
,c
->argv
[j
]);
3951 server
.dirty
+= (c
->argc
-1)/2;
3952 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3955 static void msetCommand(redisClient
*c
) {
3956 msetGenericCommand(c
,0);
3959 static void msetnxCommand(redisClient
*c
) {
3960 msetGenericCommand(c
,1);
3963 static void incrDecrCommand(redisClient
*c
, long long incr
) {
3968 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3972 if (o
->type
!= REDIS_STRING
) {
3977 if (o
->encoding
== REDIS_ENCODING_RAW
)
3978 value
= strtoll(o
->ptr
, &eptr
, 10);
3979 else if (o
->encoding
== REDIS_ENCODING_INT
)
3980 value
= (long)o
->ptr
;
3982 redisAssert(1 != 1);
3987 o
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
3988 tryObjectEncoding(o
);
3989 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
3990 if (retval
== DICT_ERR
) {
3991 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
3992 removeExpire(c
->db
,c
->argv
[1]);
3994 incrRefCount(c
->argv
[1]);
3997 addReply(c
,shared
.colon
);
3999 addReply(c
,shared
.crlf
);
4002 static void incrCommand(redisClient
*c
) {
4003 incrDecrCommand(c
,1);
4006 static void decrCommand(redisClient
*c
) {
4007 incrDecrCommand(c
,-1);
4010 static void incrbyCommand(redisClient
*c
) {
4011 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
4012 incrDecrCommand(c
,incr
);
4015 static void decrbyCommand(redisClient
*c
) {
4016 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
4017 incrDecrCommand(c
,-incr
);
4020 static void appendCommand(redisClient
*c
) {
4025 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4027 /* Create the key */
4028 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4029 incrRefCount(c
->argv
[1]);
4030 incrRefCount(c
->argv
[2]);
4031 totlen
= stringObjectLen(c
->argv
[2]);
4035 de
= dictFind(c
->db
->dict
,c
->argv
[1]);
4038 o
= dictGetEntryVal(de
);
4039 if (o
->type
!= REDIS_STRING
) {
4040 addReply(c
,shared
.wrongtypeerr
);
4043 /* If the object is specially encoded or shared we have to make
4045 if (o
->refcount
!= 1 || o
->encoding
!= REDIS_ENCODING_RAW
) {
4046 robj
*decoded
= getDecodedObject(o
);
4048 o
= createStringObject(decoded
->ptr
, sdslen(decoded
->ptr
));
4049 decrRefCount(decoded
);
4050 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4053 if (c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
) {
4054 o
->ptr
= sdscatlen(o
->ptr
,
4055 c
->argv
[2]->ptr
, sdslen(c
->argv
[2]->ptr
));
4057 o
->ptr
= sdscatprintf(o
->ptr
, "%ld",
4058 (unsigned long) c
->argv
[2]->ptr
);
4060 totlen
= sdslen(o
->ptr
);
4063 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen
));
4066 static void substrCommand(redisClient
*c
) {
4068 long start
= atoi(c
->argv
[2]->ptr
);
4069 long end
= atoi(c
->argv
[3]->ptr
);
4070 size_t rangelen
, strlen
;
4073 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4074 checkType(c
,o
,REDIS_STRING
)) return;
4076 o
= getDecodedObject(o
);
4077 strlen
= sdslen(o
->ptr
);
4079 /* convert negative indexes */
4080 if (start
< 0) start
= strlen
+start
;
4081 if (end
< 0) end
= strlen
+end
;
4082 if (start
< 0) start
= 0;
4083 if (end
< 0) end
= 0;
4085 /* indexes sanity checks */
4086 if (start
> end
|| (size_t)start
>= strlen
) {
4087 /* Out of range start or start > end result in null reply */
4088 addReply(c
,shared
.nullbulk
);
4092 if ((size_t)end
>= strlen
) end
= strlen
-1;
4093 rangelen
= (end
-start
)+1;
4095 /* Return the result */
4096 addReplySds(c
,sdscatprintf(sdsempty(),"$%zu\r\n",rangelen
));
4097 range
= sdsnewlen((char*)o
->ptr
+start
,rangelen
);
4098 addReplySds(c
,range
);
4099 addReply(c
,shared
.crlf
);
4103 /* ========================= Type agnostic commands ========================= */
4105 static void delCommand(redisClient
*c
) {
4108 for (j
= 1; j
< c
->argc
; j
++) {
4109 if (deleteKey(c
->db
,c
->argv
[j
])) {
4114 addReplyLong(c
,deleted
);
4117 static void existsCommand(redisClient
*c
) {
4118 addReply(c
,lookupKeyRead(c
->db
,c
->argv
[1]) ? shared
.cone
: shared
.czero
);
4121 static void selectCommand(redisClient
*c
) {
4122 int id
= atoi(c
->argv
[1]->ptr
);
4124 if (selectDb(c
,id
) == REDIS_ERR
) {
4125 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
4127 addReply(c
,shared
.ok
);
4131 static void randomkeyCommand(redisClient
*c
) {
4135 de
= dictGetRandomKey(c
->db
->dict
);
4136 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
4139 addReply(c
,shared
.plus
);
4140 addReply(c
,shared
.crlf
);
4142 addReply(c
,shared
.plus
);
4143 addReply(c
,dictGetEntryKey(de
));
4144 addReply(c
,shared
.crlf
);
4148 static void keysCommand(redisClient
*c
) {
4151 sds pattern
= c
->argv
[1]->ptr
;
4152 int plen
= sdslen(pattern
);
4153 unsigned long numkeys
= 0;
4154 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
4156 di
= dictGetIterator(c
->db
->dict
);
4158 decrRefCount(lenobj
);
4159 while((de
= dictNext(di
)) != NULL
) {
4160 robj
*keyobj
= dictGetEntryKey(de
);
4162 sds key
= keyobj
->ptr
;
4163 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
4164 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
4165 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
4166 addReplyBulk(c
,keyobj
);
4171 dictReleaseIterator(di
);
4172 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",numkeys
);
4175 static void dbsizeCommand(redisClient
*c
) {
4177 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
4180 static void lastsaveCommand(redisClient
*c
) {
4182 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
4185 static void typeCommand(redisClient
*c
) {
4189 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4194 case REDIS_STRING
: type
= "+string"; break;
4195 case REDIS_LIST
: type
= "+list"; break;
4196 case REDIS_SET
: type
= "+set"; break;
4197 case REDIS_ZSET
: type
= "+zset"; break;
4198 case REDIS_HASH
: type
= "+hash"; break;
4199 default: type
= "+unknown"; break;
4202 addReplySds(c
,sdsnew(type
));
4203 addReply(c
,shared
.crlf
);
4206 static void saveCommand(redisClient
*c
) {
4207 if (server
.bgsavechildpid
!= -1) {
4208 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
4211 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4212 addReply(c
,shared
.ok
);
4214 addReply(c
,shared
.err
);
4218 static void bgsaveCommand(redisClient
*c
) {
4219 if (server
.bgsavechildpid
!= -1) {
4220 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
4223 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
4224 char *status
= "+Background saving started\r\n";
4225 addReplySds(c
,sdsnew(status
));
4227 addReply(c
,shared
.err
);
4231 static void shutdownCommand(redisClient
*c
) {
4232 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
4233 /* Kill the saving child if there is a background saving in progress.
4234 We want to avoid race conditions, for instance our saving child may
4235 overwrite the synchronous saving did by SHUTDOWN. */
4236 if (server
.bgsavechildpid
!= -1) {
4237 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
4238 kill(server
.bgsavechildpid
,SIGKILL
);
4239 rdbRemoveTempFile(server
.bgsavechildpid
);
4241 if (server
.appendonly
) {
4242 /* Append only file: fsync() the AOF and exit */
4243 fsync(server
.appendfd
);
4244 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4247 /* Snapshotting. Perform a SYNC SAVE and exit */
4248 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4249 if (server
.daemonize
)
4250 unlink(server
.pidfile
);
4251 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
4252 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
4253 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4256 /* Ooops.. error saving! The best we can do is to continue
4257 * operating. Note that if there was a background saving process,
4258 * in the next cron() Redis will be notified that the background
4259 * saving aborted, handling special stuff like slaves pending for
4260 * synchronization... */
4261 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
4263 sdsnew("-ERR can't quit, problems saving the DB\r\n"));
4268 static void renameGenericCommand(redisClient
*c
, int nx
) {
4271 /* To use the same key as src and dst is probably an error */
4272 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
4273 addReply(c
,shared
.sameobjecterr
);
4277 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
)
4281 deleteIfVolatile(c
->db
,c
->argv
[2]);
4282 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
4285 addReply(c
,shared
.czero
);
4288 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
4290 incrRefCount(c
->argv
[2]);
4292 deleteKey(c
->db
,c
->argv
[1]);
4294 addReply(c
,nx
? shared
.cone
: shared
.ok
);
4297 static void renameCommand(redisClient
*c
) {
4298 renameGenericCommand(c
,0);
4301 static void renamenxCommand(redisClient
*c
) {
4302 renameGenericCommand(c
,1);
4305 static void moveCommand(redisClient
*c
) {
4310 /* Obtain source and target DB pointers */
4313 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
4314 addReply(c
,shared
.outofrangeerr
);
4318 selectDb(c
,srcid
); /* Back to the source DB */
4320 /* If the user is moving using as target the same
4321 * DB as the source DB it is probably an error. */
4323 addReply(c
,shared
.sameobjecterr
);
4327 /* Check if the element exists and get a reference */
4328 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4330 addReply(c
,shared
.czero
);
4334 /* Try to add the element to the target DB */
4335 deleteIfVolatile(dst
,c
->argv
[1]);
4336 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
4337 addReply(c
,shared
.czero
);
4340 incrRefCount(c
->argv
[1]);
4343 /* OK! key moved, free the entry in the source DB */
4344 deleteKey(src
,c
->argv
[1]);
4346 addReply(c
,shared
.cone
);
4349 /* =================================== Lists ================================ */
4350 static void pushGenericCommand(redisClient
*c
, int where
) {
4354 lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4356 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4357 addReply(c
,shared
.cone
);
4360 lobj
= createListObject();
4362 if (where
== REDIS_HEAD
) {
4363 listAddNodeHead(list
,c
->argv
[2]);
4365 listAddNodeTail(list
,c
->argv
[2]);
4367 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
4368 incrRefCount(c
->argv
[1]);
4369 incrRefCount(c
->argv
[2]);
4371 if (lobj
->type
!= REDIS_LIST
) {
4372 addReply(c
,shared
.wrongtypeerr
);
4375 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4376 addReply(c
,shared
.cone
);
4380 if (where
== REDIS_HEAD
) {
4381 listAddNodeHead(list
,c
->argv
[2]);
4383 listAddNodeTail(list
,c
->argv
[2]);
4385 incrRefCount(c
->argv
[2]);
4388 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",listLength(list
)));
4391 static void lpushCommand(redisClient
*c
) {
4392 pushGenericCommand(c
,REDIS_HEAD
);
4395 static void rpushCommand(redisClient
*c
) {
4396 pushGenericCommand(c
,REDIS_TAIL
);
4399 static void llenCommand(redisClient
*c
) {
4403 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4404 checkType(c
,o
,REDIS_LIST
)) return;
4407 addReplyUlong(c
,listLength(l
));
4410 static void lindexCommand(redisClient
*c
) {
4412 int index
= atoi(c
->argv
[2]->ptr
);
4416 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4417 checkType(c
,o
,REDIS_LIST
)) return;
4420 ln
= listIndex(list
, index
);
4422 addReply(c
,shared
.nullbulk
);
4424 robj
*ele
= listNodeValue(ln
);
4425 addReplyBulk(c
,ele
);
4429 static void lsetCommand(redisClient
*c
) {
4431 int index
= atoi(c
->argv
[2]->ptr
);
4435 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
||
4436 checkType(c
,o
,REDIS_LIST
)) return;
4439 ln
= listIndex(list
, index
);
4441 addReply(c
,shared
.outofrangeerr
);
4443 robj
*ele
= listNodeValue(ln
);
4446 listNodeValue(ln
) = c
->argv
[3];
4447 incrRefCount(c
->argv
[3]);
4448 addReply(c
,shared
.ok
);
4453 static void popGenericCommand(redisClient
*c
, int where
) {
4458 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4459 checkType(c
,o
,REDIS_LIST
)) return;
4462 if (where
== REDIS_HEAD
)
4463 ln
= listFirst(list
);
4465 ln
= listLast(list
);
4468 addReply(c
,shared
.nullbulk
);
4470 robj
*ele
= listNodeValue(ln
);
4471 addReplyBulk(c
,ele
);
4472 listDelNode(list
,ln
);
4473 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4478 static void lpopCommand(redisClient
*c
) {
4479 popGenericCommand(c
,REDIS_HEAD
);
4482 static void rpopCommand(redisClient
*c
) {
4483 popGenericCommand(c
,REDIS_TAIL
);
4486 static void lrangeCommand(redisClient
*c
) {
4488 int start
= atoi(c
->argv
[2]->ptr
);
4489 int end
= atoi(c
->argv
[3]->ptr
);
4496 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullmultibulk
)) == NULL
||
4497 checkType(c
,o
,REDIS_LIST
)) return;
4499 llen
= listLength(list
);
4501 /* convert negative indexes */
4502 if (start
< 0) start
= llen
+start
;
4503 if (end
< 0) end
= llen
+end
;
4504 if (start
< 0) start
= 0;
4505 if (end
< 0) end
= 0;
4507 /* indexes sanity checks */
4508 if (start
> end
|| start
>= llen
) {
4509 /* Out of range start or start > end result in empty list */
4510 addReply(c
,shared
.emptymultibulk
);
4513 if (end
>= llen
) end
= llen
-1;
4514 rangelen
= (end
-start
)+1;
4516 /* Return the result in form of a multi-bulk reply */
4517 ln
= listIndex(list
, start
);
4518 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
4519 for (j
= 0; j
< rangelen
; j
++) {
4520 ele
= listNodeValue(ln
);
4521 addReplyBulk(c
,ele
);
4526 static void ltrimCommand(redisClient
*c
) {
4528 int start
= atoi(c
->argv
[2]->ptr
);
4529 int end
= atoi(c
->argv
[3]->ptr
);
4531 int j
, ltrim
, rtrim
;
4535 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.ok
)) == NULL
||
4536 checkType(c
,o
,REDIS_LIST
)) return;
4538 llen
= listLength(list
);
4540 /* convert negative indexes */
4541 if (start
< 0) start
= llen
+start
;
4542 if (end
< 0) end
= llen
+end
;
4543 if (start
< 0) start
= 0;
4544 if (end
< 0) end
= 0;
4546 /* indexes sanity checks */
4547 if (start
> end
|| start
>= llen
) {
4548 /* Out of range start or start > end result in empty list */
4552 if (end
>= llen
) end
= llen
-1;
4557 /* Remove list elements to perform the trim */
4558 for (j
= 0; j
< ltrim
; j
++) {
4559 ln
= listFirst(list
);
4560 listDelNode(list
,ln
);
4562 for (j
= 0; j
< rtrim
; j
++) {
4563 ln
= listLast(list
);
4564 listDelNode(list
,ln
);
4566 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4568 addReply(c
,shared
.ok
);
4571 static void lremCommand(redisClient
*c
) {
4574 listNode
*ln
, *next
;
4575 int toremove
= atoi(c
->argv
[2]->ptr
);
4579 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4580 checkType(c
,o
,REDIS_LIST
)) return;
4584 toremove
= -toremove
;
4587 ln
= fromtail
? list
->tail
: list
->head
;
4589 robj
*ele
= listNodeValue(ln
);
4591 next
= fromtail
? ln
->prev
: ln
->next
;
4592 if (compareStringObjects(ele
,c
->argv
[3]) == 0) {
4593 listDelNode(list
,ln
);
4596 if (toremove
&& removed
== toremove
) break;
4600 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4601 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
4604 /* This is the semantic of this command:
4605 * RPOPLPUSH srclist dstlist:
4606 * IF LLEN(srclist) > 0
4607 * element = RPOP srclist
4608 * LPUSH dstlist element
4615 * The idea is to be able to get an element from a list in a reliable way
4616 * since the element is not just returned but pushed against another list
4617 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4619 static void rpoplpushcommand(redisClient
*c
) {
4624 if ((sobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4625 checkType(c
,sobj
,REDIS_LIST
)) return;
4626 srclist
= sobj
->ptr
;
4627 ln
= listLast(srclist
);
4630 addReply(c
,shared
.nullbulk
);
4632 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4633 robj
*ele
= listNodeValue(ln
);
4636 if (dobj
&& dobj
->type
!= REDIS_LIST
) {
4637 addReply(c
,shared
.wrongtypeerr
);
4641 /* Add the element to the target list (unless it's directly
4642 * passed to some BLPOP-ing client */
4643 if (!handleClientsWaitingListPush(c
,c
->argv
[2],ele
)) {
4645 /* Create the list if the key does not exist */
4646 dobj
= createListObject();
4647 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
4648 incrRefCount(c
->argv
[2]);
4650 dstlist
= dobj
->ptr
;
4651 listAddNodeHead(dstlist
,ele
);
4655 /* Send the element to the client as reply as well */
4656 addReplyBulk(c
,ele
);
4658 /* Finally remove the element from the source list */
4659 listDelNode(srclist
,ln
);
4660 if (listLength(srclist
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4665 /* ==================================== Sets ================================ */
4667 static void saddCommand(redisClient
*c
) {
4670 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4672 set
= createSetObject();
4673 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
4674 incrRefCount(c
->argv
[1]);
4676 if (set
->type
!= REDIS_SET
) {
4677 addReply(c
,shared
.wrongtypeerr
);
4681 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
4682 incrRefCount(c
->argv
[2]);
4684 addReply(c
,shared
.cone
);
4686 addReply(c
,shared
.czero
);
4690 static void sremCommand(redisClient
*c
) {
4693 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4694 checkType(c
,set
,REDIS_SET
)) return;
4696 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
4698 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4699 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4700 addReply(c
,shared
.cone
);
4702 addReply(c
,shared
.czero
);
4706 static void smoveCommand(redisClient
*c
) {
4707 robj
*srcset
, *dstset
;
4709 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4710 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4712 /* If the source key does not exist return 0, if it's of the wrong type
4714 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
4715 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
4718 /* Error if the destination key is not a set as well */
4719 if (dstset
&& dstset
->type
!= REDIS_SET
) {
4720 addReply(c
,shared
.wrongtypeerr
);
4723 /* Remove the element from the source set */
4724 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
4725 /* Key not found in the src set! return zero */
4726 addReply(c
,shared
.czero
);
4729 if (dictSize((dict
*)srcset
->ptr
) == 0 && srcset
!= dstset
)
4730 deleteKey(c
->db
,c
->argv
[1]);
4732 /* Add the element to the destination set */
4734 dstset
= createSetObject();
4735 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
4736 incrRefCount(c
->argv
[2]);
4738 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
4739 incrRefCount(c
->argv
[3]);
4740 addReply(c
,shared
.cone
);
4743 static void sismemberCommand(redisClient
*c
) {
4746 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4747 checkType(c
,set
,REDIS_SET
)) return;
4749 if (dictFind(set
->ptr
,c
->argv
[2]))
4750 addReply(c
,shared
.cone
);
4752 addReply(c
,shared
.czero
);
4755 static void scardCommand(redisClient
*c
) {
4759 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4760 checkType(c
,o
,REDIS_SET
)) return;
4763 addReplyUlong(c
,dictSize(s
));
4766 static void spopCommand(redisClient
*c
) {
4770 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4771 checkType(c
,set
,REDIS_SET
)) return;
4773 de
= dictGetRandomKey(set
->ptr
);
4775 addReply(c
,shared
.nullbulk
);
4777 robj
*ele
= dictGetEntryKey(de
);
4779 addReplyBulk(c
,ele
);
4780 dictDelete(set
->ptr
,ele
);
4781 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4782 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4787 static void srandmemberCommand(redisClient
*c
) {
4791 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4792 checkType(c
,set
,REDIS_SET
)) return;
4794 de
= dictGetRandomKey(set
->ptr
);
4796 addReply(c
,shared
.nullbulk
);
4798 robj
*ele
= dictGetEntryKey(de
);
4800 addReplyBulk(c
,ele
);
4804 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
4805 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
4807 return dictSize(*d1
)-dictSize(*d2
);
4810 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
4811 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4814 robj
*lenobj
= NULL
, *dstset
= NULL
;
4815 unsigned long j
, cardinality
= 0;
4817 for (j
= 0; j
< setsnum
; j
++) {
4821 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4822 lookupKeyRead(c
->db
,setskeys
[j
]);
4826 if (deleteKey(c
->db
,dstkey
))
4828 addReply(c
,shared
.czero
);
4830 addReply(c
,shared
.nullmultibulk
);
4834 if (setobj
->type
!= REDIS_SET
) {
4836 addReply(c
,shared
.wrongtypeerr
);
4839 dv
[j
] = setobj
->ptr
;
4841 /* Sort sets from the smallest to largest, this will improve our
4842 * algorithm's performace */
4843 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
4845 /* The first thing we should output is the total number of elements...
4846 * since this is a multi-bulk write, but at this stage we don't know
4847 * the intersection set size, so we use a trick, append an empty object
4848 * to the output list and save the pointer to later modify it with the
4851 lenobj
= createObject(REDIS_STRING
,NULL
);
4853 decrRefCount(lenobj
);
4855 /* If we have a target key where to store the resulting set
4856 * create this key with an empty set inside */
4857 dstset
= createSetObject();
4860 /* Iterate all the elements of the first (smallest) set, and test
4861 * the element against all the other sets, if at least one set does
4862 * not include the element it is discarded */
4863 di
= dictGetIterator(dv
[0]);
4865 while((de
= dictNext(di
)) != NULL
) {
4868 for (j
= 1; j
< setsnum
; j
++)
4869 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
4871 continue; /* at least one set does not contain the member */
4872 ele
= dictGetEntryKey(de
);
4874 addReplyBulk(c
,ele
);
4877 dictAdd(dstset
->ptr
,ele
,NULL
);
4881 dictReleaseIterator(di
);
4884 /* Store the resulting set into the target, if the intersection
4885 * is not an empty set. */
4886 deleteKey(c
->db
,dstkey
);
4887 if (dictSize((dict
*)dstset
->ptr
) > 0) {
4888 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4889 incrRefCount(dstkey
);
4890 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
4892 decrRefCount(dstset
);
4893 addReply(c
,shared
.czero
);
4897 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
4902 static void sinterCommand(redisClient
*c
) {
4903 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
4906 static void sinterstoreCommand(redisClient
*c
) {
4907 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
4910 #define REDIS_OP_UNION 0
4911 #define REDIS_OP_DIFF 1
4912 #define REDIS_OP_INTER 2
4914 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
4915 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4918 robj
*dstset
= NULL
;
4919 int j
, cardinality
= 0;
4921 for (j
= 0; j
< setsnum
; j
++) {
4925 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4926 lookupKeyRead(c
->db
,setskeys
[j
]);
4931 if (setobj
->type
!= REDIS_SET
) {
4933 addReply(c
,shared
.wrongtypeerr
);
4936 dv
[j
] = setobj
->ptr
;
4939 /* We need a temp set object to store our union. If the dstkey
4940 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
4941 * this set object will be the resulting object to set into the target key*/
4942 dstset
= createSetObject();
4944 /* Iterate all the elements of all the sets, add every element a single
4945 * time to the result set */
4946 for (j
= 0; j
< setsnum
; j
++) {
4947 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
4948 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
4950 di
= dictGetIterator(dv
[j
]);
4952 while((de
= dictNext(di
)) != NULL
) {
4955 /* dictAdd will not add the same element multiple times */
4956 ele
= dictGetEntryKey(de
);
4957 if (op
== REDIS_OP_UNION
|| j
== 0) {
4958 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
4962 } else if (op
== REDIS_OP_DIFF
) {
4963 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
4968 dictReleaseIterator(di
);
4970 /* result set is empty? Exit asap. */
4971 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break;
4974 /* Output the content of the resulting set, if not in STORE mode */
4976 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
4977 di
= dictGetIterator(dstset
->ptr
);
4978 while((de
= dictNext(di
)) != NULL
) {
4981 ele
= dictGetEntryKey(de
);
4982 addReplyBulk(c
,ele
);
4984 dictReleaseIterator(di
);
4985 decrRefCount(dstset
);
4987 /* If we have a target key where to store the resulting set
4988 * create this key with the result set inside */
4989 deleteKey(c
->db
,dstkey
);
4990 if (dictSize((dict
*)dstset
->ptr
) > 0) {
4991 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4992 incrRefCount(dstkey
);
4993 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
4995 decrRefCount(dstset
);
4996 addReply(c
,shared
.czero
);
5003 static void sunionCommand(redisClient
*c
) {
5004 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
5007 static void sunionstoreCommand(redisClient
*c
) {
5008 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
5011 static void sdiffCommand(redisClient
*c
) {
5012 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
5015 static void sdiffstoreCommand(redisClient
*c
) {
5016 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
5019 /* ==================================== ZSets =============================== */
5021 /* ZSETs are ordered sets using two data structures to hold the same elements
5022 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
5025 * The elements are added to an hash table mapping Redis objects to scores.
5026 * At the same time the elements are added to a skip list mapping scores
5027 * to Redis objects (so objects are sorted by scores in this "view"). */
5029 /* This skiplist implementation is almost a C translation of the original
5030 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
5031 * Alternative to Balanced Trees", modified in three ways:
5032 * a) this implementation allows for repeated values.
5033 * b) the comparison is not just by key (our 'score') but by satellite data.
5034 * c) there is a back pointer, so it's a doubly linked list with the back
5035 * pointers being only at "level 1". This allows to traverse the list
5036 * from tail to head, useful for ZREVRANGE. */
5038 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
5039 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
5041 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
5043 zn
->span
= zmalloc(sizeof(unsigned int) * (level
- 1));
5049 static zskiplist
*zslCreate(void) {
5053 zsl
= zmalloc(sizeof(*zsl
));
5056 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
5057 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++) {
5058 zsl
->header
->forward
[j
] = NULL
;
5060 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
5061 if (j
< ZSKIPLIST_MAXLEVEL
-1)
5062 zsl
->header
->span
[j
] = 0;
5064 zsl
->header
->backward
= NULL
;
5069 static void zslFreeNode(zskiplistNode
*node
) {
5070 decrRefCount(node
->obj
);
5071 zfree(node
->forward
);
5076 static void zslFree(zskiplist
*zsl
) {
5077 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
5079 zfree(zsl
->header
->forward
);
5080 zfree(zsl
->header
->span
);
5083 next
= node
->forward
[0];
5090 static int zslRandomLevel(void) {
5092 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
5097 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
5098 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5099 unsigned int rank
[ZSKIPLIST_MAXLEVEL
];
5103 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5104 /* store rank that is crossed to reach the insert position */
5105 rank
[i
] = i
== (zsl
->level
-1) ? 0 : rank
[i
+1];
5107 while (x
->forward
[i
] &&
5108 (x
->forward
[i
]->score
< score
||
5109 (x
->forward
[i
]->score
== score
&&
5110 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0))) {
5111 rank
[i
] += i
> 0 ? x
->span
[i
-1] : 1;
5116 /* we assume the key is not already inside, since we allow duplicated
5117 * scores, and the re-insertion of score and redis object should never
5118 * happpen since the caller of zslInsert() should test in the hash table
5119 * if the element is already inside or not. */
5120 level
= zslRandomLevel();
5121 if (level
> zsl
->level
) {
5122 for (i
= zsl
->level
; i
< level
; i
++) {
5124 update
[i
] = zsl
->header
;
5125 update
[i
]->span
[i
-1] = zsl
->length
;
5129 x
= zslCreateNode(level
,score
,obj
);
5130 for (i
= 0; i
< level
; i
++) {
5131 x
->forward
[i
] = update
[i
]->forward
[i
];
5132 update
[i
]->forward
[i
] = x
;
5134 /* update span covered by update[i] as x is inserted here */
5136 x
->span
[i
-1] = update
[i
]->span
[i
-1] - (rank
[0] - rank
[i
]);
5137 update
[i
]->span
[i
-1] = (rank
[0] - rank
[i
]) + 1;
5141 /* increment span for untouched levels */
5142 for (i
= level
; i
< zsl
->level
; i
++) {
5143 update
[i
]->span
[i
-1]++;
5146 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
5148 x
->forward
[0]->backward
= x
;
5154 /* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank */
5155 void zslDeleteNode(zskiplist
*zsl
, zskiplistNode
*x
, zskiplistNode
**update
) {
5157 for (i
= 0; i
< zsl
->level
; i
++) {
5158 if (update
[i
]->forward
[i
] == x
) {
5160 update
[i
]->span
[i
-1] += x
->span
[i
-1] - 1;
5162 update
[i
]->forward
[i
] = x
->forward
[i
];
5164 /* invariant: i > 0, because update[0]->forward[0]
5165 * is always equal to x */
5166 update
[i
]->span
[i
-1] -= 1;
5169 if (x
->forward
[0]) {
5170 x
->forward
[0]->backward
= x
->backward
;
5172 zsl
->tail
= x
->backward
;
5174 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
5179 /* Delete an element with matching score/object from the skiplist. */
5180 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
5181 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5185 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5186 while (x
->forward
[i
] &&
5187 (x
->forward
[i
]->score
< score
||
5188 (x
->forward
[i
]->score
== score
&&
5189 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
5193 /* We may have multiple elements with the same score, what we need
5194 * is to find the element with both the right score and object. */
5196 if (x
&& score
== x
->score
&& compareStringObjects(x
->obj
,obj
) == 0) {
5197 zslDeleteNode(zsl
, x
, update
);
5201 return 0; /* not found */
5203 return 0; /* not found */
5206 /* Delete all the elements with score between min and max from the skiplist.
5207 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
5208 * Note that this function takes the reference to the hash table view of the
5209 * sorted set, in order to remove the elements from the hash table too. */
5210 static unsigned long zslDeleteRangeByScore(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
5211 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5212 unsigned long removed
= 0;
5216 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5217 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
5221 /* We may have multiple elements with the same score, what we need
5222 * is to find the element with both the right score and object. */
5224 while (x
&& x
->score
<= max
) {
5225 zskiplistNode
*next
= x
->forward
[0];
5226 zslDeleteNode(zsl
, x
, update
);
5227 dictDelete(dict
,x
->obj
);
5232 return removed
; /* not found */
5235 /* Delete all the elements with rank between start and end from the skiplist.
5236 * Start and end are inclusive. Note that start and end need to be 1-based */
5237 static unsigned long zslDeleteRangeByRank(zskiplist
*zsl
, unsigned int start
, unsigned int end
, dict
*dict
) {
5238 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5239 unsigned long traversed
= 0, removed
= 0;
5243 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5244 while (x
->forward
[i
] && (traversed
+ (i
> 0 ? x
->span
[i
-1] : 1)) < start
) {
5245 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5253 while (x
&& traversed
<= end
) {
5254 zskiplistNode
*next
= x
->forward
[0];
5255 zslDeleteNode(zsl
, x
, update
);
5256 dictDelete(dict
,x
->obj
);
5265 /* Find the first node having a score equal or greater than the specified one.
5266 * Returns NULL if there is no match. */
5267 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
5272 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5273 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
5276 /* We may have multiple elements with the same score, what we need
5277 * is to find the element with both the right score and object. */
5278 return x
->forward
[0];
5281 /* Find the rank for an element by both score and key.
5282 * Returns 0 when the element cannot be found, rank otherwise.
5283 * Note that the rank is 1-based due to the span of zsl->header to the
5285 static unsigned long zslGetRank(zskiplist
*zsl
, double score
, robj
*o
) {
5287 unsigned long rank
= 0;
5291 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5292 while (x
->forward
[i
] &&
5293 (x
->forward
[i
]->score
< score
||
5294 (x
->forward
[i
]->score
== score
&&
5295 compareStringObjects(x
->forward
[i
]->obj
,o
) <= 0))) {
5296 rank
+= i
> 0 ? x
->span
[i
-1] : 1;
5300 /* x might be equal to zsl->header, so test if obj is non-NULL */
5301 if (x
->obj
&& compareStringObjects(x
->obj
,o
) == 0) {
5308 /* Finds an element by its rank. The rank argument needs to be 1-based. */
5309 zskiplistNode
* zslGetElementByRank(zskiplist
*zsl
, unsigned long rank
) {
5311 unsigned long traversed
= 0;
5315 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5316 while (x
->forward
[i
] && (traversed
+ (i
>0 ? x
->span
[i
-1] : 1)) <= rank
)
5318 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5321 if (traversed
== rank
) {
5328 /* The actual Z-commands implementations */
5330 /* This generic command implements both ZADD and ZINCRBY.
5331 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
5332 * the increment if the operation is a ZINCRBY (doincrement == 1). */
5333 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
5338 zsetobj
= lookupKeyWrite(c
->db
,key
);
5339 if (zsetobj
== NULL
) {
5340 zsetobj
= createZsetObject();
5341 dictAdd(c
->db
->dict
,key
,zsetobj
);
5344 if (zsetobj
->type
!= REDIS_ZSET
) {
5345 addReply(c
,shared
.wrongtypeerr
);
5351 /* Ok now since we implement both ZADD and ZINCRBY here the code
5352 * needs to handle the two different conditions. It's all about setting
5353 * '*score', that is, the new score to set, to the right value. */
5354 score
= zmalloc(sizeof(double));
5358 /* Read the old score. If the element was not present starts from 0 */
5359 de
= dictFind(zs
->dict
,ele
);
5361 double *oldscore
= dictGetEntryVal(de
);
5362 *score
= *oldscore
+ scoreval
;
5370 /* What follows is a simple remove and re-insert operation that is common
5371 * to both ZADD and ZINCRBY... */
5372 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
5373 /* case 1: New element */
5374 incrRefCount(ele
); /* added to hash */
5375 zslInsert(zs
->zsl
,*score
,ele
);
5376 incrRefCount(ele
); /* added to skiplist */
5379 addReplyDouble(c
,*score
);
5381 addReply(c
,shared
.cone
);
5386 /* case 2: Score update operation */
5387 de
= dictFind(zs
->dict
,ele
);
5388 redisAssert(de
!= NULL
);
5389 oldscore
= dictGetEntryVal(de
);
5390 if (*score
!= *oldscore
) {
5393 /* Remove and insert the element in the skip list with new score */
5394 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
5395 redisAssert(deleted
!= 0);
5396 zslInsert(zs
->zsl
,*score
,ele
);
5398 /* Update the score in the hash table */
5399 dictReplace(zs
->dict
,ele
,score
);
5405 addReplyDouble(c
,*score
);
5407 addReply(c
,shared
.czero
);
5411 static void zaddCommand(redisClient
*c
) {
5414 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
5415 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
5418 static void zincrbyCommand(redisClient
*c
) {
5421 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
5422 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
5425 static void zremCommand(redisClient
*c
) {
5432 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5433 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5436 de
= dictFind(zs
->dict
,c
->argv
[2]);
5438 addReply(c
,shared
.czero
);
5441 /* Delete from the skiplist */
5442 oldscore
= dictGetEntryVal(de
);
5443 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
5444 redisAssert(deleted
!= 0);
5446 /* Delete from the hash table */
5447 dictDelete(zs
->dict
,c
->argv
[2]);
5448 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5449 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5451 addReply(c
,shared
.cone
);
5454 static void zremrangebyscoreCommand(redisClient
*c
) {
5455 double min
= strtod(c
->argv
[2]->ptr
,NULL
);
5456 double max
= strtod(c
->argv
[3]->ptr
,NULL
);
5461 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5462 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5465 deleted
= zslDeleteRangeByScore(zs
->zsl
,min
,max
,zs
->dict
);
5466 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5467 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5468 server
.dirty
+= deleted
;
5469 addReplyLong(c
,deleted
);
5472 static void zremrangebyrankCommand(redisClient
*c
) {
5473 int start
= atoi(c
->argv
[2]->ptr
);
5474 int end
= atoi(c
->argv
[3]->ptr
);
5480 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5481 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5483 llen
= zs
->zsl
->length
;
5485 /* convert negative indexes */
5486 if (start
< 0) start
= llen
+start
;
5487 if (end
< 0) end
= llen
+end
;
5488 if (start
< 0) start
= 0;
5489 if (end
< 0) end
= 0;
5491 /* indexes sanity checks */
5492 if (start
> end
|| start
>= llen
) {
5493 addReply(c
,shared
.czero
);
5496 if (end
>= llen
) end
= llen
-1;
5498 /* increment start and end because zsl*Rank functions
5499 * use 1-based rank */
5500 deleted
= zslDeleteRangeByRank(zs
->zsl
,start
+1,end
+1,zs
->dict
);
5501 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5502 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5503 server
.dirty
+= deleted
;
5504 addReplyLong(c
, deleted
);
5512 static int qsortCompareZsetopsrcByCardinality(const void *s1
, const void *s2
) {
5513 zsetopsrc
*d1
= (void*) s1
, *d2
= (void*) s2
;
5514 unsigned long size1
, size2
;
5515 size1
= d1
->dict
? dictSize(d1
->dict
) : 0;
5516 size2
= d2
->dict
? dictSize(d2
->dict
) : 0;
5517 return size1
- size2
;
5520 #define REDIS_AGGR_SUM 1
5521 #define REDIS_AGGR_MIN 2
5522 #define REDIS_AGGR_MAX 3
5524 inline static void zunionInterAggregate(double *target
, double val
, int aggregate
) {
5525 if (aggregate
== REDIS_AGGR_SUM
) {
5526 *target
= *target
+ val
;
5527 } else if (aggregate
== REDIS_AGGR_MIN
) {
5528 *target
= val
< *target
? val
: *target
;
5529 } else if (aggregate
== REDIS_AGGR_MAX
) {
5530 *target
= val
> *target
? val
: *target
;
5533 redisAssert(0 != 0);
5537 static void zunionInterGenericCommand(redisClient
*c
, robj
*dstkey
, int op
) {
5539 int aggregate
= REDIS_AGGR_SUM
;
5546 /* expect zsetnum input keys to be given */
5547 zsetnum
= atoi(c
->argv
[2]->ptr
);
5549 addReplySds(c
,sdsnew("-ERR at least 1 input key is needed for ZUNION/ZINTER\r\n"));
5553 /* test if the expected number of keys would overflow */
5554 if (3+zsetnum
> c
->argc
) {
5555 addReply(c
,shared
.syntaxerr
);
5559 /* read keys to be used for input */
5560 src
= zmalloc(sizeof(zsetopsrc
) * zsetnum
);
5561 for (i
= 0, j
= 3; i
< zsetnum
; i
++, j
++) {
5562 robj
*zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
5566 if (zsetobj
->type
!= REDIS_ZSET
) {
5568 addReply(c
,shared
.wrongtypeerr
);
5571 src
[i
].dict
= ((zset
*)zsetobj
->ptr
)->dict
;
5574 /* default all weights to 1 */
5575 src
[i
].weight
= 1.0;
5578 /* parse optional extra arguments */
5580 int remaining
= c
->argc
- j
;
5583 if (remaining
>= (zsetnum
+ 1) && !strcasecmp(c
->argv
[j
]->ptr
,"weights")) {
5585 for (i
= 0; i
< zsetnum
; i
++, j
++, remaining
--) {
5586 src
[i
].weight
= strtod(c
->argv
[j
]->ptr
, NULL
);
5588 } else if (remaining
>= 2 && !strcasecmp(c
->argv
[j
]->ptr
,"aggregate")) {
5590 if (!strcasecmp(c
->argv
[j
]->ptr
,"sum")) {
5591 aggregate
= REDIS_AGGR_SUM
;
5592 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"min")) {
5593 aggregate
= REDIS_AGGR_MIN
;
5594 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"max")) {
5595 aggregate
= REDIS_AGGR_MAX
;
5598 addReply(c
,shared
.syntaxerr
);
5604 addReply(c
,shared
.syntaxerr
);
5610 /* sort sets from the smallest to largest, this will improve our
5611 * algorithm's performance */
5612 qsort(src
,zsetnum
,sizeof(zsetopsrc
), qsortCompareZsetopsrcByCardinality
);
5614 dstobj
= createZsetObject();
5615 dstzset
= dstobj
->ptr
;
5617 if (op
== REDIS_OP_INTER
) {
5618 /* skip going over all entries if the smallest zset is NULL or empty */
5619 if (src
[0].dict
&& dictSize(src
[0].dict
) > 0) {
5620 /* precondition: as src[0].dict is non-empty and the zsets are ordered
5621 * from small to large, all src[i > 0].dict are non-empty too */
5622 di
= dictGetIterator(src
[0].dict
);
5623 while((de
= dictNext(di
)) != NULL
) {
5624 double *score
= zmalloc(sizeof(double)), value
;
5625 *score
= src
[0].weight
* (*(double*)dictGetEntryVal(de
));
5627 for (j
= 1; j
< zsetnum
; j
++) {
5628 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5630 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5631 zunionInterAggregate(score
, value
, aggregate
);
5637 /* skip entry when not present in every source dict */
5641 robj
*o
= dictGetEntryKey(de
);
5642 dictAdd(dstzset
->dict
,o
,score
);
5643 incrRefCount(o
); /* added to dictionary */
5644 zslInsert(dstzset
->zsl
,*score
,o
);
5645 incrRefCount(o
); /* added to skiplist */
5648 dictReleaseIterator(di
);
5650 } else if (op
== REDIS_OP_UNION
) {
5651 for (i
= 0; i
< zsetnum
; i
++) {
5652 if (!src
[i
].dict
) continue;
5654 di
= dictGetIterator(src
[i
].dict
);
5655 while((de
= dictNext(di
)) != NULL
) {
5656 /* skip key when already processed */
5657 if (dictFind(dstzset
->dict
,dictGetEntryKey(de
)) != NULL
) continue;
5659 double *score
= zmalloc(sizeof(double)), value
;
5660 *score
= src
[i
].weight
* (*(double*)dictGetEntryVal(de
));
5662 /* because the zsets are sorted by size, its only possible
5663 * for sets at larger indices to hold this entry */
5664 for (j
= (i
+1); j
< zsetnum
; j
++) {
5665 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5667 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5668 zunionInterAggregate(score
, value
, aggregate
);
5672 robj
*o
= dictGetEntryKey(de
);
5673 dictAdd(dstzset
->dict
,o
,score
);
5674 incrRefCount(o
); /* added to dictionary */
5675 zslInsert(dstzset
->zsl
,*score
,o
);
5676 incrRefCount(o
); /* added to skiplist */
5678 dictReleaseIterator(di
);
5681 /* unknown operator */
5682 redisAssert(op
== REDIS_OP_INTER
|| op
== REDIS_OP_UNION
);
5685 deleteKey(c
->db
,dstkey
);
5686 if (dstzset
->zsl
->length
) {
5687 dictAdd(c
->db
->dict
,dstkey
,dstobj
);
5688 incrRefCount(dstkey
);
5689 addReplyLong(c
, dstzset
->zsl
->length
);
5692 decrRefCount(dstobj
);
5693 addReply(c
, shared
.czero
);
5698 static void zunionCommand(redisClient
*c
) {
5699 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_UNION
);
5702 static void zinterCommand(redisClient
*c
) {
5703 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_INTER
);
5706 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
5708 int start
= atoi(c
->argv
[2]->ptr
);
5709 int end
= atoi(c
->argv
[3]->ptr
);
5718 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
5720 } else if (c
->argc
>= 5) {
5721 addReply(c
,shared
.syntaxerr
);
5725 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullmultibulk
)) == NULL
||
5726 checkType(c
,o
,REDIS_ZSET
)) return;
5731 /* convert negative indexes */
5732 if (start
< 0) start
= llen
+start
;
5733 if (end
< 0) end
= llen
+end
;
5734 if (start
< 0) start
= 0;
5735 if (end
< 0) end
= 0;
5737 /* indexes sanity checks */
5738 if (start
> end
|| start
>= llen
) {
5739 /* Out of range start or start > end result in empty list */
5740 addReply(c
,shared
.emptymultibulk
);
5743 if (end
>= llen
) end
= llen
-1;
5744 rangelen
= (end
-start
)+1;
5746 /* check if starting point is trivial, before searching
5747 * the element in log(N) time */
5749 ln
= start
== 0 ? zsl
->tail
: zslGetElementByRank(zsl
, llen
-start
);
5752 zsl
->header
->forward
[0] : zslGetElementByRank(zsl
, start
+1);
5755 /* Return the result in form of a multi-bulk reply */
5756 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
5757 withscores
? (rangelen
*2) : rangelen
));
5758 for (j
= 0; j
< rangelen
; j
++) {
5760 addReplyBulk(c
,ele
);
5762 addReplyDouble(c
,ln
->score
);
5763 ln
= reverse
? ln
->backward
: ln
->forward
[0];
5767 static void zrangeCommand(redisClient
*c
) {
5768 zrangeGenericCommand(c
,0);
5771 static void zrevrangeCommand(redisClient
*c
) {
5772 zrangeGenericCommand(c
,1);
5775 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
5776 * If justcount is non-zero, just the count is returned. */
5777 static void genericZrangebyscoreCommand(redisClient
*c
, int justcount
) {
5780 int minex
= 0, maxex
= 0; /* are min or max exclusive? */
5781 int offset
= 0, limit
= -1;
5785 /* Parse the min-max interval. If one of the values is prefixed
5786 * by the "(" character, it's considered "open". For instance
5787 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
5788 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
5789 if (((char*)c
->argv
[2]->ptr
)[0] == '(') {
5790 min
= strtod((char*)c
->argv
[2]->ptr
+1,NULL
);
5793 min
= strtod(c
->argv
[2]->ptr
,NULL
);
5795 if (((char*)c
->argv
[3]->ptr
)[0] == '(') {
5796 max
= strtod((char*)c
->argv
[3]->ptr
+1,NULL
);
5799 max
= strtod(c
->argv
[3]->ptr
,NULL
);
5802 /* Parse "WITHSCORES": note that if the command was called with
5803 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
5804 * enter the following paths to parse WITHSCORES and LIMIT. */
5805 if (c
->argc
== 5 || c
->argc
== 8) {
5806 if (strcasecmp(c
->argv
[c
->argc
-1]->ptr
,"withscores") == 0)
5811 if (c
->argc
!= (4 + withscores
) && c
->argc
!= (7 + withscores
))
5815 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
5820 if (c
->argc
== (7 + withscores
) && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
5821 addReply(c
,shared
.syntaxerr
);
5823 } else if (c
->argc
== (7 + withscores
)) {
5824 offset
= atoi(c
->argv
[5]->ptr
);
5825 limit
= atoi(c
->argv
[6]->ptr
);
5826 if (offset
< 0) offset
= 0;
5829 /* Ok, lookup the key and get the range */
5830 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5832 addReply(c
,justcount
? shared
.czero
: shared
.nullmultibulk
);
5834 if (o
->type
!= REDIS_ZSET
) {
5835 addReply(c
,shared
.wrongtypeerr
);
5837 zset
*zsetobj
= o
->ptr
;
5838 zskiplist
*zsl
= zsetobj
->zsl
;
5840 robj
*ele
, *lenobj
= NULL
;
5841 unsigned long rangelen
= 0;
5843 /* Get the first node with the score >= min, or with
5844 * score > min if 'minex' is true. */
5845 ln
= zslFirstWithScore(zsl
,min
);
5846 while (minex
&& ln
&& ln
->score
== min
) ln
= ln
->forward
[0];
5849 /* No element matching the speciifed interval */
5850 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
5854 /* We don't know in advance how many matching elements there
5855 * are in the list, so we push this object that will represent
5856 * the multi-bulk length in the output buffer, and will "fix"
5859 lenobj
= createObject(REDIS_STRING
,NULL
);
5861 decrRefCount(lenobj
);
5864 while(ln
&& (maxex
? (ln
->score
< max
) : (ln
->score
<= max
))) {
5867 ln
= ln
->forward
[0];
5870 if (limit
== 0) break;
5873 addReplyBulk(c
,ele
);
5875 addReplyDouble(c
,ln
->score
);
5877 ln
= ln
->forward
[0];
5879 if (limit
> 0) limit
--;
5882 addReplyLong(c
,(long)rangelen
);
5884 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",
5885 withscores
? (rangelen
*2) : rangelen
);
5891 static void zrangebyscoreCommand(redisClient
*c
) {
5892 genericZrangebyscoreCommand(c
,0);
5895 static void zcountCommand(redisClient
*c
) {
5896 genericZrangebyscoreCommand(c
,1);
5899 static void zcardCommand(redisClient
*c
) {
5903 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5904 checkType(c
,o
,REDIS_ZSET
)) return;
5907 addReplyUlong(c
,zs
->zsl
->length
);
5910 static void zscoreCommand(redisClient
*c
) {
5915 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5916 checkType(c
,o
,REDIS_ZSET
)) return;
5919 de
= dictFind(zs
->dict
,c
->argv
[2]);
5921 addReply(c
,shared
.nullbulk
);
5923 double *score
= dictGetEntryVal(de
);
5925 addReplyDouble(c
,*score
);
5929 static void zrankGenericCommand(redisClient
*c
, int reverse
) {
5937 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5938 checkType(c
,o
,REDIS_ZSET
)) return;
5942 de
= dictFind(zs
->dict
,c
->argv
[2]);
5944 addReply(c
,shared
.nullbulk
);
5948 score
= dictGetEntryVal(de
);
5949 rank
= zslGetRank(zsl
, *score
, c
->argv
[2]);
5952 addReplyLong(c
, zsl
->length
- rank
);
5954 addReplyLong(c
, rank
-1);
5957 addReply(c
,shared
.nullbulk
);
5961 static void zrankCommand(redisClient
*c
) {
5962 zrankGenericCommand(c
, 0);
5965 static void zrevrankCommand(redisClient
*c
) {
5966 zrankGenericCommand(c
, 1);
5969 /* =================================== Hashes =============================== */
5970 static void hsetCommand(redisClient
*c
) {
5972 robj
*o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5975 o
= createHashObject();
5976 dictAdd(c
->db
->dict
,c
->argv
[1],o
);
5977 incrRefCount(c
->argv
[1]);
5979 if (o
->type
!= REDIS_HASH
) {
5980 addReply(c
,shared
.wrongtypeerr
);
5984 /* We want to convert the zipmap into an hash table right now if the
5985 * entry to be added is too big. Note that we check if the object
5986 * is integer encoded before to try fetching the length in the test below.
5987 * This is because integers are small, but currently stringObjectLen()
5988 * performs a slow conversion: not worth it. */
5989 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
&&
5990 ((c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
&&
5991 sdslen(c
->argv
[2]->ptr
) > server
.hash_max_zipmap_value
) ||
5992 (c
->argv
[3]->encoding
== REDIS_ENCODING_RAW
&&
5993 sdslen(c
->argv
[3]->ptr
) > server
.hash_max_zipmap_value
)))
5995 convertToRealHash(o
);
5998 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
5999 unsigned char *zm
= o
->ptr
;
6000 robj
*valobj
= getDecodedObject(c
->argv
[3]);
6002 zm
= zipmapSet(zm
,c
->argv
[2]->ptr
,sdslen(c
->argv
[2]->ptr
),
6003 valobj
->ptr
,sdslen(valobj
->ptr
),&update
);
6004 decrRefCount(valobj
);
6007 /* And here there is the second check for hash conversion. */
6008 if (zipmapLen(zm
) > server
.hash_max_zipmap_entries
)
6009 convertToRealHash(o
);
6011 tryObjectEncoding(c
->argv
[2]);
6012 /* note that c->argv[3] is already encoded, as the latest arg
6013 * of a bulk command is always integer encoded if possible. */
6014 if (dictReplace(o
->ptr
,c
->argv
[2],c
->argv
[3])) {
6015 incrRefCount(c
->argv
[2]);
6019 incrRefCount(c
->argv
[3]);
6022 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",update
== 0));
6025 static void hincrbyCommand(redisClient
*c
) {
6026 long long value
= 0, incr
= 0;
6027 robj
*o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
6030 o
= createHashObject();
6031 dictAdd(c
->db
->dict
,c
->argv
[1],o
);
6032 incrRefCount(c
->argv
[1]);
6034 if (o
->type
!= REDIS_HASH
) {
6035 addReply(c
,shared
.wrongtypeerr
);
6040 robj
*o_incr
= getDecodedObject(c
->argv
[3]);
6041 incr
= strtoll(o_incr
->ptr
, NULL
, 10);
6042 decrRefCount(o_incr
);
6044 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6045 unsigned char *zm
= o
->ptr
;
6046 unsigned char *zval
;
6049 /* Find value if already present in hash */
6050 if (zipmapGet(zm
,c
->argv
[2]->ptr
,sdslen(c
->argv
[2]->ptr
),
6052 /* strtoll needs the char* to have a trailing \0, but
6053 * the zipmap doesn't include them. */
6054 sds szval
= sdsnewlen(zval
, zvlen
);
6055 value
= strtoll(szval
,NULL
,10);
6060 sds svalue
= sdscatprintf(sdsempty(),"%lld",value
);
6061 zm
= zipmapSet(zm
,c
->argv
[2]->ptr
,sdslen(c
->argv
[2]->ptr
),
6062 (unsigned char*)svalue
,sdslen(svalue
),NULL
);
6066 /* Check if the zipmap needs to be converted. */
6067 if (zipmapLen(zm
) > server
.hash_max_zipmap_entries
)
6068 convertToRealHash(o
);
6073 /* Find value if already present in hash */
6074 de
= dictFind(o
->ptr
,c
->argv
[2]);
6076 hval
= dictGetEntryVal(de
);
6077 if (hval
->encoding
== REDIS_ENCODING_RAW
)
6078 value
= strtoll(hval
->ptr
,NULL
,10);
6079 else if (hval
->encoding
== REDIS_ENCODING_INT
)
6080 value
= (long)hval
->ptr
;
6082 redisAssert(1 != 1);
6086 hval
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
6087 tryObjectEncoding(hval
);
6088 if (dictReplace(o
->ptr
,c
->argv
[2],hval
)) {
6089 incrRefCount(c
->argv
[2]);
6094 addReplyLong(c
, value
);
6097 static void hgetCommand(redisClient
*c
) {
6100 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6101 checkType(c
,o
,REDIS_HASH
)) return;
6103 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6104 unsigned char *zm
= o
->ptr
;
6109 field
= getDecodedObject(c
->argv
[2]);
6110 if (zipmapGet(zm
,field
->ptr
,sdslen(field
->ptr
), &val
,&vlen
)) {
6111 addReplySds(c
,sdscatprintf(sdsempty(),"$%u\r\n", vlen
));
6112 addReplySds(c
,sdsnewlen(val
,vlen
));
6113 addReply(c
,shared
.crlf
);
6114 decrRefCount(field
);
6117 addReply(c
,shared
.nullbulk
);
6118 decrRefCount(field
);
6122 struct dictEntry
*de
;
6124 de
= dictFind(o
->ptr
,c
->argv
[2]);
6126 addReply(c
,shared
.nullbulk
);
6128 robj
*e
= dictGetEntryVal(de
);
6135 static void hdelCommand(redisClient
*c
) {
6139 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6140 checkType(c
,o
,REDIS_HASH
)) return;
6142 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6143 robj
*field
= getDecodedObject(c
->argv
[2]);
6145 o
->ptr
= zipmapDel((unsigned char*) o
->ptr
,
6146 (unsigned char*) field
->ptr
,
6147 sdslen(field
->ptr
), &deleted
);
6148 decrRefCount(field
);
6149 if (zipmapLen((unsigned char*) o
->ptr
) == 0)
6150 deleteKey(c
->db
,c
->argv
[1]);
6152 deleted
= dictDelete((dict
*)o
->ptr
,c
->argv
[2]) == DICT_OK
;
6153 if (htNeedsResize(o
->ptr
)) dictResize(o
->ptr
);
6154 if (dictSize((dict
*)o
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
6156 if (deleted
) server
.dirty
++;
6157 addReply(c
,deleted
? shared
.cone
: shared
.czero
);
6160 static void hlenCommand(redisClient
*c
) {
6164 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6165 checkType(c
,o
,REDIS_HASH
)) return;
6167 len
= (o
->encoding
== REDIS_ENCODING_ZIPMAP
) ?
6168 zipmapLen((unsigned char*)o
->ptr
) : dictSize((dict
*)o
->ptr
);
6169 addReplyUlong(c
,len
);
6172 #define REDIS_GETALL_KEYS 1
6173 #define REDIS_GETALL_VALS 2
6174 static void genericHgetallCommand(redisClient
*c
, int flags
) {
6176 unsigned long count
= 0;
6178 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullmultibulk
)) == NULL
6179 || checkType(c
,o
,REDIS_HASH
)) return;
6181 lenobj
= createObject(REDIS_STRING
,NULL
);
6183 decrRefCount(lenobj
);
6185 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6186 unsigned char *p
= zipmapRewind(o
->ptr
);
6187 unsigned char *field
, *val
;
6188 unsigned int flen
, vlen
;
6190 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
6193 if (flags
& REDIS_GETALL_KEYS
) {
6194 aux
= createStringObject((char*)field
,flen
);
6195 addReplyBulk(c
,aux
);
6199 if (flags
& REDIS_GETALL_VALS
) {
6200 aux
= createStringObject((char*)val
,vlen
);
6201 addReplyBulk(c
,aux
);
6207 dictIterator
*di
= dictGetIterator(o
->ptr
);
6210 while((de
= dictNext(di
)) != NULL
) {
6211 robj
*fieldobj
= dictGetEntryKey(de
);
6212 robj
*valobj
= dictGetEntryVal(de
);
6214 if (flags
& REDIS_GETALL_KEYS
) {
6215 addReplyBulk(c
,fieldobj
);
6218 if (flags
& REDIS_GETALL_VALS
) {
6219 addReplyBulk(c
,valobj
);
6223 dictReleaseIterator(di
);
6225 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",count
);
6228 static void hkeysCommand(redisClient
*c
) {
6229 genericHgetallCommand(c
,REDIS_GETALL_KEYS
);
6232 static void hvalsCommand(redisClient
*c
) {
6233 genericHgetallCommand(c
,REDIS_GETALL_VALS
);
6236 static void hgetallCommand(redisClient
*c
) {
6237 genericHgetallCommand(c
,REDIS_GETALL_KEYS
|REDIS_GETALL_VALS
);
6240 static void hexistsCommand(redisClient
*c
) {
6244 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6245 checkType(c
,o
,REDIS_HASH
)) return;
6247 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6249 unsigned char *zm
= o
->ptr
;
6251 field
= getDecodedObject(c
->argv
[2]);
6252 exists
= zipmapExists(zm
,field
->ptr
,sdslen(field
->ptr
));
6253 decrRefCount(field
);
6255 exists
= dictFind(o
->ptr
,c
->argv
[2]) != NULL
;
6257 addReply(c
,exists
? shared
.cone
: shared
.czero
);
6260 static void convertToRealHash(robj
*o
) {
6261 unsigned char *key
, *val
, *p
, *zm
= o
->ptr
;
6262 unsigned int klen
, vlen
;
6263 dict
*dict
= dictCreate(&hashDictType
,NULL
);
6265 assert(o
->type
== REDIS_HASH
&& o
->encoding
!= REDIS_ENCODING_HT
);
6266 p
= zipmapRewind(zm
);
6267 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
6268 robj
*keyobj
, *valobj
;
6270 keyobj
= createStringObject((char*)key
,klen
);
6271 valobj
= createStringObject((char*)val
,vlen
);
6272 tryObjectEncoding(keyobj
);
6273 tryObjectEncoding(valobj
);
6274 dictAdd(dict
,keyobj
,valobj
);
6276 o
->encoding
= REDIS_ENCODING_HT
;
6281 /* ========================= Non type-specific commands ==================== */
6283 static void flushdbCommand(redisClient
*c
) {
6284 server
.dirty
+= dictSize(c
->db
->dict
);
6285 dictEmpty(c
->db
->dict
);
6286 dictEmpty(c
->db
->expires
);
6287 addReply(c
,shared
.ok
);
6290 static void flushallCommand(redisClient
*c
) {
6291 server
.dirty
+= emptyDb();
6292 addReply(c
,shared
.ok
);
6293 if (server
.bgsavechildpid
!= -1) {
6294 kill(server
.bgsavechildpid
,SIGKILL
);
6295 rdbRemoveTempFile(server
.bgsavechildpid
);
6297 rdbSave(server
.dbfilename
);
6301 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
6302 redisSortOperation
*so
= zmalloc(sizeof(*so
));
6304 so
->pattern
= pattern
;
6308 /* Return the value associated to the key with a name obtained
6309 * substituting the first occurence of '*' in 'pattern' with 'subst' */
6310 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
6314 int prefixlen
, sublen
, postfixlen
;
6315 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
6319 char buf
[REDIS_SORTKEY_MAX
+1];
6322 /* If the pattern is "#" return the substitution object itself in order
6323 * to implement the "SORT ... GET #" feature. */
6324 spat
= pattern
->ptr
;
6325 if (spat
[0] == '#' && spat
[1] == '\0') {
6329 /* The substitution object may be specially encoded. If so we create
6330 * a decoded object on the fly. Otherwise getDecodedObject will just
6331 * increment the ref count, that we'll decrement later. */
6332 subst
= getDecodedObject(subst
);
6335 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
6336 p
= strchr(spat
,'*');
6338 decrRefCount(subst
);
6343 sublen
= sdslen(ssub
);
6344 postfixlen
= sdslen(spat
)-(prefixlen
+1);
6345 memcpy(keyname
.buf
,spat
,prefixlen
);
6346 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
6347 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
6348 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
6349 keyname
.len
= prefixlen
+sublen
+postfixlen
;
6351 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2))
6352 decrRefCount(subst
);
6354 /* printf("lookup '%s' => %p\n", keyname.buf,de); */
6355 return lookupKeyRead(db
,&keyobj
);
6358 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
6359 * the additional parameter is not standard but a BSD-specific we have to
6360 * pass sorting parameters via the global 'server' structure */
6361 static int sortCompare(const void *s1
, const void *s2
) {
6362 const redisSortObject
*so1
= s1
, *so2
= s2
;
6365 if (!server
.sort_alpha
) {
6366 /* Numeric sorting. Here it's trivial as we precomputed scores */
6367 if (so1
->u
.score
> so2
->u
.score
) {
6369 } else if (so1
->u
.score
< so2
->u
.score
) {
6375 /* Alphanumeric sorting */
6376 if (server
.sort_bypattern
) {
6377 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
6378 /* At least one compare object is NULL */
6379 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
6381 else if (so1
->u
.cmpobj
== NULL
)
6386 /* We have both the objects, use strcoll */
6387 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
6390 /* Compare elements directly */
6393 dec1
= getDecodedObject(so1
->obj
);
6394 dec2
= getDecodedObject(so2
->obj
);
6395 cmp
= strcoll(dec1
->ptr
,dec2
->ptr
);
6400 return server
.sort_desc
? -cmp
: cmp
;
6403 /* The SORT command is the most complex command in Redis. Warning: this code
6404 * is optimized for speed and a bit less for readability */
6405 static void sortCommand(redisClient
*c
) {
6408 int desc
= 0, alpha
= 0;
6409 int limit_start
= 0, limit_count
= -1, start
, end
;
6410 int j
, dontsort
= 0, vectorlen
;
6411 int getop
= 0; /* GET operation counter */
6412 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
6413 redisSortObject
*vector
; /* Resulting vector to sort */
6415 /* Lookup the key to sort. It must be of the right types */
6416 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
6417 if (sortval
== NULL
) {
6418 addReply(c
,shared
.nullmultibulk
);
6421 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
6422 sortval
->type
!= REDIS_ZSET
)
6424 addReply(c
,shared
.wrongtypeerr
);
6428 /* Create a list of operations to perform for every sorted element.
6429 * Operations can be GET/DEL/INCR/DECR */
6430 operations
= listCreate();
6431 listSetFreeMethod(operations
,zfree
);
6434 /* Now we need to protect sortval incrementing its count, in the future
6435 * SORT may have options able to overwrite/delete keys during the sorting
6436 * and the sorted key itself may get destroied */
6437 incrRefCount(sortval
);
6439 /* The SORT command has an SQL-alike syntax, parse it */
6440 while(j
< c
->argc
) {
6441 int leftargs
= c
->argc
-j
-1;
6442 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
6444 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
6446 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
6448 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
6449 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
6450 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
6452 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
6453 storekey
= c
->argv
[j
+1];
6455 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
6456 sortby
= c
->argv
[j
+1];
6457 /* If the BY pattern does not contain '*', i.e. it is constant,
6458 * we don't need to sort nor to lookup the weight keys. */
6459 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
6461 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
6462 listAddNodeTail(operations
,createSortOperation(
6463 REDIS_SORT_GET
,c
->argv
[j
+1]));
6467 decrRefCount(sortval
);
6468 listRelease(operations
);
6469 addReply(c
,shared
.syntaxerr
);
6475 /* Load the sorting vector with all the objects to sort */
6476 switch(sortval
->type
) {
6477 case REDIS_LIST
: vectorlen
= listLength((list
*)sortval
->ptr
); break;
6478 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
6479 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
6480 default: vectorlen
= 0; redisAssert(0); /* Avoid GCC warning */
6482 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
6485 if (sortval
->type
== REDIS_LIST
) {
6486 list
*list
= sortval
->ptr
;
6490 listRewind(list
,&li
);
6491 while((ln
= listNext(&li
))) {
6492 robj
*ele
= ln
->value
;
6493 vector
[j
].obj
= ele
;
6494 vector
[j
].u
.score
= 0;
6495 vector
[j
].u
.cmpobj
= NULL
;
6503 if (sortval
->type
== REDIS_SET
) {
6506 zset
*zs
= sortval
->ptr
;
6510 di
= dictGetIterator(set
);
6511 while((setele
= dictNext(di
)) != NULL
) {
6512 vector
[j
].obj
= dictGetEntryKey(setele
);
6513 vector
[j
].u
.score
= 0;
6514 vector
[j
].u
.cmpobj
= NULL
;
6517 dictReleaseIterator(di
);
6519 redisAssert(j
== vectorlen
);
6521 /* Now it's time to load the right scores in the sorting vector */
6522 if (dontsort
== 0) {
6523 for (j
= 0; j
< vectorlen
; j
++) {
6527 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
6528 if (!byval
|| byval
->type
!= REDIS_STRING
) continue;
6530 vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
6532 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
6533 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
6535 /* Don't need to decode the object if it's
6536 * integer-encoded (the only encoding supported) so
6537 * far. We can just cast it */
6538 if (byval
->encoding
== REDIS_ENCODING_INT
) {
6539 vector
[j
].u
.score
= (long)byval
->ptr
;
6541 redisAssert(1 != 1);
6546 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_RAW
)
6547 vector
[j
].u
.score
= strtod(vector
[j
].obj
->ptr
,NULL
);
6549 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_INT
)
6550 vector
[j
].u
.score
= (long) vector
[j
].obj
->ptr
;
6552 redisAssert(1 != 1);
6559 /* We are ready to sort the vector... perform a bit of sanity check
6560 * on the LIMIT option too. We'll use a partial version of quicksort. */
6561 start
= (limit_start
< 0) ? 0 : limit_start
;
6562 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
6563 if (start
>= vectorlen
) {
6564 start
= vectorlen
-1;
6567 if (end
>= vectorlen
) end
= vectorlen
-1;
6569 if (dontsort
== 0) {
6570 server
.sort_desc
= desc
;
6571 server
.sort_alpha
= alpha
;
6572 server
.sort_bypattern
= sortby
? 1 : 0;
6573 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
6574 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
6576 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
6579 /* Send command output to the output buffer, performing the specified
6580 * GET/DEL/INCR/DECR operations if any. */
6581 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
6582 if (storekey
== NULL
) {
6583 /* STORE option not specified, sent the sorting result to client */
6584 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
6585 for (j
= start
; j
<= end
; j
++) {
6589 if (!getop
) addReplyBulk(c
,vector
[j
].obj
);
6590 listRewind(operations
,&li
);
6591 while((ln
= listNext(&li
))) {
6592 redisSortOperation
*sop
= ln
->value
;
6593 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
6596 if (sop
->type
== REDIS_SORT_GET
) {
6597 if (!val
|| val
->type
!= REDIS_STRING
) {
6598 addReply(c
,shared
.nullbulk
);
6600 addReplyBulk(c
,val
);
6603 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
6608 robj
*listObject
= createListObject();
6609 list
*listPtr
= (list
*) listObject
->ptr
;
6611 /* STORE option specified, set the sorting result as a List object */
6612 for (j
= start
; j
<= end
; j
++) {
6617 listAddNodeTail(listPtr
,vector
[j
].obj
);
6618 incrRefCount(vector
[j
].obj
);
6620 listRewind(operations
,&li
);
6621 while((ln
= listNext(&li
))) {
6622 redisSortOperation
*sop
= ln
->value
;
6623 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
6626 if (sop
->type
== REDIS_SORT_GET
) {
6627 if (!val
|| val
->type
!= REDIS_STRING
) {
6628 listAddNodeTail(listPtr
,createStringObject("",0));
6630 listAddNodeTail(listPtr
,val
);
6634 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
6638 if (dictReplace(c
->db
->dict
,storekey
,listObject
)) {
6639 incrRefCount(storekey
);
6641 /* Note: we add 1 because the DB is dirty anyway since even if the
6642 * SORT result is empty a new key is set and maybe the old content
6644 server
.dirty
+= 1+outputlen
;
6645 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
6649 decrRefCount(sortval
);
6650 listRelease(operations
);
6651 for (j
= 0; j
< vectorlen
; j
++) {
6652 if (sortby
&& alpha
&& vector
[j
].u
.cmpobj
)
6653 decrRefCount(vector
[j
].u
.cmpobj
);
6658 /* Convert an amount of bytes into a human readable string in the form
6659 * of 100B, 2G, 100M, 4K, and so forth. */
6660 static void bytesToHuman(char *s
, unsigned long long n
) {
6665 sprintf(s
,"%lluB",n
);
6667 } else if (n
< (1024*1024)) {
6668 d
= (double)n
/(1024);
6669 sprintf(s
,"%.2fK",d
);
6670 } else if (n
< (1024LL*1024*1024)) {
6671 d
= (double)n
/(1024*1024);
6672 sprintf(s
,"%.2fM",d
);
6673 } else if (n
< (1024LL*1024*1024*1024)) {
6674 d
= (double)n
/(1024LL*1024*1024);
6675 sprintf(s
,"%.2fG",d
);
6679 /* Create the string returned by the INFO command. This is decoupled
6680 * by the INFO command itself as we need to report the same information
6681 * on memory corruption problems. */
6682 static sds
genRedisInfoString(void) {
6684 time_t uptime
= time(NULL
)-server
.stat_starttime
;
6688 bytesToHuman(hmem
,zmalloc_used_memory());
6689 info
= sdscatprintf(sdsempty(),
6690 "redis_version:%s\r\n"
6692 "multiplexing_api:%s\r\n"
6693 "process_id:%ld\r\n"
6694 "uptime_in_seconds:%ld\r\n"
6695 "uptime_in_days:%ld\r\n"
6696 "connected_clients:%d\r\n"
6697 "connected_slaves:%d\r\n"
6698 "blocked_clients:%d\r\n"
6699 "used_memory:%zu\r\n"
6700 "used_memory_human:%s\r\n"
6701 "changes_since_last_save:%lld\r\n"
6702 "bgsave_in_progress:%d\r\n"
6703 "last_save_time:%ld\r\n"
6704 "bgrewriteaof_in_progress:%d\r\n"
6705 "total_connections_received:%lld\r\n"
6706 "total_commands_processed:%lld\r\n"
6707 "expired_keys:%lld\r\n"
6708 "hash_max_zipmap_entries:%ld\r\n"
6709 "hash_max_zipmap_value:%ld\r\n"
6710 "pubsub_channels:%ld\r\n"
6711 "pubsub_patterns:%u\r\n"
6715 (sizeof(long) == 8) ? "64" : "32",
6720 listLength(server
.clients
)-listLength(server
.slaves
),
6721 listLength(server
.slaves
),
6722 server
.blpop_blocked_clients
,
6723 zmalloc_used_memory(),
6726 server
.bgsavechildpid
!= -1,
6728 server
.bgrewritechildpid
!= -1,
6729 server
.stat_numconnections
,
6730 server
.stat_numcommands
,
6731 server
.stat_expiredkeys
,
6732 server
.hash_max_zipmap_entries
,
6733 server
.hash_max_zipmap_value
,
6734 dictSize(server
.pubsub_channels
),
6735 listLength(server
.pubsub_patterns
),
6736 server
.vm_enabled
!= 0,
6737 server
.masterhost
== NULL
? "master" : "slave"
6739 if (server
.masterhost
) {
6740 info
= sdscatprintf(info
,
6741 "master_host:%s\r\n"
6742 "master_port:%d\r\n"
6743 "master_link_status:%s\r\n"
6744 "master_last_io_seconds_ago:%d\r\n"
6747 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
6749 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
6752 if (server
.vm_enabled
) {
6754 info
= sdscatprintf(info
,
6755 "vm_conf_max_memory:%llu\r\n"
6756 "vm_conf_page_size:%llu\r\n"
6757 "vm_conf_pages:%llu\r\n"
6758 "vm_stats_used_pages:%llu\r\n"
6759 "vm_stats_swapped_objects:%llu\r\n"
6760 "vm_stats_swappin_count:%llu\r\n"
6761 "vm_stats_swappout_count:%llu\r\n"
6762 "vm_stats_io_newjobs_len:%lu\r\n"
6763 "vm_stats_io_processing_len:%lu\r\n"
6764 "vm_stats_io_processed_len:%lu\r\n"
6765 "vm_stats_io_active_threads:%lu\r\n"
6766 "vm_stats_blocked_clients:%lu\r\n"
6767 ,(unsigned long long) server
.vm_max_memory
,
6768 (unsigned long long) server
.vm_page_size
,
6769 (unsigned long long) server
.vm_pages
,
6770 (unsigned long long) server
.vm_stats_used_pages
,
6771 (unsigned long long) server
.vm_stats_swapped_objects
,
6772 (unsigned long long) server
.vm_stats_swapins
,
6773 (unsigned long long) server
.vm_stats_swapouts
,
6774 (unsigned long) listLength(server
.io_newjobs
),
6775 (unsigned long) listLength(server
.io_processing
),
6776 (unsigned long) listLength(server
.io_processed
),
6777 (unsigned long) server
.io_active_threads
,
6778 (unsigned long) server
.vm_blocked_clients
6782 for (j
= 0; j
< server
.dbnum
; j
++) {
6783 long long keys
, vkeys
;
6785 keys
= dictSize(server
.db
[j
].dict
);
6786 vkeys
= dictSize(server
.db
[j
].expires
);
6787 if (keys
|| vkeys
) {
6788 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
6795 static void infoCommand(redisClient
*c
) {
6796 sds info
= genRedisInfoString();
6797 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
6798 (unsigned long)sdslen(info
)));
6799 addReplySds(c
,info
);
6800 addReply(c
,shared
.crlf
);
6803 static void monitorCommand(redisClient
*c
) {
6804 /* ignore MONITOR if aleady slave or in monitor mode */
6805 if (c
->flags
& REDIS_SLAVE
) return;
6807 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
6809 listAddNodeTail(server
.monitors
,c
);
6810 addReply(c
,shared
.ok
);
6813 /* ================================= Expire ================================= */
6814 static int removeExpire(redisDb
*db
, robj
*key
) {
6815 if (dictDelete(db
->expires
,key
) == DICT_OK
) {
6822 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
6823 if (dictAdd(db
->expires
,key
,(void*)when
) == DICT_ERR
) {
6831 /* Return the expire time of the specified key, or -1 if no expire
6832 * is associated with this key (i.e. the key is non volatile) */
6833 static time_t getExpire(redisDb
*db
, robj
*key
) {
6836 /* No expire? return ASAP */
6837 if (dictSize(db
->expires
) == 0 ||
6838 (de
= dictFind(db
->expires
,key
)) == NULL
) return -1;
6840 return (time_t) dictGetEntryVal(de
);
6843 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
6847 /* No expire? return ASAP */
6848 if (dictSize(db
->expires
) == 0 ||
6849 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
6851 /* Lookup the expire */
6852 when
= (time_t) dictGetEntryVal(de
);
6853 if (time(NULL
) <= when
) return 0;
6855 /* Delete the key */
6856 dictDelete(db
->expires
,key
);
6857 server
.stat_expiredkeys
++;
6858 return dictDelete(db
->dict
,key
) == DICT_OK
;
6861 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
6864 /* No expire? return ASAP */
6865 if (dictSize(db
->expires
) == 0 ||
6866 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
6868 /* Delete the key */
6870 server
.stat_expiredkeys
++;
6871 dictDelete(db
->expires
,key
);
6872 return dictDelete(db
->dict
,key
) == DICT_OK
;
6875 static void expireGenericCommand(redisClient
*c
, robj
*key
, time_t seconds
) {
6878 de
= dictFind(c
->db
->dict
,key
);
6880 addReply(c
,shared
.czero
);
6884 if (deleteKey(c
->db
,key
)) server
.dirty
++;
6885 addReply(c
, shared
.cone
);
6888 time_t when
= time(NULL
)+seconds
;
6889 if (setExpire(c
->db
,key
,when
)) {
6890 addReply(c
,shared
.cone
);
6893 addReply(c
,shared
.czero
);
6899 static void expireCommand(redisClient
*c
) {
6900 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10));
6903 static void expireatCommand(redisClient
*c
) {
6904 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10)-time(NULL
));
6907 static void ttlCommand(redisClient
*c
) {
6911 expire
= getExpire(c
->db
,c
->argv
[1]);
6913 ttl
= (int) (expire
-time(NULL
));
6914 if (ttl
< 0) ttl
= -1;
6916 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
6919 /* ================================ MULTI/EXEC ============================== */
6921 /* Client state initialization for MULTI/EXEC */
6922 static void initClientMultiState(redisClient
*c
) {
6923 c
->mstate
.commands
= NULL
;
6924 c
->mstate
.count
= 0;
6927 /* Release all the resources associated with MULTI/EXEC state */
6928 static void freeClientMultiState(redisClient
*c
) {
6931 for (j
= 0; j
< c
->mstate
.count
; j
++) {
6933 multiCmd
*mc
= c
->mstate
.commands
+j
;
6935 for (i
= 0; i
< mc
->argc
; i
++)
6936 decrRefCount(mc
->argv
[i
]);
6939 zfree(c
->mstate
.commands
);
6942 /* Add a new command into the MULTI commands queue */
6943 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
6947 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
6948 sizeof(multiCmd
)*(c
->mstate
.count
+1));
6949 mc
= c
->mstate
.commands
+c
->mstate
.count
;
6952 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
6953 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
6954 for (j
= 0; j
< c
->argc
; j
++)
6955 incrRefCount(mc
->argv
[j
]);
6959 static void multiCommand(redisClient
*c
) {
6960 c
->flags
|= REDIS_MULTI
;
6961 addReply(c
,shared
.ok
);
6964 static void discardCommand(redisClient
*c
) {
6965 if (!(c
->flags
& REDIS_MULTI
)) {
6966 addReplySds(c
,sdsnew("-ERR DISCARD without MULTI\r\n"));
6970 freeClientMultiState(c
);
6971 initClientMultiState(c
);
6972 c
->flags
&= (~REDIS_MULTI
);
6973 addReply(c
,shared
.ok
);
6976 static void execCommand(redisClient
*c
) {
6981 if (!(c
->flags
& REDIS_MULTI
)) {
6982 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
6986 orig_argv
= c
->argv
;
6987 orig_argc
= c
->argc
;
6988 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
6989 for (j
= 0; j
< c
->mstate
.count
; j
++) {
6990 c
->argc
= c
->mstate
.commands
[j
].argc
;
6991 c
->argv
= c
->mstate
.commands
[j
].argv
;
6992 call(c
,c
->mstate
.commands
[j
].cmd
);
6994 c
->argv
= orig_argv
;
6995 c
->argc
= orig_argc
;
6996 freeClientMultiState(c
);
6997 initClientMultiState(c
);
6998 c
->flags
&= (~REDIS_MULTI
);
7001 /* =========================== Blocking Operations ========================= */
7003 /* Currently Redis blocking operations support is limited to list POP ops,
7004 * so the current implementation is not fully generic, but it is also not
7005 * completely specific so it will not require a rewrite to support new
7006 * kind of blocking operations in the future.
7008 * Still it's important to note that list blocking operations can be already
7009 * used as a notification mechanism in order to implement other blocking
7010 * operations at application level, so there must be a very strong evidence
7011 * of usefulness and generality before new blocking operations are implemented.
7013 * This is how the current blocking POP works, we use BLPOP as example:
7014 * - If the user calls BLPOP and the key exists and contains a non empty list
7015 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
7016 * if there is not to block.
7017 * - If instead BLPOP is called and the key does not exists or the list is
7018 * empty we need to block. In order to do so we remove the notification for
7019 * new data to read in the client socket (so that we'll not serve new
7020 * requests if the blocking request is not served). Also we put the client
7021 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
7022 * blocking for this keys.
7023 * - If a PUSH operation against a key with blocked clients waiting is
7024 * performed, we serve the first in the list: basically instead to push
7025 * the new element inside the list we return it to the (first / oldest)
7026 * blocking client, unblock the client, and remove it form the list.
7028 * The above comment and the source code should be enough in order to understand
7029 * the implementation and modify / fix it later.
7032 /* Set a client in blocking mode for the specified key, with the specified
7034 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
7039 c
->blockingkeys
= zmalloc(sizeof(robj
*)*numkeys
);
7040 c
->blockingkeysnum
= numkeys
;
7041 c
->blockingto
= timeout
;
7042 for (j
= 0; j
< numkeys
; j
++) {
7043 /* Add the key in the client structure, to map clients -> keys */
7044 c
->blockingkeys
[j
] = keys
[j
];
7045 incrRefCount(keys
[j
]);
7047 /* And in the other "side", to map keys -> clients */
7048 de
= dictFind(c
->db
->blockingkeys
,keys
[j
]);
7052 /* For every key we take a list of clients blocked for it */
7054 retval
= dictAdd(c
->db
->blockingkeys
,keys
[j
],l
);
7055 incrRefCount(keys
[j
]);
7056 assert(retval
== DICT_OK
);
7058 l
= dictGetEntryVal(de
);
7060 listAddNodeTail(l
,c
);
7062 /* Mark the client as a blocked client */
7063 c
->flags
|= REDIS_BLOCKED
;
7064 server
.blpop_blocked_clients
++;
7067 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
7068 static void unblockClientWaitingData(redisClient
*c
) {
7073 assert(c
->blockingkeys
!= NULL
);
7074 /* The client may wait for multiple keys, so unblock it for every key. */
7075 for (j
= 0; j
< c
->blockingkeysnum
; j
++) {
7076 /* Remove this client from the list of clients waiting for this key. */
7077 de
= dictFind(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
7079 l
= dictGetEntryVal(de
);
7080 listDelNode(l
,listSearchKey(l
,c
));
7081 /* If the list is empty we need to remove it to avoid wasting memory */
7082 if (listLength(l
) == 0)
7083 dictDelete(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
7084 decrRefCount(c
->blockingkeys
[j
]);
7086 /* Cleanup the client structure */
7087 zfree(c
->blockingkeys
);
7088 c
->blockingkeys
= NULL
;
7089 c
->flags
&= (~REDIS_BLOCKED
);
7090 server
.blpop_blocked_clients
--;
7091 /* We want to process data if there is some command waiting
7092 * in the input buffer. Note that this is safe even if
7093 * unblockClientWaitingData() gets called from freeClient() because
7094 * freeClient() will be smart enough to call this function
7095 * *after* c->querybuf was set to NULL. */
7096 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
7099 /* This should be called from any function PUSHing into lists.
7100 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
7101 * 'ele' is the element pushed.
7103 * If the function returns 0 there was no client waiting for a list push
7106 * If the function returns 1 there was a client waiting for a list push
7107 * against this key, the element was passed to this client thus it's not
7108 * needed to actually add it to the list and the caller should return asap. */
7109 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
7110 struct dictEntry
*de
;
7111 redisClient
*receiver
;
7115 de
= dictFind(c
->db
->blockingkeys
,key
);
7116 if (de
== NULL
) return 0;
7117 l
= dictGetEntryVal(de
);
7120 receiver
= ln
->value
;
7122 addReplySds(receiver
,sdsnew("*2\r\n"));
7123 addReplyBulk(receiver
,key
);
7124 addReplyBulk(receiver
,ele
);
7125 unblockClientWaitingData(receiver
);
7129 /* Blocking RPOP/LPOP */
7130 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
7135 for (j
= 1; j
< c
->argc
-1; j
++) {
7136 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
7138 if (o
->type
!= REDIS_LIST
) {
7139 addReply(c
,shared
.wrongtypeerr
);
7142 list
*list
= o
->ptr
;
7143 if (listLength(list
) != 0) {
7144 /* If the list contains elements fall back to the usual
7145 * non-blocking POP operation */
7146 robj
*argv
[2], **orig_argv
;
7149 /* We need to alter the command arguments before to call
7150 * popGenericCommand() as the command takes a single key. */
7151 orig_argv
= c
->argv
;
7152 orig_argc
= c
->argc
;
7153 argv
[1] = c
->argv
[j
];
7157 /* Also the return value is different, we need to output
7158 * the multi bulk reply header and the key name. The
7159 * "real" command will add the last element (the value)
7160 * for us. If this souds like an hack to you it's just
7161 * because it is... */
7162 addReplySds(c
,sdsnew("*2\r\n"));
7163 addReplyBulk(c
,argv
[1]);
7164 popGenericCommand(c
,where
);
7166 /* Fix the client structure with the original stuff */
7167 c
->argv
= orig_argv
;
7168 c
->argc
= orig_argc
;
7174 /* If the list is empty or the key does not exists we must block */
7175 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
7176 if (timeout
> 0) timeout
+= time(NULL
);
7177 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
7180 static void blpopCommand(redisClient
*c
) {
7181 blockingPopGenericCommand(c
,REDIS_HEAD
);
7184 static void brpopCommand(redisClient
*c
) {
7185 blockingPopGenericCommand(c
,REDIS_TAIL
);
7188 /* =============================== Replication ============================= */
7190 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7191 ssize_t nwritten
, ret
= size
;
7192 time_t start
= time(NULL
);
7196 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
7197 nwritten
= write(fd
,ptr
,size
);
7198 if (nwritten
== -1) return -1;
7202 if ((time(NULL
)-start
) > timeout
) {
7210 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7211 ssize_t nread
, totread
= 0;
7212 time_t start
= time(NULL
);
7216 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
7217 nread
= read(fd
,ptr
,size
);
7218 if (nread
== -1) return -1;
7223 if ((time(NULL
)-start
) > timeout
) {
7231 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7238 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
7241 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
7252 static void syncCommand(redisClient
*c
) {
7253 /* ignore SYNC if aleady slave or in monitor mode */
7254 if (c
->flags
& REDIS_SLAVE
) return;
7256 /* SYNC can't be issued when the server has pending data to send to
7257 * the client about already issued commands. We need a fresh reply
7258 * buffer registering the differences between the BGSAVE and the current
7259 * dataset, so that we can copy to other slaves if needed. */
7260 if (listLength(c
->reply
) != 0) {
7261 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
7265 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
7266 /* Here we need to check if there is a background saving operation
7267 * in progress, or if it is required to start one */
7268 if (server
.bgsavechildpid
!= -1) {
7269 /* Ok a background save is in progress. Let's check if it is a good
7270 * one for replication, i.e. if there is another slave that is
7271 * registering differences since the server forked to save */
7276 listRewind(server
.slaves
,&li
);
7277 while((ln
= listNext(&li
))) {
7279 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
7282 /* Perfect, the server is already registering differences for
7283 * another slave. Set the right state, and copy the buffer. */
7284 listRelease(c
->reply
);
7285 c
->reply
= listDup(slave
->reply
);
7286 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7287 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
7289 /* No way, we need to wait for the next BGSAVE in order to
7290 * register differences */
7291 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7292 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
7295 /* Ok we don't have a BGSAVE in progress, let's start one */
7296 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
7297 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7298 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
7299 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
7302 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7305 c
->flags
|= REDIS_SLAVE
;
7307 listAddNodeTail(server
.slaves
,c
);
7311 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
7312 redisClient
*slave
= privdata
;
7314 REDIS_NOTUSED(mask
);
7315 char buf
[REDIS_IOBUF_LEN
];
7316 ssize_t nwritten
, buflen
;
7318 if (slave
->repldboff
== 0) {
7319 /* Write the bulk write count before to transfer the DB. In theory here
7320 * we don't know how much room there is in the output buffer of the
7321 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
7322 * operations) will never be smaller than the few bytes we need. */
7325 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
7327 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
7335 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
7336 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
7338 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
7339 (buflen
== 0) ? "premature EOF" : strerror(errno
));
7343 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
7344 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
7349 slave
->repldboff
+= nwritten
;
7350 if (slave
->repldboff
== slave
->repldbsize
) {
7351 close(slave
->repldbfd
);
7352 slave
->repldbfd
= -1;
7353 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7354 slave
->replstate
= REDIS_REPL_ONLINE
;
7355 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
7356 sendReplyToClient
, slave
) == AE_ERR
) {
7360 addReplySds(slave
,sdsempty());
7361 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
7365 /* This function is called at the end of every backgrond saving.
7366 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
7367 * otherwise REDIS_ERR is passed to the function.
7369 * The goal of this function is to handle slaves waiting for a successful
7370 * background saving in order to perform non-blocking synchronization. */
7371 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
7373 int startbgsave
= 0;
7376 listRewind(server
.slaves
,&li
);
7377 while((ln
= listNext(&li
))) {
7378 redisClient
*slave
= ln
->value
;
7380 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
7382 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7383 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
7384 struct redis_stat buf
;
7386 if (bgsaveerr
!= REDIS_OK
) {
7388 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
7391 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
7392 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
7394 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
7397 slave
->repldboff
= 0;
7398 slave
->repldbsize
= buf
.st_size
;
7399 slave
->replstate
= REDIS_REPL_SEND_BULK
;
7400 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7401 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
7408 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7411 listRewind(server
.slaves
,&li
);
7412 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
7413 while((ln
= listNext(&li
))) {
7414 redisClient
*slave
= ln
->value
;
7416 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
7423 static int syncWithMaster(void) {
7424 char buf
[1024], tmpfile
[256], authcmd
[1024];
7426 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
7427 int dfd
, maxtries
= 5;
7430 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
7435 /* AUTH with the master if required. */
7436 if(server
.masterauth
) {
7437 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
7438 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
7440 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
7444 /* Read the AUTH result. */
7445 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7447 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
7451 if (buf
[0] != '+') {
7453 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
7458 /* Issue the SYNC command */
7459 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
7461 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
7465 /* Read the bulk write count */
7466 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7468 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
7472 if (buf
[0] != '$') {
7474 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
7477 dumpsize
= strtol(buf
+1,NULL
,10);
7478 redisLog(REDIS_NOTICE
,"Receiving %ld bytes data dump from MASTER",dumpsize
);
7479 /* Read the bulk write data on a temp file */
7481 snprintf(tmpfile
,256,
7482 "temp-%d.%ld.rdb",(int)time(NULL
),(long int)getpid());
7483 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
|O_EXCL
,0644);
7484 if (dfd
!= -1) break;
7489 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
7493 int nread
, nwritten
;
7495 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
7497 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
7503 nwritten
= write(dfd
,buf
,nread
);
7504 if (nwritten
== -1) {
7505 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
7513 if (rename(tmpfile
,server
.dbfilename
) == -1) {
7514 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
7520 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
7521 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
7525 server
.master
= createClient(fd
);
7526 server
.master
->flags
|= REDIS_MASTER
;
7527 server
.master
->authenticated
= 1;
7528 server
.replstate
= REDIS_REPL_CONNECTED
;
7532 static void slaveofCommand(redisClient
*c
) {
7533 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
7534 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
7535 if (server
.masterhost
) {
7536 sdsfree(server
.masterhost
);
7537 server
.masterhost
= NULL
;
7538 if (server
.master
) freeClient(server
.master
);
7539 server
.replstate
= REDIS_REPL_NONE
;
7540 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
7543 sdsfree(server
.masterhost
);
7544 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
7545 server
.masterport
= atoi(c
->argv
[2]->ptr
);
7546 if (server
.master
) freeClient(server
.master
);
7547 server
.replstate
= REDIS_REPL_CONNECT
;
7548 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
7549 server
.masterhost
, server
.masterport
);
7551 addReply(c
,shared
.ok
);
7554 /* ============================ Maxmemory directive ======================== */
7556 /* Try to free one object form the pre-allocated objects free list.
7557 * This is useful under low mem conditions as by default we take 1 million
7558 * free objects allocated. On success REDIS_OK is returned, otherwise
7560 static int tryFreeOneObjectFromFreelist(void) {
7563 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
7564 if (listLength(server
.objfreelist
)) {
7565 listNode
*head
= listFirst(server
.objfreelist
);
7566 o
= listNodeValue(head
);
7567 listDelNode(server
.objfreelist
,head
);
7568 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7572 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7577 /* This function gets called when 'maxmemory' is set on the config file to limit
7578 * the max memory used by the server, and we are out of memory.
7579 * This function will try to, in order:
7581 * - Free objects from the free list
7582 * - Try to remove keys with an EXPIRE set
7584 * It is not possible to free enough memory to reach used-memory < maxmemory
7585 * the server will start refusing commands that will enlarge even more the
7588 static void freeMemoryIfNeeded(void) {
7589 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
7590 int j
, k
, freed
= 0;
7592 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
7593 for (j
= 0; j
< server
.dbnum
; j
++) {
7595 robj
*minkey
= NULL
;
7596 struct dictEntry
*de
;
7598 if (dictSize(server
.db
[j
].expires
)) {
7600 /* From a sample of three keys drop the one nearest to
7601 * the natural expire */
7602 for (k
= 0; k
< 3; k
++) {
7605 de
= dictGetRandomKey(server
.db
[j
].expires
);
7606 t
= (time_t) dictGetEntryVal(de
);
7607 if (minttl
== -1 || t
< minttl
) {
7608 minkey
= dictGetEntryKey(de
);
7612 deleteKey(server
.db
+j
,minkey
);
7615 if (!freed
) return; /* nothing to free... */
7619 /* ============================== Append Only file ========================== */
7621 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
7622 sds buf
= sdsempty();
7628 /* The DB this command was targetting is not the same as the last command
7629 * we appendend. To issue a SELECT command is needed. */
7630 if (dictid
!= server
.appendseldb
) {
7633 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
7634 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
7635 (unsigned long)strlen(seldb
),seldb
);
7636 server
.appendseldb
= dictid
;
7639 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
7640 * EXPIREs into EXPIREATs calls */
7641 if (cmd
->proc
== expireCommand
) {
7644 tmpargv
[0] = createStringObject("EXPIREAT",8);
7645 tmpargv
[1] = argv
[1];
7646 incrRefCount(argv
[1]);
7647 when
= time(NULL
)+strtol(argv
[2]->ptr
,NULL
,10);
7648 tmpargv
[2] = createObject(REDIS_STRING
,
7649 sdscatprintf(sdsempty(),"%ld",when
));
7653 /* Append the actual command */
7654 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
7655 for (j
= 0; j
< argc
; j
++) {
7658 o
= getDecodedObject(o
);
7659 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
7660 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
7661 buf
= sdscatlen(buf
,"\r\n",2);
7665 /* Free the objects from the modified argv for EXPIREAT */
7666 if (cmd
->proc
== expireCommand
) {
7667 for (j
= 0; j
< 3; j
++)
7668 decrRefCount(argv
[j
]);
7671 /* We want to perform a single write. This should be guaranteed atomic
7672 * at least if the filesystem we are writing is a real physical one.
7673 * While this will save us against the server being killed I don't think
7674 * there is much to do about the whole server stopping for power problems
7676 nwritten
= write(server
.appendfd
,buf
,sdslen(buf
));
7677 if (nwritten
!= (signed)sdslen(buf
)) {
7678 /* Ooops, we are in troubles. The best thing to do for now is
7679 * to simply exit instead to give the illusion that everything is
7680 * working as expected. */
7681 if (nwritten
== -1) {
7682 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
7684 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
7688 /* If a background append only file rewriting is in progress we want to
7689 * accumulate the differences between the child DB and the current one
7690 * in a buffer, so that when the child process will do its work we
7691 * can append the differences to the new append only file. */
7692 if (server
.bgrewritechildpid
!= -1)
7693 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
7697 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
7698 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
7699 now
-server
.lastfsync
> 1))
7701 fsync(server
.appendfd
); /* Let's try to get this data on the disk */
7702 server
.lastfsync
= now
;
7706 /* In Redis commands are always executed in the context of a client, so in
7707 * order to load the append only file we need to create a fake client. */
7708 static struct redisClient
*createFakeClient(void) {
7709 struct redisClient
*c
= zmalloc(sizeof(*c
));
7713 c
->querybuf
= sdsempty();
7717 /* We set the fake client as a slave waiting for the synchronization
7718 * so that Redis will not try to send replies to this client. */
7719 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7720 c
->reply
= listCreate();
7721 listSetFreeMethod(c
->reply
,decrRefCount
);
7722 listSetDupMethod(c
->reply
,dupClientReplyValue
);
7726 static void freeFakeClient(struct redisClient
*c
) {
7727 sdsfree(c
->querybuf
);
7728 listRelease(c
->reply
);
7732 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
7733 * error (the append only file is zero-length) REDIS_ERR is returned. On
7734 * fatal error an error message is logged and the program exists. */
7735 int loadAppendOnlyFile(char *filename
) {
7736 struct redisClient
*fakeClient
;
7737 FILE *fp
= fopen(filename
,"r");
7738 struct redis_stat sb
;
7739 unsigned long long loadedkeys
= 0;
7741 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
7745 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
7749 fakeClient
= createFakeClient();
7756 struct redisCommand
*cmd
;
7758 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
7764 if (buf
[0] != '*') goto fmterr
;
7766 argv
= zmalloc(sizeof(robj
*)*argc
);
7767 for (j
= 0; j
< argc
; j
++) {
7768 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
7769 if (buf
[0] != '$') goto fmterr
;
7770 len
= strtol(buf
+1,NULL
,10);
7771 argsds
= sdsnewlen(NULL
,len
);
7772 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
7773 argv
[j
] = createObject(REDIS_STRING
,argsds
);
7774 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
7777 /* Command lookup */
7778 cmd
= lookupCommand(argv
[0]->ptr
);
7780 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
7783 /* Try object sharing and encoding */
7784 if (server
.shareobjects
) {
7786 for(j
= 1; j
< argc
; j
++)
7787 argv
[j
] = tryObjectSharing(argv
[j
]);
7789 if (cmd
->flags
& REDIS_CMD_BULK
)
7790 tryObjectEncoding(argv
[argc
-1]);
7791 /* Run the command in the context of a fake client */
7792 fakeClient
->argc
= argc
;
7793 fakeClient
->argv
= argv
;
7794 cmd
->proc(fakeClient
);
7795 /* Discard the reply objects list from the fake client */
7796 while(listLength(fakeClient
->reply
))
7797 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
7798 /* Clean up, ready for the next command */
7799 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
7801 /* Handle swapping while loading big datasets when VM is on */
7803 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
7804 while (zmalloc_used_memory() > server
.vm_max_memory
) {
7805 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
7810 freeFakeClient(fakeClient
);
7815 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
7817 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
7821 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
7825 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
7826 static int fwriteBulkObject(FILE *fp
, robj
*obj
) {
7830 /* Avoid the incr/decr ref count business if possible to help
7831 * copy-on-write (we are often in a child process when this function
7833 * Also makes sure that key objects don't get incrRefCount-ed when VM
7835 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
7836 obj
= getDecodedObject(obj
);
7839 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
7840 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
7841 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
7843 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
7844 if (decrrc
) decrRefCount(obj
);
7847 if (decrrc
) decrRefCount(obj
);
7851 /* Write binary-safe string into a file in the bulkformat
7852 * $<count>\r\n<payload>\r\n */
7853 static int fwriteBulkString(FILE *fp
, char *s
, unsigned long len
) {
7856 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(unsigned long)len
);
7857 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
7858 if (len
&& fwrite(s
,len
,1,fp
) == 0) return 0;
7859 if (fwrite("\r\n",2,1,fp
) == 0) return 0;
7863 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
7864 static int fwriteBulkDouble(FILE *fp
, double d
) {
7865 char buf
[128], dbuf
[128];
7867 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
7868 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
7869 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
7870 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
7874 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
7875 static int fwriteBulkLong(FILE *fp
, long l
) {
7876 char buf
[128], lbuf
[128];
7878 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
7879 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
7880 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
7881 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
7885 /* Write a sequence of commands able to fully rebuild the dataset into
7886 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
7887 static int rewriteAppendOnlyFile(char *filename
) {
7888 dictIterator
*di
= NULL
;
7893 time_t now
= time(NULL
);
7895 /* Note that we have to use a different temp name here compared to the
7896 * one used by rewriteAppendOnlyFileBackground() function. */
7897 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
7898 fp
= fopen(tmpfile
,"w");
7900 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
7903 for (j
= 0; j
< server
.dbnum
; j
++) {
7904 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
7905 redisDb
*db
= server
.db
+j
;
7907 if (dictSize(d
) == 0) continue;
7908 di
= dictGetIterator(d
);
7914 /* SELECT the new DB */
7915 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
7916 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
7918 /* Iterate this DB writing every entry */
7919 while((de
= dictNext(di
)) != NULL
) {
7924 key
= dictGetEntryKey(de
);
7925 /* If the value for this key is swapped, load a preview in memory.
7926 * We use a "swapped" flag to remember if we need to free the
7927 * value object instead to just increment the ref count anyway
7928 * in order to avoid copy-on-write of pages if we are forked() */
7929 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
7930 key
->storage
== REDIS_VM_SWAPPING
) {
7931 o
= dictGetEntryVal(de
);
7934 o
= vmPreviewObject(key
);
7937 expiretime
= getExpire(db
,key
);
7939 /* Save the key and associated value */
7940 if (o
->type
== REDIS_STRING
) {
7941 /* Emit a SET command */
7942 char cmd
[]="*3\r\n$3\r\nSET\r\n";
7943 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7945 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7946 if (fwriteBulkObject(fp
,o
) == 0) goto werr
;
7947 } else if (o
->type
== REDIS_LIST
) {
7948 /* Emit the RPUSHes needed to rebuild the list */
7949 list
*list
= o
->ptr
;
7953 listRewind(list
,&li
);
7954 while((ln
= listNext(&li
))) {
7955 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
7956 robj
*eleobj
= listNodeValue(ln
);
7958 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7959 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7960 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
7962 } else if (o
->type
== REDIS_SET
) {
7963 /* Emit the SADDs needed to rebuild the set */
7965 dictIterator
*di
= dictGetIterator(set
);
7968 while((de
= dictNext(di
)) != NULL
) {
7969 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
7970 robj
*eleobj
= dictGetEntryKey(de
);
7972 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7973 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7974 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
7976 dictReleaseIterator(di
);
7977 } else if (o
->type
== REDIS_ZSET
) {
7978 /* Emit the ZADDs needed to rebuild the sorted set */
7980 dictIterator
*di
= dictGetIterator(zs
->dict
);
7983 while((de
= dictNext(di
)) != NULL
) {
7984 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
7985 robj
*eleobj
= dictGetEntryKey(de
);
7986 double *score
= dictGetEntryVal(de
);
7988 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7989 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
7990 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
7991 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
7993 dictReleaseIterator(di
);
7994 } else if (o
->type
== REDIS_HASH
) {
7995 char cmd
[]="*4\r\n$4\r\nHSET\r\n";
7997 /* Emit the HSETs needed to rebuild the hash */
7998 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
7999 unsigned char *p
= zipmapRewind(o
->ptr
);
8000 unsigned char *field
, *val
;
8001 unsigned int flen
, vlen
;
8003 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
8004 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8005 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8006 if (fwriteBulkString(fp
,(char*)field
,flen
) == -1)
8008 if (fwriteBulkString(fp
,(char*)val
,vlen
) == -1)
8012 dictIterator
*di
= dictGetIterator(o
->ptr
);
8015 while((de
= dictNext(di
)) != NULL
) {
8016 robj
*field
= dictGetEntryKey(de
);
8017 robj
*val
= dictGetEntryVal(de
);
8019 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8020 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8021 if (fwriteBulkObject(fp
,field
) == -1) return -1;
8022 if (fwriteBulkObject(fp
,val
) == -1) return -1;
8024 dictReleaseIterator(di
);
8029 /* Save the expire time */
8030 if (expiretime
!= -1) {
8031 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
8032 /* If this key is already expired skip it */
8033 if (expiretime
< now
) continue;
8034 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8035 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8036 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
8038 if (swapped
) decrRefCount(o
);
8040 dictReleaseIterator(di
);
8043 /* Make sure data will not remain on the OS's output buffers */
8048 /* Use RENAME to make sure the DB file is changed atomically only
8049 * if the generate DB file is ok. */
8050 if (rename(tmpfile
,filename
) == -1) {
8051 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
8055 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
8061 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
8062 if (di
) dictReleaseIterator(di
);
8066 /* This is how rewriting of the append only file in background works:
8068 * 1) The user calls BGREWRITEAOF
8069 * 2) Redis calls this function, that forks():
8070 * 2a) the child rewrite the append only file in a temp file.
8071 * 2b) the parent accumulates differences in server.bgrewritebuf.
8072 * 3) When the child finished '2a' exists.
8073 * 4) The parent will trap the exit code, if it's OK, will append the
8074 * data accumulated into server.bgrewritebuf into the temp file, and
8075 * finally will rename(2) the temp file in the actual file name.
8076 * The the new file is reopened as the new append only file. Profit!
8078 static int rewriteAppendOnlyFileBackground(void) {
8081 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
8082 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
8083 if ((childpid
= fork()) == 0) {
8087 if (server
.vm_enabled
) vmReopenSwapFile();
8089 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
8090 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
8097 if (childpid
== -1) {
8098 redisLog(REDIS_WARNING
,
8099 "Can't rewrite append only file in background: fork: %s",
8103 redisLog(REDIS_NOTICE
,
8104 "Background append only file rewriting started by pid %d",childpid
);
8105 server
.bgrewritechildpid
= childpid
;
8106 /* We set appendseldb to -1 in order to force the next call to the
8107 * feedAppendOnlyFile() to issue a SELECT command, so the differences
8108 * accumulated by the parent into server.bgrewritebuf will start
8109 * with a SELECT statement and it will be safe to merge. */
8110 server
.appendseldb
= -1;
8113 return REDIS_OK
; /* unreached */
8116 static void bgrewriteaofCommand(redisClient
*c
) {
8117 if (server
.bgrewritechildpid
!= -1) {
8118 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
8121 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
8122 char *status
= "+Background append only file rewriting started\r\n";
8123 addReplySds(c
,sdsnew(status
));
8125 addReply(c
,shared
.err
);
8129 static void aofRemoveTempFile(pid_t childpid
) {
8132 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
8136 /* Virtual Memory is composed mainly of two subsystems:
8137 * - Blocking Virutal Memory
8138 * - Threaded Virtual Memory I/O
8139 * The two parts are not fully decoupled, but functions are split among two
8140 * different sections of the source code (delimited by comments) in order to
8141 * make more clear what functionality is about the blocking VM and what about
8142 * the threaded (not blocking) VM.
8146 * Redis VM is a blocking VM (one that blocks reading swapped values from
8147 * disk into memory when a value swapped out is needed in memory) that is made
8148 * unblocking by trying to examine the command argument vector in order to
8149 * load in background values that will likely be needed in order to exec
8150 * the command. The command is executed only once all the relevant keys
8151 * are loaded into memory.
8153 * This basically is almost as simple of a blocking VM, but almost as parallel
8154 * as a fully non-blocking VM.
8157 /* =================== Virtual Memory - Blocking Side ====================== */
8159 /* substitute the first occurrence of '%p' with the process pid in the
8160 * swap file name. */
8161 static void expandVmSwapFilename(void) {
8162 char *p
= strstr(server
.vm_swap_file
,"%p");
8168 new = sdscat(new,server
.vm_swap_file
);
8169 new = sdscatprintf(new,"%ld",(long) getpid());
8170 new = sdscat(new,p
+2);
8171 zfree(server
.vm_swap_file
);
8172 server
.vm_swap_file
= new;
8175 static void vmInit(void) {
8180 if (server
.vm_max_threads
!= 0)
8181 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
8183 expandVmSwapFilename();
8184 redisLog(REDIS_NOTICE
,"Using '%s' as swap file",server
.vm_swap_file
);
8185 if ((server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b")) == NULL
) {
8186 server
.vm_fp
= fopen(server
.vm_swap_file
,"w+b");
8188 if (server
.vm_fp
== NULL
) {
8189 redisLog(REDIS_WARNING
,
8190 "Impossible to open the swap file: %s. Exiting.",
8194 server
.vm_fd
= fileno(server
.vm_fp
);
8195 server
.vm_next_page
= 0;
8196 server
.vm_near_pages
= 0;
8197 server
.vm_stats_used_pages
= 0;
8198 server
.vm_stats_swapped_objects
= 0;
8199 server
.vm_stats_swapouts
= 0;
8200 server
.vm_stats_swapins
= 0;
8201 totsize
= server
.vm_pages
*server
.vm_page_size
;
8202 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
8203 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
8204 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
8208 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
8210 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
8211 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
8212 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
8213 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
8215 /* Initialize threaded I/O (used by Virtual Memory) */
8216 server
.io_newjobs
= listCreate();
8217 server
.io_processing
= listCreate();
8218 server
.io_processed
= listCreate();
8219 server
.io_ready_clients
= listCreate();
8220 pthread_mutex_init(&server
.io_mutex
,NULL
);
8221 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
8222 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
8223 server
.io_active_threads
= 0;
8224 if (pipe(pipefds
) == -1) {
8225 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
8229 server
.io_ready_pipe_read
= pipefds
[0];
8230 server
.io_ready_pipe_write
= pipefds
[1];
8231 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
8232 /* LZF requires a lot of stack */
8233 pthread_attr_init(&server
.io_threads_attr
);
8234 pthread_attr_getstacksize(&server
.io_threads_attr
, &stacksize
);
8235 while (stacksize
< REDIS_THREAD_STACK_SIZE
) stacksize
*= 2;
8236 pthread_attr_setstacksize(&server
.io_threads_attr
, stacksize
);
8237 /* Listen for events in the threaded I/O pipe */
8238 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
8239 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
8240 oom("creating file event");
8243 /* Mark the page as used */
8244 static void vmMarkPageUsed(off_t page
) {
8245 off_t byte
= page
/8;
8247 redisAssert(vmFreePage(page
) == 1);
8248 server
.vm_bitmap
[byte
] |= 1<<bit
;
8251 /* Mark N contiguous pages as used, with 'page' being the first. */
8252 static void vmMarkPagesUsed(off_t page
, off_t count
) {
8255 for (j
= 0; j
< count
; j
++)
8256 vmMarkPageUsed(page
+j
);
8257 server
.vm_stats_used_pages
+= count
;
8258 redisLog(REDIS_DEBUG
,"Mark USED pages: %lld pages at %lld\n",
8259 (long long)count
, (long long)page
);
8262 /* Mark the page as free */
8263 static void vmMarkPageFree(off_t page
) {
8264 off_t byte
= page
/8;
8266 redisAssert(vmFreePage(page
) == 0);
8267 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
8270 /* Mark N contiguous pages as free, with 'page' being the first. */
8271 static void vmMarkPagesFree(off_t page
, off_t count
) {
8274 for (j
= 0; j
< count
; j
++)
8275 vmMarkPageFree(page
+j
);
8276 server
.vm_stats_used_pages
-= count
;
8277 redisLog(REDIS_DEBUG
,"Mark FREE pages: %lld pages at %lld\n",
8278 (long long)count
, (long long)page
);
8281 /* Test if the page is free */
8282 static int vmFreePage(off_t page
) {
8283 off_t byte
= page
/8;
8285 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
8288 /* Find N contiguous free pages storing the first page of the cluster in *first.
8289 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
8290 * REDIS_ERR is returned.
8292 * This function uses a simple algorithm: we try to allocate
8293 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
8294 * again from the start of the swap file searching for free spaces.
8296 * If it looks pretty clear that there are no free pages near our offset
8297 * we try to find less populated places doing a forward jump of
8298 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
8299 * without hurry, and then we jump again and so forth...
8301 * This function can be improved using a free list to avoid to guess
8302 * too much, since we could collect data about freed pages.
8304 * note: I implemented this function just after watching an episode of
8305 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
8307 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
8308 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
8310 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
8311 server
.vm_near_pages
= 0;
8312 server
.vm_next_page
= 0;
8314 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
8315 base
= server
.vm_next_page
;
8317 while(offset
< server
.vm_pages
) {
8318 off_t
this = base
+offset
;
8320 /* If we overflow, restart from page zero */
8321 if (this >= server
.vm_pages
) {
8322 this -= server
.vm_pages
;
8324 /* Just overflowed, what we found on tail is no longer
8325 * interesting, as it's no longer contiguous. */
8329 if (vmFreePage(this)) {
8330 /* This is a free page */
8332 /* Already got N free pages? Return to the caller, with success */
8334 *first
= this-(n
-1);
8335 server
.vm_next_page
= this+1;
8336 redisLog(REDIS_DEBUG
, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n
, (long long) *first
);
8340 /* The current one is not a free page */
8344 /* Fast-forward if the current page is not free and we already
8345 * searched enough near this place. */
8347 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
8348 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
8350 /* Note that even if we rewind after the jump, we are don't need
8351 * to make sure numfree is set to zero as we only jump *if* it
8352 * is set to zero. */
8354 /* Otherwise just check the next page */
8361 /* Write the specified object at the specified page of the swap file */
8362 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
8363 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8364 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8365 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8366 redisLog(REDIS_WARNING
,
8367 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
8371 rdbSaveObject(server
.vm_fp
,o
);
8372 fflush(server
.vm_fp
);
8373 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8377 /* Swap the 'val' object relative to 'key' into disk. Store all the information
8378 * needed to later retrieve the object into the key object.
8379 * If we can't find enough contiguous empty pages to swap the object on disk
8380 * REDIS_ERR is returned. */
8381 static int vmSwapObjectBlocking(robj
*key
, robj
*val
) {
8382 off_t pages
= rdbSavedObjectPages(val
,NULL
);
8385 assert(key
->storage
== REDIS_VM_MEMORY
);
8386 assert(key
->refcount
== 1);
8387 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
8388 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return REDIS_ERR
;
8389 key
->vm
.page
= page
;
8390 key
->vm
.usedpages
= pages
;
8391 key
->storage
= REDIS_VM_SWAPPED
;
8392 key
->vtype
= val
->type
;
8393 decrRefCount(val
); /* Deallocate the object from memory. */
8394 vmMarkPagesUsed(page
,pages
);
8395 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
8396 (unsigned char*) key
->ptr
,
8397 (unsigned long long) page
, (unsigned long long) pages
);
8398 server
.vm_stats_swapped_objects
++;
8399 server
.vm_stats_swapouts
++;
8403 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
8406 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8407 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8408 redisLog(REDIS_WARNING
,
8409 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
8413 o
= rdbLoadObject(type
,server
.vm_fp
);
8415 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno
));
8418 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8422 /* Load the value object relative to the 'key' object from swap to memory.
8423 * The newly allocated object is returned.
8425 * If preview is true the unserialized object is returned to the caller but
8426 * no changes are made to the key object, nor the pages are marked as freed */
8427 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
8430 redisAssert(key
->storage
== REDIS_VM_SWAPPED
|| key
->storage
== REDIS_VM_LOADING
);
8431 val
= vmReadObjectFromSwap(key
->vm
.page
,key
->vtype
);
8433 key
->storage
= REDIS_VM_MEMORY
;
8434 key
->vm
.atime
= server
.unixtime
;
8435 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8436 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
8437 (unsigned char*) key
->ptr
);
8438 server
.vm_stats_swapped_objects
--;
8440 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
8441 (unsigned char*) key
->ptr
);
8443 server
.vm_stats_swapins
++;
8447 /* Plain object loading, from swap to memory */
8448 static robj
*vmLoadObject(robj
*key
) {
8449 /* If we are loading the object in background, stop it, we
8450 * need to load this object synchronously ASAP. */
8451 if (key
->storage
== REDIS_VM_LOADING
)
8452 vmCancelThreadedIOJob(key
);
8453 return vmGenericLoadObject(key
,0);
8456 /* Just load the value on disk, without to modify the key.
8457 * This is useful when we want to perform some operation on the value
8458 * without to really bring it from swap to memory, like while saving the
8459 * dataset or rewriting the append only log. */
8460 static robj
*vmPreviewObject(robj
*key
) {
8461 return vmGenericLoadObject(key
,1);
8464 /* How a good candidate is this object for swapping?
8465 * The better candidate it is, the greater the returned value.
8467 * Currently we try to perform a fast estimation of the object size in
8468 * memory, and combine it with aging informations.
8470 * Basically swappability = idle-time * log(estimated size)
8472 * Bigger objects are preferred over smaller objects, but not
8473 * proportionally, this is why we use the logarithm. This algorithm is
8474 * just a first try and will probably be tuned later. */
8475 static double computeObjectSwappability(robj
*o
) {
8476 time_t age
= server
.unixtime
- o
->vm
.atime
;
8480 struct dictEntry
*de
;
8483 if (age
<= 0) return 0;
8486 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
8489 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
8494 listNode
*ln
= listFirst(l
);
8496 asize
= sizeof(list
);
8498 robj
*ele
= ln
->value
;
8501 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8502 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8504 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
8509 z
= (o
->type
== REDIS_ZSET
);
8510 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
8512 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
8513 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
8518 de
= dictGetRandomKey(d
);
8519 ele
= dictGetEntryKey(de
);
8520 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8521 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8523 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
8524 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
8528 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
8529 unsigned char *p
= zipmapRewind((unsigned char*)o
->ptr
);
8530 unsigned int len
= zipmapLen((unsigned char*)o
->ptr
);
8531 unsigned int klen
, vlen
;
8532 unsigned char *key
, *val
;
8534 if ((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) == NULL
) {
8538 asize
= len
*(klen
+vlen
+3);
8539 } else if (o
->encoding
== REDIS_ENCODING_HT
) {
8541 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
8546 de
= dictGetRandomKey(d
);
8547 ele
= dictGetEntryKey(de
);
8548 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8549 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8551 ele
= dictGetEntryVal(de
);
8552 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8553 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8555 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
8560 return (double)age
*log(1+asize
);
8563 /* Try to swap an object that's a good candidate for swapping.
8564 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
8565 * to swap any object at all.
8567 * If 'usethreaded' is true, Redis will try to swap the object in background
8568 * using I/O threads. */
8569 static int vmSwapOneObject(int usethreads
) {
8571 struct dictEntry
*best
= NULL
;
8572 double best_swappability
= 0;
8573 redisDb
*best_db
= NULL
;
8576 for (j
= 0; j
< server
.dbnum
; j
++) {
8577 redisDb
*db
= server
.db
+j
;
8578 /* Why maxtries is set to 100?
8579 * Because this way (usually) we'll find 1 object even if just 1% - 2%
8580 * are swappable objects */
8583 if (dictSize(db
->dict
) == 0) continue;
8584 for (i
= 0; i
< 5; i
++) {
8586 double swappability
;
8588 if (maxtries
) maxtries
--;
8589 de
= dictGetRandomKey(db
->dict
);
8590 key
= dictGetEntryKey(de
);
8591 val
= dictGetEntryVal(de
);
8592 /* Only swap objects that are currently in memory.
8594 * Also don't swap shared objects if threaded VM is on, as we
8595 * try to ensure that the main thread does not touch the
8596 * object while the I/O thread is using it, but we can't
8597 * control other keys without adding additional mutex. */
8598 if (key
->storage
!= REDIS_VM_MEMORY
||
8599 (server
.vm_max_threads
!= 0 && val
->refcount
!= 1)) {
8600 if (maxtries
) i
--; /* don't count this try */
8603 swappability
= computeObjectSwappability(val
);
8604 if (!best
|| swappability
> best_swappability
) {
8606 best_swappability
= swappability
;
8611 if (best
== NULL
) return REDIS_ERR
;
8612 key
= dictGetEntryKey(best
);
8613 val
= dictGetEntryVal(best
);
8615 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
8616 key
->ptr
, best_swappability
);
8618 /* Unshare the key if needed */
8619 if (key
->refcount
> 1) {
8620 robj
*newkey
= dupStringObject(key
);
8622 key
= dictGetEntryKey(best
) = newkey
;
8626 vmSwapObjectThreaded(key
,val
,best_db
);
8629 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
8630 dictGetEntryVal(best
) = NULL
;
8638 static int vmSwapOneObjectBlocking() {
8639 return vmSwapOneObject(0);
8642 static int vmSwapOneObjectThreaded() {
8643 return vmSwapOneObject(1);
8646 /* Return true if it's safe to swap out objects in a given moment.
8647 * Basically we don't want to swap objects out while there is a BGSAVE
8648 * or a BGAEOREWRITE running in backgroud. */
8649 static int vmCanSwapOut(void) {
8650 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
8653 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
8654 * and was deleted. Otherwise 0 is returned. */
8655 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
8659 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
8660 foundkey
= dictGetEntryKey(de
);
8661 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
8666 /* =================== Virtual Memory - Threaded I/O ======================= */
8668 static void freeIOJob(iojob
*j
) {
8669 if ((j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
8670 j
->type
== REDIS_IOJOB_DO_SWAP
||
8671 j
->type
== REDIS_IOJOB_LOAD
) && j
->val
!= NULL
)
8672 decrRefCount(j
->val
);
8673 decrRefCount(j
->key
);
8677 /* Every time a thread finished a Job, it writes a byte into the write side
8678 * of an unix pipe in order to "awake" the main thread, and this function
8680 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
8684 int retval
, processed
= 0, toprocess
= -1, trytoswap
= 1;
8686 REDIS_NOTUSED(mask
);
8687 REDIS_NOTUSED(privdata
);
8689 /* For every byte we read in the read side of the pipe, there is one
8690 * I/O job completed to process. */
8691 while((retval
= read(fd
,buf
,1)) == 1) {
8695 struct dictEntry
*de
;
8697 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
8699 /* Get the processed element (the oldest one) */
8701 assert(listLength(server
.io_processed
) != 0);
8702 if (toprocess
== -1) {
8703 toprocess
= (listLength(server
.io_processed
)*REDIS_MAX_COMPLETED_JOBS_PROCESSED
)/100;
8704 if (toprocess
<= 0) toprocess
= 1;
8706 ln
= listFirst(server
.io_processed
);
8708 listDelNode(server
.io_processed
,ln
);
8710 /* If this job is marked as canceled, just ignore it */
8715 /* Post process it in the main thread, as there are things we
8716 * can do just here to avoid race conditions and/or invasive locks */
8717 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
);
8718 de
= dictFind(j
->db
->dict
,j
->key
);
8720 key
= dictGetEntryKey(de
);
8721 if (j
->type
== REDIS_IOJOB_LOAD
) {
8724 /* Key loaded, bring it at home */
8725 key
->storage
= REDIS_VM_MEMORY
;
8726 key
->vm
.atime
= server
.unixtime
;
8727 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8728 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
8729 (unsigned char*) key
->ptr
);
8730 server
.vm_stats_swapped_objects
--;
8731 server
.vm_stats_swapins
++;
8732 dictGetEntryVal(de
) = j
->val
;
8733 incrRefCount(j
->val
);
8736 /* Handle clients waiting for this key to be loaded. */
8737 handleClientsBlockedOnSwappedKey(db
,key
);
8738 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
8739 /* Now we know the amount of pages required to swap this object.
8740 * Let's find some space for it, and queue this task again
8741 * rebranded as REDIS_IOJOB_DO_SWAP. */
8742 if (!vmCanSwapOut() ||
8743 vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
)
8745 /* Ooops... no space or we can't swap as there is
8746 * a fork()ed Redis trying to save stuff on disk. */
8748 key
->storage
= REDIS_VM_MEMORY
; /* undo operation */
8750 /* Note that we need to mark this pages as used now,
8751 * if the job will be canceled, we'll mark them as freed
8753 vmMarkPagesUsed(j
->page
,j
->pages
);
8754 j
->type
= REDIS_IOJOB_DO_SWAP
;
8759 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
8762 /* Key swapped. We can finally free some memory. */
8763 if (key
->storage
!= REDIS_VM_SWAPPING
) {
8764 printf("key->storage: %d\n",key
->storage
);
8765 printf("key->name: %s\n",(char*)key
->ptr
);
8766 printf("key->refcount: %d\n",key
->refcount
);
8767 printf("val: %p\n",(void*)j
->val
);
8768 printf("val->type: %d\n",j
->val
->type
);
8769 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
8771 redisAssert(key
->storage
== REDIS_VM_SWAPPING
);
8772 val
= dictGetEntryVal(de
);
8773 key
->vm
.page
= j
->page
;
8774 key
->vm
.usedpages
= j
->pages
;
8775 key
->storage
= REDIS_VM_SWAPPED
;
8776 key
->vtype
= j
->val
->type
;
8777 decrRefCount(val
); /* Deallocate the object from memory. */
8778 dictGetEntryVal(de
) = NULL
;
8779 redisLog(REDIS_DEBUG
,
8780 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
8781 (unsigned char*) key
->ptr
,
8782 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
8783 server
.vm_stats_swapped_objects
++;
8784 server
.vm_stats_swapouts
++;
8786 /* Put a few more swap requests in queue if we are still
8788 if (trytoswap
&& vmCanSwapOut() &&
8789 zmalloc_used_memory() > server
.vm_max_memory
)
8794 more
= listLength(server
.io_newjobs
) <
8795 (unsigned) server
.vm_max_threads
;
8797 /* Don't waste CPU time if swappable objects are rare. */
8798 if (vmSwapOneObjectThreaded() == REDIS_ERR
) {
8806 if (processed
== toprocess
) return;
8808 if (retval
< 0 && errno
!= EAGAIN
) {
8809 redisLog(REDIS_WARNING
,
8810 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
8815 static void lockThreadedIO(void) {
8816 pthread_mutex_lock(&server
.io_mutex
);
8819 static void unlockThreadedIO(void) {
8820 pthread_mutex_unlock(&server
.io_mutex
);
8823 /* Remove the specified object from the threaded I/O queue if still not
8824 * processed, otherwise make sure to flag it as canceled. */
8825 static void vmCancelThreadedIOJob(robj
*o
) {
8827 server
.io_newjobs
, /* 0 */
8828 server
.io_processing
, /* 1 */
8829 server
.io_processed
/* 2 */
8833 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
8836 /* Search for a matching key in one of the queues */
8837 for (i
= 0; i
< 3; i
++) {
8841 listRewind(lists
[i
],&li
);
8842 while ((ln
= listNext(&li
)) != NULL
) {
8843 iojob
*job
= ln
->value
;
8845 if (job
->canceled
) continue; /* Skip this, already canceled. */
8846 if (compareStringObjects(job
->key
,o
) == 0) {
8847 redisLog(REDIS_DEBUG
,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
8848 (void*)job
, (char*)o
->ptr
, job
->type
, i
);
8849 /* Mark the pages as free since the swap didn't happened
8850 * or happened but is now discarded. */
8851 if (i
!= 1 && job
->type
== REDIS_IOJOB_DO_SWAP
)
8852 vmMarkPagesFree(job
->page
,job
->pages
);
8853 /* Cancel the job. It depends on the list the job is
8856 case 0: /* io_newjobs */
8857 /* If the job was yet not processed the best thing to do
8858 * is to remove it from the queue at all */
8860 listDelNode(lists
[i
],ln
);
8862 case 1: /* io_processing */
8863 /* Oh Shi- the thread is messing with the Job:
8865 * Probably it's accessing the object if this is a
8866 * PREPARE_SWAP or DO_SWAP job.
8867 * If it's a LOAD job it may be reading from disk and
8868 * if we don't wait for the job to terminate before to
8869 * cancel it, maybe in a few microseconds data can be
8870 * corrupted in this pages. So the short story is:
8872 * Better to wait for the job to move into the
8873 * next queue (processed)... */
8875 /* We try again and again until the job is completed. */
8877 /* But let's wait some time for the I/O thread
8878 * to finish with this job. After all this condition
8879 * should be very rare. */
8882 case 2: /* io_processed */
8883 /* The job was already processed, that's easy...
8884 * just mark it as canceled so that we'll ignore it
8885 * when processing completed jobs. */
8889 /* Finally we have to adjust the storage type of the object
8890 * in order to "UNDO" the operaiton. */
8891 if (o
->storage
== REDIS_VM_LOADING
)
8892 o
->storage
= REDIS_VM_SWAPPED
;
8893 else if (o
->storage
== REDIS_VM_SWAPPING
)
8894 o
->storage
= REDIS_VM_MEMORY
;
8901 assert(1 != 1); /* We should never reach this */
8904 static void *IOThreadEntryPoint(void *arg
) {
8909 pthread_detach(pthread_self());
8911 /* Get a new job to process */
8913 if (listLength(server
.io_newjobs
) == 0) {
8914 /* No new jobs in queue, exit. */
8915 redisLog(REDIS_DEBUG
,"Thread %ld exiting, nothing to do",
8916 (long) pthread_self());
8917 server
.io_active_threads
--;
8921 ln
= listFirst(server
.io_newjobs
);
8923 listDelNode(server
.io_newjobs
,ln
);
8924 /* Add the job in the processing queue */
8925 j
->thread
= pthread_self();
8926 listAddNodeTail(server
.io_processing
,j
);
8927 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
8929 redisLog(REDIS_DEBUG
,"Thread %ld got a new job (type %d): %p about key '%s'",
8930 (long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
8932 /* Process the Job */
8933 if (j
->type
== REDIS_IOJOB_LOAD
) {
8934 j
->val
= vmReadObjectFromSwap(j
->page
,j
->key
->vtype
);
8935 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
8936 FILE *fp
= fopen("/dev/null","w+");
8937 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
8939 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
8940 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
8944 /* Done: insert the job into the processed queue */
8945 redisLog(REDIS_DEBUG
,"Thread %ld completed the job: %p (key %s)",
8946 (long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
8948 listDelNode(server
.io_processing
,ln
);
8949 listAddNodeTail(server
.io_processed
,j
);
8952 /* Signal the main thread there is new stuff to process */
8953 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
8955 return NULL
; /* never reached */
8958 static void spawnIOThread(void) {
8960 sigset_t mask
, omask
;
8964 sigaddset(&mask
,SIGCHLD
);
8965 sigaddset(&mask
,SIGHUP
);
8966 sigaddset(&mask
,SIGPIPE
);
8967 pthread_sigmask(SIG_SETMASK
, &mask
, &omask
);
8968 while ((err
= pthread_create(&thread
,&server
.io_threads_attr
,IOThreadEntryPoint
,NULL
)) != 0) {
8969 redisLog(REDIS_WARNING
,"Unable to spawn an I/O thread: %s",
8973 pthread_sigmask(SIG_SETMASK
, &omask
, NULL
);
8974 server
.io_active_threads
++;
8977 /* We need to wait for the last thread to exit before we are able to
8978 * fork() in order to BGSAVE or BGREWRITEAOF. */
8979 static void waitEmptyIOJobsQueue(void) {
8981 int io_processed_len
;
8984 if (listLength(server
.io_newjobs
) == 0 &&
8985 listLength(server
.io_processing
) == 0 &&
8986 server
.io_active_threads
== 0)
8991 /* While waiting for empty jobs queue condition we post-process some
8992 * finshed job, as I/O threads may be hanging trying to write against
8993 * the io_ready_pipe_write FD but there are so much pending jobs that
8995 io_processed_len
= listLength(server
.io_processed
);
8997 if (io_processed_len
) {
8998 vmThreadedIOCompletedJob(NULL
,server
.io_ready_pipe_read
,NULL
,0);
8999 usleep(1000); /* 1 millisecond */
9001 usleep(10000); /* 10 milliseconds */
9006 static void vmReopenSwapFile(void) {
9007 /* Note: we don't close the old one as we are in the child process
9008 * and don't want to mess at all with the original file object. */
9009 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
9010 if (server
.vm_fp
== NULL
) {
9011 redisLog(REDIS_WARNING
,"Can't re-open the VM swap file: %s. Exiting.",
9012 server
.vm_swap_file
);
9015 server
.vm_fd
= fileno(server
.vm_fp
);
9018 /* This function must be called while with threaded IO locked */
9019 static void queueIOJob(iojob
*j
) {
9020 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
9021 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
9022 listAddNodeTail(server
.io_newjobs
,j
);
9023 if (server
.io_active_threads
< server
.vm_max_threads
)
9027 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
9030 assert(key
->storage
== REDIS_VM_MEMORY
);
9031 assert(key
->refcount
== 1);
9033 j
= zmalloc(sizeof(*j
));
9034 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
9036 j
->key
= dupStringObject(key
);
9040 j
->thread
= (pthread_t
) -1;
9041 key
->storage
= REDIS_VM_SWAPPING
;
9049 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
9051 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
9052 * If there is not already a job loading the key, it is craeted.
9053 * The key is added to the io_keys list in the client structure, and also
9054 * in the hash table mapping swapped keys to waiting clients, that is,
9055 * server.io_waited_keys. */
9056 static int waitForSwappedKey(redisClient
*c
, robj
*key
) {
9057 struct dictEntry
*de
;
9061 /* If the key does not exist or is already in RAM we don't need to
9062 * block the client at all. */
9063 de
= dictFind(c
->db
->dict
,key
);
9064 if (de
== NULL
) return 0;
9065 o
= dictGetEntryKey(de
);
9066 if (o
->storage
== REDIS_VM_MEMORY
) {
9068 } else if (o
->storage
== REDIS_VM_SWAPPING
) {
9069 /* We were swapping the key, undo it! */
9070 vmCancelThreadedIOJob(o
);
9074 /* OK: the key is either swapped, or being loaded just now. */
9076 /* Add the key to the list of keys this client is waiting for.
9077 * This maps clients to keys they are waiting for. */
9078 listAddNodeTail(c
->io_keys
,key
);
9081 /* Add the client to the swapped keys => clients waiting map. */
9082 de
= dictFind(c
->db
->io_keys
,key
);
9086 /* For every key we take a list of clients blocked for it */
9088 retval
= dictAdd(c
->db
->io_keys
,key
,l
);
9090 assert(retval
== DICT_OK
);
9092 l
= dictGetEntryVal(de
);
9094 listAddNodeTail(l
,c
);
9096 /* Are we already loading the key from disk? If not create a job */
9097 if (o
->storage
== REDIS_VM_SWAPPED
) {
9100 o
->storage
= REDIS_VM_LOADING
;
9101 j
= zmalloc(sizeof(*j
));
9102 j
->type
= REDIS_IOJOB_LOAD
;
9104 j
->key
= dupStringObject(key
);
9105 j
->key
->vtype
= o
->vtype
;
9106 j
->page
= o
->vm
.page
;
9109 j
->thread
= (pthread_t
) -1;
9117 /* Preload keys needed for the ZUNION and ZINTER commands. */
9118 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
) {
9120 num
= atoi(c
->argv
[2]->ptr
);
9121 for (i
= 0; i
< num
; i
++) {
9122 waitForSwappedKey(c
,c
->argv
[3+i
]);
9126 /* Is this client attempting to run a command against swapped keys?
9127 * If so, block it ASAP, load the keys in background, then resume it.
9129 * The important idea about this function is that it can fail! If keys will
9130 * still be swapped when the client is resumed, this key lookups will
9131 * just block loading keys from disk. In practical terms this should only
9132 * happen with SORT BY command or if there is a bug in this function.
9134 * Return 1 if the client is marked as blocked, 0 if the client can
9135 * continue as the keys it is going to access appear to be in memory. */
9136 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
) {
9139 if (cmd
->vm_preload_proc
!= NULL
) {
9140 cmd
->vm_preload_proc(c
);
9142 if (cmd
->vm_firstkey
== 0) return 0;
9143 last
= cmd
->vm_lastkey
;
9144 if (last
< 0) last
= c
->argc
+last
;
9145 for (j
= cmd
->vm_firstkey
; j
<= last
; j
+= cmd
->vm_keystep
)
9146 waitForSwappedKey(c
,c
->argv
[j
]);
9149 /* If the client was blocked for at least one key, mark it as blocked. */
9150 if (listLength(c
->io_keys
)) {
9151 c
->flags
|= REDIS_IO_WAIT
;
9152 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
9153 server
.vm_blocked_clients
++;
9160 /* Remove the 'key' from the list of blocked keys for a given client.
9162 * The function returns 1 when there are no longer blocking keys after
9163 * the current one was removed (and the client can be unblocked). */
9164 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
) {
9168 struct dictEntry
*de
;
9170 /* Remove the key from the list of keys this client is waiting for. */
9171 listRewind(c
->io_keys
,&li
);
9172 while ((ln
= listNext(&li
)) != NULL
) {
9173 if (compareStringObjects(ln
->value
,key
) == 0) {
9174 listDelNode(c
->io_keys
,ln
);
9180 /* Remove the client form the key => waiting clients map. */
9181 de
= dictFind(c
->db
->io_keys
,key
);
9183 l
= dictGetEntryVal(de
);
9184 ln
= listSearchKey(l
,c
);
9187 if (listLength(l
) == 0)
9188 dictDelete(c
->db
->io_keys
,key
);
9190 return listLength(c
->io_keys
) == 0;
9193 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
) {
9194 struct dictEntry
*de
;
9199 de
= dictFind(db
->io_keys
,key
);
9202 l
= dictGetEntryVal(de
);
9203 len
= listLength(l
);
9204 /* Note: we can't use something like while(listLength(l)) as the list
9205 * can be freed by the calling function when we remove the last element. */
9208 redisClient
*c
= ln
->value
;
9210 if (dontWaitForSwappedKey(c
,key
)) {
9211 /* Put the client in the list of clients ready to go as we
9212 * loaded all the keys about it. */
9213 listAddNodeTail(server
.io_ready_clients
,c
);
9218 /* =========================== Remote Configuration ========================= */
9220 static void configSetCommand(redisClient
*c
) {
9221 robj
*o
= getDecodedObject(c
->argv
[3]);
9222 if (!strcasecmp(c
->argv
[2]->ptr
,"dbfilename")) {
9223 zfree(server
.dbfilename
);
9224 server
.dbfilename
= zstrdup(o
->ptr
);
9225 } else if (!strcasecmp(c
->argv
[2]->ptr
,"requirepass")) {
9226 zfree(server
.requirepass
);
9227 server
.requirepass
= zstrdup(o
->ptr
);
9228 } else if (!strcasecmp(c
->argv
[2]->ptr
,"masterauth")) {
9229 zfree(server
.masterauth
);
9230 server
.masterauth
= zstrdup(o
->ptr
);
9231 } else if (!strcasecmp(c
->argv
[2]->ptr
,"maxmemory")) {
9232 server
.maxmemory
= strtoll(o
->ptr
, NULL
, 10);
9234 addReplySds(c
,sdscatprintf(sdsempty(),
9235 "-ERR not supported CONFIG parameter %s\r\n",
9236 (char*)c
->argv
[2]->ptr
));
9241 addReply(c
,shared
.ok
);
9244 static void configGetCommand(redisClient
*c
) {
9245 robj
*o
= getDecodedObject(c
->argv
[2]);
9246 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
9247 char *pattern
= o
->ptr
;
9251 decrRefCount(lenobj
);
9253 if (stringmatch(pattern
,"dbfilename",0)) {
9254 addReplyBulkCString(c
,"dbfilename");
9255 addReplyBulkCString(c
,server
.dbfilename
);
9258 if (stringmatch(pattern
,"requirepass",0)) {
9259 addReplyBulkCString(c
,"requirepass");
9260 addReplyBulkCString(c
,server
.requirepass
);
9263 if (stringmatch(pattern
,"masterauth",0)) {
9264 addReplyBulkCString(c
,"masterauth");
9265 addReplyBulkCString(c
,server
.masterauth
);
9268 if (stringmatch(pattern
,"maxmemory",0)) {
9271 snprintf(buf
,128,"%llu\n",server
.maxmemory
);
9272 addReplyBulkCString(c
,"maxmemory");
9273 addReplyBulkCString(c
,buf
);
9277 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%d\r\n",matches
*2);
9280 static void configCommand(redisClient
*c
) {
9281 if (!strcasecmp(c
->argv
[1]->ptr
,"set")) {
9282 if (c
->argc
!= 4) goto badarity
;
9283 configSetCommand(c
);
9284 } else if (!strcasecmp(c
->argv
[1]->ptr
,"get")) {
9285 if (c
->argc
!= 3) goto badarity
;
9286 configGetCommand(c
);
9287 } else if (!strcasecmp(c
->argv
[1]->ptr
,"resetstat")) {
9288 if (c
->argc
!= 2) goto badarity
;
9289 server
.stat_numcommands
= 0;
9290 server
.stat_numconnections
= 0;
9291 server
.stat_expiredkeys
= 0;
9292 server
.stat_starttime
= time(NULL
);
9293 addReply(c
,shared
.ok
);
9295 addReplySds(c
,sdscatprintf(sdsempty(),
9296 "-ERR CONFIG subcommand must be one of GET, SET, RESETSTAT\r\n"));
9301 addReplySds(c
,sdscatprintf(sdsempty(),
9302 "-ERR Wrong number of arguments for CONFIG %s\r\n",
9303 (char*) c
->argv
[1]->ptr
));
9306 /* =========================== Pubsub implementation ======================== */
9308 static void freePubsubPattern(void *p
) {
9309 pubsubPattern
*pat
= p
;
9311 decrRefCount(pat
->pattern
);
9315 static int listMatchPubsubPattern(void *a
, void *b
) {
9316 pubsubPattern
*pa
= a
, *pb
= b
;
9318 return (pa
->client
== pb
->client
) &&
9319 (compareStringObjects(pa
->pattern
,pb
->pattern
) == 0);
9322 /* Subscribe a client to a channel. Returns 1 if the operation succeeded, or
9323 * 0 if the client was already subscribed to that channel. */
9324 static int pubsubSubscribeChannel(redisClient
*c
, robj
*channel
) {
9325 struct dictEntry
*de
;
9326 list
*clients
= NULL
;
9329 /* Add the channel to the client -> channels hash table */
9330 if (dictAdd(c
->pubsub_channels
,channel
,NULL
) == DICT_OK
) {
9332 incrRefCount(channel
);
9333 /* Add the client to the channel -> list of clients hash table */
9334 de
= dictFind(server
.pubsub_channels
,channel
);
9336 clients
= listCreate();
9337 dictAdd(server
.pubsub_channels
,channel
,clients
);
9338 incrRefCount(channel
);
9340 clients
= dictGetEntryVal(de
);
9342 listAddNodeTail(clients
,c
);
9344 /* Notify the client */
9345 addReply(c
,shared
.mbulk3
);
9346 addReply(c
,shared
.subscribebulk
);
9347 addReplyBulk(c
,channel
);
9348 addReplyLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
9352 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9353 * 0 if the client was not subscribed to the specified channel. */
9354 static int pubsubUnsubscribeChannel(redisClient
*c
, robj
*channel
, int notify
) {
9355 struct dictEntry
*de
;
9360 /* Remove the channel from the client -> channels hash table */
9361 incrRefCount(channel
); /* channel may be just a pointer to the same object
9362 we have in the hash tables. Protect it... */
9363 if (dictDelete(c
->pubsub_channels
,channel
) == DICT_OK
) {
9365 /* Remove the client from the channel -> clients list hash table */
9366 de
= dictFind(server
.pubsub_channels
,channel
);
9368 clients
= dictGetEntryVal(de
);
9369 ln
= listSearchKey(clients
,c
);
9371 listDelNode(clients
,ln
);
9372 if (listLength(clients
) == 0) {
9373 /* Free the list and associated hash entry at all if this was
9374 * the latest client, so that it will be possible to abuse
9375 * Redis PUBSUB creating millions of channels. */
9376 dictDelete(server
.pubsub_channels
,channel
);
9379 /* Notify the client */
9381 addReply(c
,shared
.mbulk3
);
9382 addReply(c
,shared
.unsubscribebulk
);
9383 addReplyBulk(c
,channel
);
9384 addReplyLong(c
,dictSize(c
->pubsub_channels
)+
9385 listLength(c
->pubsub_patterns
));
9388 decrRefCount(channel
); /* it is finally safe to release it */
9392 /* Subscribe a client to a pattern. Returns 1 if the operation succeeded, or 0 if the clinet was already subscribed to that pattern. */
9393 static int pubsubSubscribePattern(redisClient
*c
, robj
*pattern
) {
9396 if (listSearchKey(c
->pubsub_patterns
,pattern
) == NULL
) {
9399 listAddNodeTail(c
->pubsub_patterns
,pattern
);
9400 incrRefCount(pattern
);
9401 pat
= zmalloc(sizeof(*pat
));
9402 pat
->pattern
= getDecodedObject(pattern
);
9404 listAddNodeTail(server
.pubsub_patterns
,pat
);
9406 /* Notify the client */
9407 addReply(c
,shared
.mbulk3
);
9408 addReply(c
,shared
.psubscribebulk
);
9409 addReplyBulk(c
,pattern
);
9410 addReplyLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
9414 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9415 * 0 if the client was not subscribed to the specified channel. */
9416 static int pubsubUnsubscribePattern(redisClient
*c
, robj
*pattern
, int notify
) {
9421 incrRefCount(pattern
); /* Protect the object. May be the same we remove */
9422 if ((ln
= listSearchKey(c
->pubsub_patterns
,pattern
)) != NULL
) {
9424 listDelNode(c
->pubsub_patterns
,ln
);
9426 pat
.pattern
= pattern
;
9427 ln
= listSearchKey(server
.pubsub_patterns
,&pat
);
9428 listDelNode(server
.pubsub_patterns
,ln
);
9430 /* Notify the client */
9432 addReply(c
,shared
.mbulk3
);
9433 addReply(c
,shared
.punsubscribebulk
);
9434 addReplyBulk(c
,pattern
);
9435 addReplyLong(c
,dictSize(c
->pubsub_channels
)+
9436 listLength(c
->pubsub_patterns
));
9438 decrRefCount(pattern
);
9442 /* Unsubscribe from all the channels. Return the number of channels the
9443 * client was subscribed from. */
9444 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
) {
9445 dictIterator
*di
= dictGetIterator(c
->pubsub_channels
);
9449 while((de
= dictNext(di
)) != NULL
) {
9450 robj
*channel
= dictGetEntryKey(de
);
9452 count
+= pubsubUnsubscribeChannel(c
,channel
,notify
);
9454 dictReleaseIterator(di
);
9458 /* Unsubscribe from all the patterns. Return the number of patterns the
9459 * client was subscribed from. */
9460 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
) {
9465 listRewind(c
->pubsub_patterns
,&li
);
9466 while ((ln
= listNext(&li
)) != NULL
) {
9467 robj
*pattern
= ln
->value
;
9469 count
+= pubsubUnsubscribePattern(c
,pattern
,notify
);
9474 /* Publish a message */
9475 static int pubsubPublishMessage(robj
*channel
, robj
*message
) {
9477 struct dictEntry
*de
;
9481 /* Send to clients listening for that channel */
9482 de
= dictFind(server
.pubsub_channels
,channel
);
9484 list
*list
= dictGetEntryVal(de
);
9488 listRewind(list
,&li
);
9489 while ((ln
= listNext(&li
)) != NULL
) {
9490 redisClient
*c
= ln
->value
;
9492 addReply(c
,shared
.mbulk3
);
9493 addReply(c
,shared
.messagebulk
);
9494 addReplyBulk(c
,channel
);
9495 addReplyBulk(c
,message
);
9499 /* Send to clients listening to matching channels */
9500 if (listLength(server
.pubsub_patterns
)) {
9501 listRewind(server
.pubsub_patterns
,&li
);
9502 channel
= getDecodedObject(channel
);
9503 while ((ln
= listNext(&li
)) != NULL
) {
9504 pubsubPattern
*pat
= ln
->value
;
9506 if (stringmatchlen((char*)pat
->pattern
->ptr
,
9507 sdslen(pat
->pattern
->ptr
),
9508 (char*)channel
->ptr
,
9509 sdslen(channel
->ptr
),0)) {
9510 addReply(pat
->client
,shared
.mbulk3
);
9511 addReply(pat
->client
,shared
.messagebulk
);
9512 addReplyBulk(pat
->client
,channel
);
9513 addReplyBulk(pat
->client
,message
);
9517 decrRefCount(channel
);
9522 static void subscribeCommand(redisClient
*c
) {
9525 for (j
= 1; j
< c
->argc
; j
++)
9526 pubsubSubscribeChannel(c
,c
->argv
[j
]);
9529 static void unsubscribeCommand(redisClient
*c
) {
9531 pubsubUnsubscribeAllChannels(c
,1);
9536 for (j
= 1; j
< c
->argc
; j
++)
9537 pubsubUnsubscribeChannel(c
,c
->argv
[j
],1);
9541 static void psubscribeCommand(redisClient
*c
) {
9544 for (j
= 1; j
< c
->argc
; j
++)
9545 pubsubSubscribePattern(c
,c
->argv
[j
]);
9548 static void punsubscribeCommand(redisClient
*c
) {
9550 pubsubUnsubscribeAllPatterns(c
,1);
9555 for (j
= 1; j
< c
->argc
; j
++)
9556 pubsubUnsubscribePattern(c
,c
->argv
[j
],1);
9560 static void publishCommand(redisClient
*c
) {
9561 int receivers
= pubsubPublishMessage(c
->argv
[1],c
->argv
[2]);
9562 addReplyLong(c
,receivers
);
9565 /* ================================= Debugging ============================== */
9567 static void debugCommand(redisClient
*c
) {
9568 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
9570 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
9571 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
9572 addReply(c
,shared
.err
);
9576 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
9577 addReply(c
,shared
.err
);
9580 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
9581 addReply(c
,shared
.ok
);
9582 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
9584 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
9585 addReply(c
,shared
.err
);
9588 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
9589 addReply(c
,shared
.ok
);
9590 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
9591 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
9595 addReply(c
,shared
.nokeyerr
);
9598 key
= dictGetEntryKey(de
);
9599 val
= dictGetEntryVal(de
);
9600 if (!server
.vm_enabled
|| (key
->storage
== REDIS_VM_MEMORY
||
9601 key
->storage
== REDIS_VM_SWAPPING
)) {
9605 if (val
->encoding
< (sizeof(strencoding
)/sizeof(char*))) {
9606 strenc
= strencoding
[val
->encoding
];
9608 snprintf(buf
,64,"unknown encoding %d\n", val
->encoding
);
9611 addReplySds(c
,sdscatprintf(sdsempty(),
9612 "+Key at:%p refcount:%d, value at:%p refcount:%d "
9613 "encoding:%s serializedlength:%lld\r\n",
9614 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
9615 strenc
, (long long) rdbSavedObjectLen(val
,NULL
)));
9617 addReplySds(c
,sdscatprintf(sdsempty(),
9618 "+Key at:%p refcount:%d, value swapped at: page %llu "
9619 "using %llu pages\r\n",
9620 (void*)key
, key
->refcount
, (unsigned long long) key
->vm
.page
,
9621 (unsigned long long) key
->vm
.usedpages
));
9623 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
9624 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
9627 if (!server
.vm_enabled
) {
9628 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
9632 addReply(c
,shared
.nokeyerr
);
9635 key
= dictGetEntryKey(de
);
9636 val
= dictGetEntryVal(de
);
9637 /* If the key is shared we want to create a copy */
9638 if (key
->refcount
> 1) {
9639 robj
*newkey
= dupStringObject(key
);
9641 key
= dictGetEntryKey(de
) = newkey
;
9644 if (key
->storage
!= REDIS_VM_MEMORY
) {
9645 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
9646 } else if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
9647 dictGetEntryVal(de
) = NULL
;
9648 addReply(c
,shared
.ok
);
9650 addReply(c
,shared
.err
);
9653 addReplySds(c
,sdsnew(
9654 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPOUT <key>|RELOAD]\r\n"));
9658 static void _redisAssert(char *estr
, char *file
, int line
) {
9659 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
9660 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true\n",file
,line
,estr
);
9661 #ifdef HAVE_BACKTRACE
9662 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
9667 /* =================================== Main! ================================ */
9670 int linuxOvercommitMemoryValue(void) {
9671 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
9675 if (fgets(buf
,64,fp
) == NULL
) {
9684 void linuxOvercommitMemoryWarning(void) {
9685 if (linuxOvercommitMemoryValue() == 0) {
9686 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.");
9689 #endif /* __linux__ */
9691 static void daemonize(void) {
9695 if (fork() != 0) exit(0); /* parent exits */
9696 setsid(); /* create a new session */
9698 /* Every output goes to /dev/null. If Redis is daemonized but
9699 * the 'logfile' is set to 'stdout' in the configuration file
9700 * it will not log at all. */
9701 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
9702 dup2(fd
, STDIN_FILENO
);
9703 dup2(fd
, STDOUT_FILENO
);
9704 dup2(fd
, STDERR_FILENO
);
9705 if (fd
> STDERR_FILENO
) close(fd
);
9707 /* Try to write the pid file */
9708 fp
= fopen(server
.pidfile
,"w");
9710 fprintf(fp
,"%d\n",getpid());
9715 static void version() {
9716 printf("Redis server version %s\n", REDIS_VERSION
);
9720 static void usage() {
9721 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
9722 fprintf(stderr
," ./redis-server - (read config from stdin)\n");
9726 int main(int argc
, char **argv
) {
9731 if (strcmp(argv
[1], "-v") == 0 ||
9732 strcmp(argv
[1], "--version") == 0) version();
9733 if (strcmp(argv
[1], "--help") == 0) usage();
9734 resetServerSaveParams();
9735 loadServerConfig(argv
[1]);
9736 } else if ((argc
> 2)) {
9739 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'");
9741 if (server
.daemonize
) daemonize();
9743 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
9745 linuxOvercommitMemoryWarning();
9748 if (server
.appendonly
) {
9749 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
9750 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %ld seconds",time(NULL
)-start
);
9752 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
9753 redisLog(REDIS_NOTICE
,"DB loaded from disk: %ld seconds",time(NULL
)-start
);
9755 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
9756 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
9758 aeDeleteEventLoop(server
.el
);
9762 /* ============================= Backtrace support ========================= */
9764 #ifdef HAVE_BACKTRACE
9765 static char *findFuncName(void *pointer
, unsigned long *offset
);
9767 static void *getMcontextEip(ucontext_t
*uc
) {
9768 #if defined(__FreeBSD__)
9769 return (void*) uc
->uc_mcontext
.mc_eip
;
9770 #elif defined(__dietlibc__)
9771 return (void*) uc
->uc_mcontext
.eip
;
9772 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
9774 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
9776 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
9778 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
9779 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
9780 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
9782 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
9784 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
9785 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
9786 #elif defined(__ia64__) /* Linux IA64 */
9787 return (void*) uc
->uc_mcontext
.sc_ip
;
9793 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
9795 char **messages
= NULL
;
9796 int i
, trace_size
= 0;
9797 unsigned long offset
=0;
9798 ucontext_t
*uc
= (ucontext_t
*) secret
;
9800 REDIS_NOTUSED(info
);
9802 redisLog(REDIS_WARNING
,
9803 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
9804 infostring
= genRedisInfoString();
9805 redisLog(REDIS_WARNING
, "%s",infostring
);
9806 /* It's not safe to sdsfree() the returned string under memory
9807 * corruption conditions. Let it leak as we are going to abort */
9809 trace_size
= backtrace(trace
, 100);
9810 /* overwrite sigaction with caller's address */
9811 if (getMcontextEip(uc
) != NULL
) {
9812 trace
[1] = getMcontextEip(uc
);
9814 messages
= backtrace_symbols(trace
, trace_size
);
9816 for (i
=1; i
<trace_size
; ++i
) {
9817 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
9819 p
= strchr(messages
[i
],'+');
9820 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
9821 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
9823 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
9826 /* free(messages); Don't call free() with possibly corrupted memory. */
9830 static void setupSigSegvAction(void) {
9831 struct sigaction act
;
9833 sigemptyset (&act
.sa_mask
);
9834 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
9835 * is used. Otherwise, sa_handler is used */
9836 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
9837 act
.sa_sigaction
= segvHandler
;
9838 sigaction (SIGSEGV
, &act
, NULL
);
9839 sigaction (SIGBUS
, &act
, NULL
);
9840 sigaction (SIGFPE
, &act
, NULL
);
9841 sigaction (SIGILL
, &act
, NULL
);
9842 sigaction (SIGBUS
, &act
, NULL
);
9846 #include "staticsymbols.h"
9847 /* This function try to convert a pointer into a function name. It's used in
9848 * oreder to provide a backtrace under segmentation fault that's able to
9849 * display functions declared as static (otherwise the backtrace is useless). */
9850 static char *findFuncName(void *pointer
, unsigned long *offset
){
9852 unsigned long off
, minoff
= 0;
9854 /* Try to match against the Symbol with the smallest offset */
9855 for (i
=0; symsTable
[i
].pointer
; i
++) {
9856 unsigned long lp
= (unsigned long) pointer
;
9858 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
9859 off
=lp
-symsTable
[i
].pointer
;
9860 if (ret
< 0 || off
< minoff
) {
9866 if (ret
== -1) return NULL
;
9868 return symsTable
[ret
].name
;
9870 #else /* HAVE_BACKTRACE */
9871 static void setupSigSegvAction(void) {
9873 #endif /* HAVE_BACKTRACE */