2 * Copyright (c) 2009-2010, Salvatore Sanfilippo <antirez at gmail dot com>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
8 * * Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * * Neither the name of Redis nor the names of its contributors may be used
14 * to endorse or promote products derived from this software without
15 * specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 * POSSIBILITY OF SUCH DAMAGE.
30 #define REDIS_VERSION "1.3.10"
45 #endif /* HAVE_BACKTRACE */
53 #include <arpa/inet.h>
57 #include <sys/resource.h>
64 #include "solarisfixes.h"
68 #include "ae.h" /* Event driven programming library */
69 #include "sds.h" /* Dynamic safe strings */
70 #include "anet.h" /* Networking the easy way */
71 #include "dict.h" /* Hash tables */
72 #include "adlist.h" /* Linked lists */
73 #include "zmalloc.h" /* total memory usage aware version of malloc/free */
74 #include "lzf.h" /* LZF compression library */
75 #include "pqsort.h" /* Partial qsort for SORT+LIMIT */
82 /* Static server configuration */
83 #define REDIS_SERVERPORT 6379 /* TCP port */
84 #define REDIS_MAXIDLETIME (60*5) /* default client timeout */
85 #define REDIS_IOBUF_LEN 1024
86 #define REDIS_LOADBUF_LEN 1024
87 #define REDIS_STATIC_ARGS 8
88 #define REDIS_DEFAULT_DBNUM 16
89 #define REDIS_CONFIGLINE_MAX 1024
90 #define REDIS_OBJFREELIST_MAX 1000000 /* Max number of objects to cache */
91 #define REDIS_MAX_SYNC_TIME 60 /* Slave can't take more to sync */
92 #define REDIS_EXPIRELOOKUPS_PER_CRON 10 /* lookup 10 expires per loop */
93 #define REDIS_MAX_WRITE_PER_EVENT (1024*64)
94 #define REDIS_REQUEST_MAX_SIZE (1024*1024*256) /* max bytes in inline command */
96 /* If more then REDIS_WRITEV_THRESHOLD write packets are pending use writev */
97 #define REDIS_WRITEV_THRESHOLD 3
98 /* Max number of iovecs used for each writev call */
99 #define REDIS_WRITEV_IOVEC_COUNT 256
101 /* Hash table parameters */
102 #define REDIS_HT_MINFILL 10 /* Minimal hash table fill 10% */
105 #define REDIS_CMD_BULK 1 /* Bulk write command */
106 #define REDIS_CMD_INLINE 2 /* Inline command */
107 /* REDIS_CMD_DENYOOM reserves a longer comment: all the commands marked with
108 this flags will return an error when the 'maxmemory' option is set in the
109 config file and the server is using more than maxmemory bytes of memory.
110 In short this commands are denied on low memory conditions. */
111 #define REDIS_CMD_DENYOOM 4
112 #define REDIS_CMD_FORCE_REPLICATION 8 /* Force replication even if dirty is 0 */
115 #define REDIS_STRING 0
121 /* Objects encoding. Some kind of objects like Strings and Hashes can be
122 * internally represented in multiple ways. The 'encoding' field of the object
123 * is set to one of this fields for this object. */
124 #define REDIS_ENCODING_RAW 0 /* Raw representation */
125 #define REDIS_ENCODING_INT 1 /* Encoded as integer */
126 #define REDIS_ENCODING_ZIPMAP 2 /* Encoded as zipmap */
127 #define REDIS_ENCODING_HT 3 /* Encoded as an hash table */
129 static char* strencoding
[] = {
130 "raw", "int", "zipmap", "hashtable"
133 /* Object types only used for dumping to disk */
134 #define REDIS_EXPIRETIME 253
135 #define REDIS_SELECTDB 254
136 #define REDIS_EOF 255
138 /* Defines related to the dump file format. To store 32 bits lengths for short
139 * keys requires a lot of space, so we check the most significant 2 bits of
140 * the first byte to interpreter the length:
142 * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
143 * 01|000000 00000000 => 01, the len is 14 byes, 6 bits + 8 bits of next byte
144 * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
145 * 11|000000 this means: specially encoded object will follow. The six bits
146 * number specify the kind of object that follows.
147 * See the REDIS_RDB_ENC_* defines.
149 * Lenghts up to 63 are stored using a single byte, most DB keys, and may
150 * values, will fit inside. */
151 #define REDIS_RDB_6BITLEN 0
152 #define REDIS_RDB_14BITLEN 1
153 #define REDIS_RDB_32BITLEN 2
154 #define REDIS_RDB_ENCVAL 3
155 #define REDIS_RDB_LENERR UINT_MAX
157 /* When a length of a string object stored on disk has the first two bits
158 * set, the remaining two bits specify a special encoding for the object
159 * accordingly to the following defines: */
160 #define REDIS_RDB_ENC_INT8 0 /* 8 bit signed integer */
161 #define REDIS_RDB_ENC_INT16 1 /* 16 bit signed integer */
162 #define REDIS_RDB_ENC_INT32 2 /* 32 bit signed integer */
163 #define REDIS_RDB_ENC_LZF 3 /* string compressed with FASTLZ */
165 /* Virtual memory object->where field. */
166 #define REDIS_VM_MEMORY 0 /* The object is on memory */
167 #define REDIS_VM_SWAPPED 1 /* The object is on disk */
168 #define REDIS_VM_SWAPPING 2 /* Redis is swapping this object on disk */
169 #define REDIS_VM_LOADING 3 /* Redis is loading this object from disk */
171 /* Virtual memory static configuration stuff.
172 * Check vmFindContiguousPages() to know more about this magic numbers. */
173 #define REDIS_VM_MAX_NEAR_PAGES 65536
174 #define REDIS_VM_MAX_RANDOM_JUMP 4096
175 #define REDIS_VM_MAX_THREADS 32
176 #define REDIS_THREAD_STACK_SIZE (1024*1024*4)
177 /* The following is the *percentage* of completed I/O jobs to process when the
178 * handelr is called. While Virtual Memory I/O operations are performed by
179 * threads, this operations must be processed by the main thread when completed
180 * in order to take effect. */
181 #define REDIS_MAX_COMPLETED_JOBS_PROCESSED 1
184 #define REDIS_SLAVE 1 /* This client is a slave server */
185 #define REDIS_MASTER 2 /* This client is a master server */
186 #define REDIS_MONITOR 4 /* This client is a slave monitor, see MONITOR */
187 #define REDIS_MULTI 8 /* This client is in a MULTI context */
188 #define REDIS_BLOCKED 16 /* The client is waiting in a blocking operation */
189 #define REDIS_IO_WAIT 32 /* The client is waiting for Virtual Memory I/O */
191 /* Slave replication state - slave side */
192 #define REDIS_REPL_NONE 0 /* No active replication */
193 #define REDIS_REPL_CONNECT 1 /* Must connect to master */
194 #define REDIS_REPL_CONNECTED 2 /* Connected to master */
196 /* Slave replication state - from the point of view of master
197 * Note that in SEND_BULK and ONLINE state the slave receives new updates
198 * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
199 * to start the next background saving in order to send updates to it. */
200 #define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
201 #define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
202 #define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
203 #define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
205 /* List related stuff */
209 /* Sort operations */
210 #define REDIS_SORT_GET 0
211 #define REDIS_SORT_ASC 1
212 #define REDIS_SORT_DESC 2
213 #define REDIS_SORTKEY_MAX 1024
216 #define REDIS_DEBUG 0
217 #define REDIS_VERBOSE 1
218 #define REDIS_NOTICE 2
219 #define REDIS_WARNING 3
221 /* Anti-warning macro... */
222 #define REDIS_NOTUSED(V) ((void) V)
224 #define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
225 #define ZSKIPLIST_P 0.25 /* Skiplist P = 1/4 */
227 /* Append only defines */
228 #define APPENDFSYNC_NO 0
229 #define APPENDFSYNC_ALWAYS 1
230 #define APPENDFSYNC_EVERYSEC 2
232 /* Hashes related defaults */
233 #define REDIS_HASH_MAX_ZIPMAP_ENTRIES 64
234 #define REDIS_HASH_MAX_ZIPMAP_VALUE 512
236 /* We can print the stacktrace, so our assert is defined this way: */
237 #define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
238 #define redisPanic(_e) _redisPanic(#_e,__FILE__,__LINE__),_exit(1)
239 static void _redisAssert(char *estr
, char *file
, int line
);
240 static void _redisPanic(char *msg
, 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 long long dirty
; /* changes to DB from the last save */
347 list
*slaves
, *monitors
;
348 char neterr
[ANET_ERR_LEN
];
350 int cronloops
; /* number of times the cron function run */
351 list
*objfreelist
; /* A list of freed objects to avoid malloc() */
352 time_t lastsave
; /* Unix time of last save succeeede */
353 /* Fields used only for stats */
354 time_t stat_starttime
; /* server start time */
355 long long stat_numcommands
; /* number of processed commands */
356 long long stat_numconnections
; /* number of connections received */
357 long long stat_expiredkeys
; /* number of expired keys */
370 pid_t bgsavechildpid
;
371 pid_t bgrewritechildpid
;
372 sds bgrewritebuf
; /* buffer taken by parent during oppend only rewrite */
373 sds aofbuf
; /* AOF buffer, written before entering the event loop */
374 struct saveparam
*saveparams
;
379 char *appendfilename
;
383 /* Replication related */
388 redisClient
*master
; /* client that is master for this slave */
390 unsigned int maxclients
;
391 unsigned long long maxmemory
;
392 unsigned int blpop_blocked_clients
;
393 unsigned int vm_blocked_clients
;
394 /* Sort parameters - qsort_r() is only available under BSD so we
395 * have to take this state global, in order to pass it to sortCompare() */
399 /* Virtual memory configuration */
404 unsigned long long vm_max_memory
;
406 size_t hash_max_zipmap_entries
;
407 size_t hash_max_zipmap_value
;
408 /* Virtual memory state */
411 off_t vm_next_page
; /* Next probably empty page */
412 off_t vm_near_pages
; /* Number of pages allocated sequentially */
413 unsigned char *vm_bitmap
; /* Bitmap of free/used pages */
414 time_t unixtime
; /* Unix time sampled every second. */
415 /* Virtual memory I/O threads stuff */
416 /* An I/O thread process an element taken from the io_jobs queue and
417 * put the result of the operation in the io_done list. While the
418 * job is being processed, it's put on io_processing queue. */
419 list
*io_newjobs
; /* List of VM I/O jobs yet to be processed */
420 list
*io_processing
; /* List of VM I/O jobs being processed */
421 list
*io_processed
; /* List of VM I/O jobs already processed */
422 list
*io_ready_clients
; /* Clients ready to be unblocked. All keys loaded */
423 pthread_mutex_t io_mutex
; /* lock to access io_jobs/io_done/io_thread_job */
424 pthread_mutex_t obj_freelist_mutex
; /* safe redis objects creation/free */
425 pthread_mutex_t io_swapfile_mutex
; /* So we can lseek + write */
426 pthread_attr_t io_threads_attr
; /* attributes for threads creation */
427 int io_active_threads
; /* Number of running I/O threads */
428 int vm_max_threads
; /* Max number of I/O threads running at the same time */
429 /* Our main thread is blocked on the event loop, locking for sockets ready
430 * to be read or written, so when a threaded I/O operation is ready to be
431 * processed by the main thread, the I/O thread will use a unix pipe to
432 * awake the main thread. The followings are the two pipe FDs. */
433 int io_ready_pipe_read
;
434 int io_ready_pipe_write
;
435 /* Virtual memory stats */
436 unsigned long long vm_stats_used_pages
;
437 unsigned long long vm_stats_swapped_objects
;
438 unsigned long long vm_stats_swapouts
;
439 unsigned long long vm_stats_swapins
;
441 dict
*pubsub_channels
; /* Map channels to list of subscribed clients */
442 list
*pubsub_patterns
; /* A list of pubsub_patterns */
447 typedef struct pubsubPattern
{
452 typedef void redisCommandProc(redisClient
*c
);
453 struct redisCommand
{
455 redisCommandProc
*proc
;
458 /* Use a function to determine which keys need to be loaded
459 * in the background prior to executing this command. Takes precedence
460 * over vm_firstkey and others, ignored when NULL */
461 redisCommandProc
*vm_preload_proc
;
462 /* What keys should be loaded in background when calling this command? */
463 int vm_firstkey
; /* The first argument that's a key (0 = no keys) */
464 int vm_lastkey
; /* THe last argument that's a key */
465 int vm_keystep
; /* The step between first and last key */
468 struct redisFunctionSym
{
470 unsigned long pointer
;
473 typedef struct _redisSortObject
{
481 typedef struct _redisSortOperation
{
484 } redisSortOperation
;
486 /* ZSETs use a specialized version of Skiplists */
488 typedef struct zskiplistNode
{
489 struct zskiplistNode
**forward
;
490 struct zskiplistNode
*backward
;
496 typedef struct zskiplist
{
497 struct zskiplistNode
*header
, *tail
;
498 unsigned long length
;
502 typedef struct zset
{
507 /* Our shared "common" objects */
509 #define REDIS_SHARED_INTEGERS 10000
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
, *pmessagebulk
, *subscribebulk
, *unsubscribebulk
, *mbulk3
,
518 *mbulk4
, *psubscribebulk
, *punsubscribebulk
,
519 *integers
[REDIS_SHARED_INTEGERS
];
522 /* Global vars that are actally used as constants. The following double
523 * values are used for double on-disk serialization, and are initialized
524 * at runtime to avoid strange compiler optimizations. */
526 static double R_Zero
, R_PosInf
, R_NegInf
, R_Nan
;
528 /* VM threaded I/O request message */
529 #define REDIS_IOJOB_LOAD 0 /* Load from disk to memory */
530 #define REDIS_IOJOB_PREPARE_SWAP 1 /* Compute needed pages */
531 #define REDIS_IOJOB_DO_SWAP 2 /* Swap from memory to disk */
532 typedef struct iojob
{
533 int type
; /* Request type, REDIS_IOJOB_* */
534 redisDb
*db
;/* Redis database */
535 robj
*key
; /* This I/O request is about swapping this key */
536 robj
*val
; /* the value to swap for REDIS_IOREQ_*_SWAP, otherwise this
537 * field is populated by the I/O thread for REDIS_IOREQ_LOAD. */
538 off_t page
; /* Swap page where to read/write the object */
539 off_t pages
; /* Swap pages needed to save object. PREPARE_SWAP return val */
540 int canceled
; /* True if this command was canceled by blocking side of VM */
541 pthread_t thread
; /* ID of the thread processing this entry */
544 /*================================ Prototypes =============================== */
546 static void freeStringObject(robj
*o
);
547 static void freeListObject(robj
*o
);
548 static void freeSetObject(robj
*o
);
549 static void decrRefCount(void *o
);
550 static robj
*createObject(int type
, void *ptr
);
551 static void freeClient(redisClient
*c
);
552 static int rdbLoad(char *filename
);
553 static void addReply(redisClient
*c
, robj
*obj
);
554 static void addReplySds(redisClient
*c
, sds s
);
555 static void incrRefCount(robj
*o
);
556 static int rdbSaveBackground(char *filename
);
557 static robj
*createStringObject(char *ptr
, size_t len
);
558 static robj
*dupStringObject(robj
*o
);
559 static void replicationFeedSlaves(list
*slaves
, int dictid
, robj
**argv
, int argc
);
560 static void replicationFeedMonitors(list
*monitors
, int dictid
, robj
**argv
, int argc
);
561 static void flushAppendOnlyFile(void);
562 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
563 static int syncWithMaster(void);
564 static robj
*tryObjectEncoding(robj
*o
);
565 static robj
*getDecodedObject(robj
*o
);
566 static int removeExpire(redisDb
*db
, robj
*key
);
567 static int expireIfNeeded(redisDb
*db
, robj
*key
);
568 static int deleteIfVolatile(redisDb
*db
, robj
*key
);
569 static int deleteIfSwapped(redisDb
*db
, robj
*key
);
570 static int deleteKey(redisDb
*db
, robj
*key
);
571 static time_t getExpire(redisDb
*db
, robj
*key
);
572 static int setExpire(redisDb
*db
, robj
*key
, time_t when
);
573 static void updateSlavesWaitingBgsave(int bgsaveerr
);
574 static void freeMemoryIfNeeded(void);
575 static int processCommand(redisClient
*c
);
576 static void setupSigSegvAction(void);
577 static void rdbRemoveTempFile(pid_t childpid
);
578 static void aofRemoveTempFile(pid_t childpid
);
579 static size_t stringObjectLen(robj
*o
);
580 static void processInputBuffer(redisClient
*c
);
581 static zskiplist
*zslCreate(void);
582 static void zslFree(zskiplist
*zsl
);
583 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
);
584 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
585 static void initClientMultiState(redisClient
*c
);
586 static void freeClientMultiState(redisClient
*c
);
587 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
);
588 static void unblockClientWaitingData(redisClient
*c
);
589 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
);
590 static void vmInit(void);
591 static void vmMarkPagesFree(off_t page
, off_t count
);
592 static robj
*vmLoadObject(robj
*key
);
593 static robj
*vmPreviewObject(robj
*key
);
594 static int vmSwapOneObjectBlocking(void);
595 static int vmSwapOneObjectThreaded(void);
596 static int vmCanSwapOut(void);
597 static int tryFreeOneObjectFromFreelist(void);
598 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
599 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
600 static void vmCancelThreadedIOJob(robj
*o
);
601 static void lockThreadedIO(void);
602 static void unlockThreadedIO(void);
603 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
);
604 static void freeIOJob(iojob
*j
);
605 static void queueIOJob(iojob
*j
);
606 static int vmWriteObjectOnSwap(robj
*o
, off_t page
);
607 static robj
*vmReadObjectFromSwap(off_t page
, int type
);
608 static void waitEmptyIOJobsQueue(void);
609 static void vmReopenSwapFile(void);
610 static int vmFreePage(off_t page
);
611 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
);
612 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
);
613 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
);
614 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
);
615 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
616 static struct redisCommand
*lookupCommand(char *name
);
617 static void call(redisClient
*c
, struct redisCommand
*cmd
);
618 static void resetClient(redisClient
*c
);
619 static void convertToRealHash(robj
*o
);
620 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
);
621 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
);
622 static void freePubsubPattern(void *p
);
623 static int listMatchPubsubPattern(void *a
, void *b
);
624 static int compareStringObjects(robj
*a
, robj
*b
);
626 static int rewriteAppendOnlyFileBackground(void);
628 static void authCommand(redisClient
*c
);
629 static void pingCommand(redisClient
*c
);
630 static void echoCommand(redisClient
*c
);
631 static void setCommand(redisClient
*c
);
632 static void setnxCommand(redisClient
*c
);
633 static void setexCommand(redisClient
*c
);
634 static void getCommand(redisClient
*c
);
635 static void delCommand(redisClient
*c
);
636 static void existsCommand(redisClient
*c
);
637 static void incrCommand(redisClient
*c
);
638 static void decrCommand(redisClient
*c
);
639 static void incrbyCommand(redisClient
*c
);
640 static void decrbyCommand(redisClient
*c
);
641 static void selectCommand(redisClient
*c
);
642 static void randomkeyCommand(redisClient
*c
);
643 static void keysCommand(redisClient
*c
);
644 static void dbsizeCommand(redisClient
*c
);
645 static void lastsaveCommand(redisClient
*c
);
646 static void saveCommand(redisClient
*c
);
647 static void bgsaveCommand(redisClient
*c
);
648 static void bgrewriteaofCommand(redisClient
*c
);
649 static void shutdownCommand(redisClient
*c
);
650 static void moveCommand(redisClient
*c
);
651 static void renameCommand(redisClient
*c
);
652 static void renamenxCommand(redisClient
*c
);
653 static void lpushCommand(redisClient
*c
);
654 static void rpushCommand(redisClient
*c
);
655 static void lpopCommand(redisClient
*c
);
656 static void rpopCommand(redisClient
*c
);
657 static void llenCommand(redisClient
*c
);
658 static void lindexCommand(redisClient
*c
);
659 static void lrangeCommand(redisClient
*c
);
660 static void ltrimCommand(redisClient
*c
);
661 static void typeCommand(redisClient
*c
);
662 static void lsetCommand(redisClient
*c
);
663 static void saddCommand(redisClient
*c
);
664 static void sremCommand(redisClient
*c
);
665 static void smoveCommand(redisClient
*c
);
666 static void sismemberCommand(redisClient
*c
);
667 static void scardCommand(redisClient
*c
);
668 static void spopCommand(redisClient
*c
);
669 static void srandmemberCommand(redisClient
*c
);
670 static void sinterCommand(redisClient
*c
);
671 static void sinterstoreCommand(redisClient
*c
);
672 static void sunionCommand(redisClient
*c
);
673 static void sunionstoreCommand(redisClient
*c
);
674 static void sdiffCommand(redisClient
*c
);
675 static void sdiffstoreCommand(redisClient
*c
);
676 static void syncCommand(redisClient
*c
);
677 static void flushdbCommand(redisClient
*c
);
678 static void flushallCommand(redisClient
*c
);
679 static void sortCommand(redisClient
*c
);
680 static void lremCommand(redisClient
*c
);
681 static void rpoplpushcommand(redisClient
*c
);
682 static void infoCommand(redisClient
*c
);
683 static void mgetCommand(redisClient
*c
);
684 static void monitorCommand(redisClient
*c
);
685 static void expireCommand(redisClient
*c
);
686 static void expireatCommand(redisClient
*c
);
687 static void getsetCommand(redisClient
*c
);
688 static void ttlCommand(redisClient
*c
);
689 static void slaveofCommand(redisClient
*c
);
690 static void debugCommand(redisClient
*c
);
691 static void msetCommand(redisClient
*c
);
692 static void msetnxCommand(redisClient
*c
);
693 static void zaddCommand(redisClient
*c
);
694 static void zincrbyCommand(redisClient
*c
);
695 static void zrangeCommand(redisClient
*c
);
696 static void zrangebyscoreCommand(redisClient
*c
);
697 static void zcountCommand(redisClient
*c
);
698 static void zrevrangeCommand(redisClient
*c
);
699 static void zcardCommand(redisClient
*c
);
700 static void zremCommand(redisClient
*c
);
701 static void zscoreCommand(redisClient
*c
);
702 static void zremrangebyscoreCommand(redisClient
*c
);
703 static void multiCommand(redisClient
*c
);
704 static void execCommand(redisClient
*c
);
705 static void discardCommand(redisClient
*c
);
706 static void blpopCommand(redisClient
*c
);
707 static void brpopCommand(redisClient
*c
);
708 static void appendCommand(redisClient
*c
);
709 static void substrCommand(redisClient
*c
);
710 static void zrankCommand(redisClient
*c
);
711 static void zrevrankCommand(redisClient
*c
);
712 static void hsetCommand(redisClient
*c
);
713 static void hsetnxCommand(redisClient
*c
);
714 static void hgetCommand(redisClient
*c
);
715 static void hmsetCommand(redisClient
*c
);
716 static void hmgetCommand(redisClient
*c
);
717 static void hdelCommand(redisClient
*c
);
718 static void hlenCommand(redisClient
*c
);
719 static void zremrangebyrankCommand(redisClient
*c
);
720 static void zunionCommand(redisClient
*c
);
721 static void zinterCommand(redisClient
*c
);
722 static void hkeysCommand(redisClient
*c
);
723 static void hvalsCommand(redisClient
*c
);
724 static void hgetallCommand(redisClient
*c
);
725 static void hexistsCommand(redisClient
*c
);
726 static void configCommand(redisClient
*c
);
727 static void hincrbyCommand(redisClient
*c
);
728 static void subscribeCommand(redisClient
*c
);
729 static void unsubscribeCommand(redisClient
*c
);
730 static void psubscribeCommand(redisClient
*c
);
731 static void punsubscribeCommand(redisClient
*c
);
732 static void publishCommand(redisClient
*c
);
734 /*================================= Globals ================================= */
737 static struct redisServer server
; /* server global state */
738 static struct redisCommand cmdTable
[] = {
739 {"get",getCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
740 {"set",setCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
741 {"setnx",setnxCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
742 {"setex",setexCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
743 {"append",appendCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
744 {"substr",substrCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
745 {"del",delCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
746 {"exists",existsCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
747 {"incr",incrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
748 {"decr",decrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
749 {"mget",mgetCommand
,-2,REDIS_CMD_INLINE
,NULL
,1,-1,1},
750 {"rpush",rpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
751 {"lpush",lpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
752 {"rpop",rpopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
753 {"lpop",lpopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
754 {"brpop",brpopCommand
,-3,REDIS_CMD_INLINE
,NULL
,1,1,1},
755 {"blpop",blpopCommand
,-3,REDIS_CMD_INLINE
,NULL
,1,1,1},
756 {"llen",llenCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
757 {"lindex",lindexCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
758 {"lset",lsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
759 {"lrange",lrangeCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
760 {"ltrim",ltrimCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
761 {"lrem",lremCommand
,4,REDIS_CMD_BULK
,NULL
,1,1,1},
762 {"rpoplpush",rpoplpushcommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,2,1},
763 {"sadd",saddCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
764 {"srem",sremCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
765 {"smove",smoveCommand
,4,REDIS_CMD_BULK
,NULL
,1,2,1},
766 {"sismember",sismemberCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
767 {"scard",scardCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
768 {"spop",spopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
769 {"srandmember",srandmemberCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
770 {"sinter",sinterCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
771 {"sinterstore",sinterstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
772 {"sunion",sunionCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
773 {"sunionstore",sunionstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
774 {"sdiff",sdiffCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
775 {"sdiffstore",sdiffstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
776 {"smembers",sinterCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
777 {"zadd",zaddCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
778 {"zincrby",zincrbyCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
779 {"zrem",zremCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
780 {"zremrangebyscore",zremrangebyscoreCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
781 {"zremrangebyrank",zremrangebyrankCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
782 {"zunion",zunionCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,zunionInterBlockClientOnSwappedKeys
,0,0,0},
783 {"zinter",zinterCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,zunionInterBlockClientOnSwappedKeys
,0,0,0},
784 {"zrange",zrangeCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
785 {"zrangebyscore",zrangebyscoreCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
786 {"zcount",zcountCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
787 {"zrevrange",zrevrangeCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
788 {"zcard",zcardCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
789 {"zscore",zscoreCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
790 {"zrank",zrankCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
791 {"zrevrank",zrevrankCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
792 {"hset",hsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
793 {"hsetnx",hsetnxCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
794 {"hget",hgetCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
795 {"hmset",hmsetCommand
,-4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
796 {"hmget",hmgetCommand
,-3,REDIS_CMD_BULK
,NULL
,1,1,1},
797 {"hincrby",hincrbyCommand
,4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
798 {"hdel",hdelCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
799 {"hlen",hlenCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
800 {"hkeys",hkeysCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
801 {"hvals",hvalsCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
802 {"hgetall",hgetallCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
803 {"hexists",hexistsCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
804 {"incrby",incrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
805 {"decrby",decrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
806 {"getset",getsetCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
807 {"mset",msetCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,-1,2},
808 {"msetnx",msetnxCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,-1,2},
809 {"randomkey",randomkeyCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
810 {"select",selectCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
811 {"move",moveCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
812 {"rename",renameCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
813 {"renamenx",renamenxCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
814 {"expire",expireCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
815 {"expireat",expireatCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
816 {"keys",keysCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
817 {"dbsize",dbsizeCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
818 {"auth",authCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
819 {"ping",pingCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
820 {"echo",echoCommand
,2,REDIS_CMD_BULK
,NULL
,0,0,0},
821 {"save",saveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
822 {"bgsave",bgsaveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
823 {"bgrewriteaof",bgrewriteaofCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
824 {"shutdown",shutdownCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
825 {"lastsave",lastsaveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
826 {"type",typeCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
827 {"multi",multiCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
828 {"exec",execCommand
,1,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
829 {"discard",discardCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
830 {"sync",syncCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
831 {"flushdb",flushdbCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
832 {"flushall",flushallCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
833 {"sort",sortCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
834 {"info",infoCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
835 {"monitor",monitorCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
836 {"ttl",ttlCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
837 {"slaveof",slaveofCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
838 {"debug",debugCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
839 {"config",configCommand
,-2,REDIS_CMD_BULK
,NULL
,0,0,0},
840 {"subscribe",subscribeCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
841 {"unsubscribe",unsubscribeCommand
,-1,REDIS_CMD_INLINE
,NULL
,0,0,0},
842 {"psubscribe",psubscribeCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
843 {"punsubscribe",punsubscribeCommand
,-1,REDIS_CMD_INLINE
,NULL
,0,0,0},
844 {"publish",publishCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_FORCE_REPLICATION
,NULL
,0,0,0},
845 {NULL
,NULL
,0,0,NULL
,0,0,0}
848 /*============================ Utility functions ============================ */
850 /* Glob-style pattern matching. */
851 static int stringmatchlen(const char *pattern
, int patternLen
,
852 const char *string
, int stringLen
, int nocase
)
857 while (pattern
[1] == '*') {
862 return 1; /* match */
864 if (stringmatchlen(pattern
+1, patternLen
-1,
865 string
, stringLen
, nocase
))
866 return 1; /* match */
870 return 0; /* no match */
874 return 0; /* no match */
884 not = pattern
[0] == '^';
891 if (pattern
[0] == '\\') {
894 if (pattern
[0] == string
[0])
896 } else if (pattern
[0] == ']') {
898 } else if (patternLen
== 0) {
902 } else if (pattern
[1] == '-' && patternLen
>= 3) {
903 int start
= pattern
[0];
904 int end
= pattern
[2];
912 start
= tolower(start
);
918 if (c
>= start
&& c
<= end
)
922 if (pattern
[0] == string
[0])
925 if (tolower((int)pattern
[0]) == tolower((int)string
[0]))
935 return 0; /* no match */
941 if (patternLen
>= 2) {
948 if (pattern
[0] != string
[0])
949 return 0; /* no match */
951 if (tolower((int)pattern
[0]) != tolower((int)string
[0]))
952 return 0; /* no match */
960 if (stringLen
== 0) {
961 while(*pattern
== '*') {
968 if (patternLen
== 0 && stringLen
== 0)
973 static int stringmatch(const char *pattern
, const char *string
, int nocase
) {
974 return stringmatchlen(pattern
,strlen(pattern
),string
,strlen(string
),nocase
);
977 /* Convert a string representing an amount of memory into the number of
978 * bytes, so for instance memtoll("1Gi") will return 1073741824 that is
981 * On parsing error, if *err is not NULL, it's set to 1, otherwise it's
983 static long long memtoll(const char *p
, int *err
) {
986 long mul
; /* unit multiplier */
991 /* Search the first non digit character. */
994 while(*u
&& isdigit(*u
)) u
++;
995 if (*u
== '\0' || !strcasecmp(u
,"b")) {
997 } else if (!strcasecmp(u
,"k")) {
999 } else if (!strcasecmp(u
,"kb")) {
1001 } else if (!strcasecmp(u
,"m")) {
1003 } else if (!strcasecmp(u
,"mb")) {
1005 } else if (!strcasecmp(u
,"g")) {
1006 mul
= 1000L*1000*1000;
1007 } else if (!strcasecmp(u
,"gb")) {
1008 mul
= 1024L*1024*1024;
1014 if (digits
>= sizeof(buf
)) {
1018 memcpy(buf
,p
,digits
);
1020 val
= strtoll(buf
,NULL
,10);
1024 static void redisLog(int level
, const char *fmt
, ...) {
1028 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
1032 if (level
>= server
.verbosity
) {
1038 strftime(buf
,64,"%d %b %H:%M:%S",localtime(&now
));
1039 fprintf(fp
,"[%d] %s %c ",(int)getpid(),buf
,c
[level
]);
1040 vfprintf(fp
, fmt
, ap
);
1046 if (server
.logfile
) fclose(fp
);
1049 /*====================== Hash table type implementation ==================== */
1051 /* This is an hash table type that uses the SDS dynamic strings libary as
1052 * keys and radis objects as values (objects can hold SDS strings,
1055 static void dictVanillaFree(void *privdata
, void *val
)
1057 DICT_NOTUSED(privdata
);
1061 static void dictListDestructor(void *privdata
, void *val
)
1063 DICT_NOTUSED(privdata
);
1064 listRelease((list
*)val
);
1067 static int sdsDictKeyCompare(void *privdata
, const void *key1
,
1071 DICT_NOTUSED(privdata
);
1073 l1
= sdslen((sds
)key1
);
1074 l2
= sdslen((sds
)key2
);
1075 if (l1
!= l2
) return 0;
1076 return memcmp(key1
, key2
, l1
) == 0;
1079 static void dictRedisObjectDestructor(void *privdata
, void *val
)
1081 DICT_NOTUSED(privdata
);
1083 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
1087 static int dictObjKeyCompare(void *privdata
, const void *key1
,
1090 const robj
*o1
= key1
, *o2
= key2
;
1091 return sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1094 static unsigned int dictObjHash(const void *key
) {
1095 const robj
*o
= key
;
1096 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1099 static int dictEncObjKeyCompare(void *privdata
, const void *key1
,
1102 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
1105 if (o1
->encoding
== REDIS_ENCODING_INT
&&
1106 o2
->encoding
== REDIS_ENCODING_INT
&&
1107 o1
->ptr
== o2
->ptr
) return 1;
1109 o1
= getDecodedObject(o1
);
1110 o2
= getDecodedObject(o2
);
1111 cmp
= sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1117 static unsigned int dictEncObjHash(const void *key
) {
1118 robj
*o
= (robj
*) key
;
1120 if (o
->encoding
== REDIS_ENCODING_RAW
) {
1121 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1123 if (o
->encoding
== REDIS_ENCODING_INT
) {
1127 len
= snprintf(buf
,32,"%ld",(long)o
->ptr
);
1128 return dictGenHashFunction((unsigned char*)buf
, len
);
1132 o
= getDecodedObject(o
);
1133 hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1140 /* Sets type and expires */
1141 static dictType setDictType
= {
1142 dictEncObjHash
, /* hash function */
1145 dictEncObjKeyCompare
, /* key compare */
1146 dictRedisObjectDestructor
, /* key destructor */
1147 NULL
/* val destructor */
1150 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
1151 static dictType zsetDictType
= {
1152 dictEncObjHash
, /* hash function */
1155 dictEncObjKeyCompare
, /* key compare */
1156 dictRedisObjectDestructor
, /* key destructor */
1157 dictVanillaFree
/* val destructor of malloc(sizeof(double)) */
1161 static dictType dbDictType
= {
1162 dictObjHash
, /* hash function */
1165 dictObjKeyCompare
, /* key compare */
1166 dictRedisObjectDestructor
, /* key destructor */
1167 dictRedisObjectDestructor
/* val destructor */
1171 static dictType keyptrDictType
= {
1172 dictObjHash
, /* hash function */
1175 dictObjKeyCompare
, /* key compare */
1176 dictRedisObjectDestructor
, /* key destructor */
1177 NULL
/* val destructor */
1180 /* Hash type hash table (note that small hashes are represented with zimpaps) */
1181 static dictType hashDictType
= {
1182 dictEncObjHash
, /* hash function */
1185 dictEncObjKeyCompare
, /* key compare */
1186 dictRedisObjectDestructor
, /* key destructor */
1187 dictRedisObjectDestructor
/* val destructor */
1190 /* Keylist hash table type has unencoded redis objects as keys and
1191 * lists as values. It's used for blocking operations (BLPOP) and to
1192 * map swapped keys to a list of clients waiting for this keys to be loaded. */
1193 static dictType keylistDictType
= {
1194 dictObjHash
, /* hash function */
1197 dictObjKeyCompare
, /* key compare */
1198 dictRedisObjectDestructor
, /* key destructor */
1199 dictListDestructor
/* val destructor */
1202 static void version();
1204 /* ========================= Random utility functions ======================= */
1206 /* Redis generally does not try to recover from out of memory conditions
1207 * when allocating objects or strings, it is not clear if it will be possible
1208 * to report this condition to the client since the networking layer itself
1209 * is based on heap allocation for send buffers, so we simply abort.
1210 * At least the code will be simpler to read... */
1211 static void oom(const char *msg
) {
1212 redisLog(REDIS_WARNING
, "%s: Out of memory\n",msg
);
1217 /* ====================== Redis server networking stuff ===================== */
1218 static void closeTimedoutClients(void) {
1221 time_t now
= time(NULL
);
1224 listRewind(server
.clients
,&li
);
1225 while ((ln
= listNext(&li
)) != NULL
) {
1226 c
= listNodeValue(ln
);
1227 if (server
.maxidletime
&&
1228 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
1229 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
1230 dictSize(c
->pubsub_channels
) == 0 && /* no timeout for pubsub */
1231 listLength(c
->pubsub_patterns
) == 0 &&
1232 (now
- c
->lastinteraction
> server
.maxidletime
))
1234 redisLog(REDIS_VERBOSE
,"Closing idle client");
1236 } else if (c
->flags
& REDIS_BLOCKED
) {
1237 if (c
->blockingto
!= 0 && c
->blockingto
< now
) {
1238 addReply(c
,shared
.nullmultibulk
);
1239 unblockClientWaitingData(c
);
1245 static int htNeedsResize(dict
*dict
) {
1246 long long size
, used
;
1248 size
= dictSlots(dict
);
1249 used
= dictSize(dict
);
1250 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
1251 (used
*100/size
< REDIS_HT_MINFILL
));
1254 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1255 * we resize the hash table to save memory */
1256 static void tryResizeHashTables(void) {
1259 for (j
= 0; j
< server
.dbnum
; j
++) {
1260 if (htNeedsResize(server
.db
[j
].dict
))
1261 dictResize(server
.db
[j
].dict
);
1262 if (htNeedsResize(server
.db
[j
].expires
))
1263 dictResize(server
.db
[j
].expires
);
1267 /* Our hash table implementation performs rehashing incrementally while
1268 * we write/read from the hash table. Still if the server is idle, the hash
1269 * table will use two tables for a long time. So we try to use 1 millisecond
1270 * of CPU time at every serverCron() loop in order to rehash some key. */
1271 static void incrementallyRehash(void) {
1274 for (j
= 0; j
< server
.dbnum
; j
++) {
1275 if (dictIsRehashing(server
.db
[j
].dict
)) {
1276 dictRehashMilliseconds(server
.db
[j
].dict
,1);
1277 break; /* already used our millisecond for this loop... */
1282 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1283 void backgroundSaveDoneHandler(int statloc
) {
1284 int exitcode
= WEXITSTATUS(statloc
);
1285 int bysignal
= WIFSIGNALED(statloc
);
1287 if (!bysignal
&& exitcode
== 0) {
1288 redisLog(REDIS_NOTICE
,
1289 "Background saving terminated with success");
1291 server
.lastsave
= time(NULL
);
1292 } else if (!bysignal
&& exitcode
!= 0) {
1293 redisLog(REDIS_WARNING
, "Background saving error");
1295 redisLog(REDIS_WARNING
,
1296 "Background saving terminated by signal %d", WTERMSIG(statloc
));
1297 rdbRemoveTempFile(server
.bgsavechildpid
);
1299 server
.bgsavechildpid
= -1;
1300 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1301 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1302 updateSlavesWaitingBgsave(exitcode
== 0 ? REDIS_OK
: REDIS_ERR
);
1305 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1307 void backgroundRewriteDoneHandler(int statloc
) {
1308 int exitcode
= WEXITSTATUS(statloc
);
1309 int bysignal
= WIFSIGNALED(statloc
);
1311 if (!bysignal
&& exitcode
== 0) {
1315 redisLog(REDIS_NOTICE
,
1316 "Background append only file rewriting terminated with success");
1317 /* Now it's time to flush the differences accumulated by the parent */
1318 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) server
.bgrewritechildpid
);
1319 fd
= open(tmpfile
,O_WRONLY
|O_APPEND
);
1321 redisLog(REDIS_WARNING
, "Not able to open the temp append only file produced by the child: %s", strerror(errno
));
1324 /* Flush our data... */
1325 if (write(fd
,server
.bgrewritebuf
,sdslen(server
.bgrewritebuf
)) !=
1326 (signed) sdslen(server
.bgrewritebuf
)) {
1327 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
));
1331 redisLog(REDIS_NOTICE
,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server
.bgrewritebuf
));
1332 /* Now our work is to rename the temp file into the stable file. And
1333 * switch the file descriptor used by the server for append only. */
1334 if (rename(tmpfile
,server
.appendfilename
) == -1) {
1335 redisLog(REDIS_WARNING
,"Can't rename the temp append only file into the stable one: %s", strerror(errno
));
1339 /* Mission completed... almost */
1340 redisLog(REDIS_NOTICE
,"Append only file successfully rewritten.");
1341 if (server
.appendfd
!= -1) {
1342 /* If append only is actually enabled... */
1343 close(server
.appendfd
);
1344 server
.appendfd
= fd
;
1346 server
.appendseldb
= -1; /* Make sure it will issue SELECT */
1347 redisLog(REDIS_NOTICE
,"The new append only file was selected for future appends.");
1349 /* If append only is disabled we just generate a dump in this
1350 * format. Why not? */
1353 } else if (!bysignal
&& exitcode
!= 0) {
1354 redisLog(REDIS_WARNING
, "Background append only file rewriting error");
1356 redisLog(REDIS_WARNING
,
1357 "Background append only file rewriting terminated by signal %d",
1361 sdsfree(server
.bgrewritebuf
);
1362 server
.bgrewritebuf
= sdsempty();
1363 aofRemoveTempFile(server
.bgrewritechildpid
);
1364 server
.bgrewritechildpid
= -1;
1367 /* This function is called once a background process of some kind terminates,
1368 * as we want to avoid resizing the hash tables when there is a child in order
1369 * to play well with copy-on-write (otherwise when a resize happens lots of
1370 * memory pages are copied). The goal of this function is to update the ability
1371 * for dict.c to resize the hash tables accordingly to the fact we have o not
1372 * running childs. */
1373 static void updateDictResizePolicy(void) {
1374 if (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1)
1377 dictDisableResize();
1380 static int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
1381 int j
, loops
= server
.cronloops
++;
1382 REDIS_NOTUSED(eventLoop
);
1384 REDIS_NOTUSED(clientData
);
1386 /* We take a cached value of the unix time in the global state because
1387 * with virtual memory and aging there is to store the current time
1388 * in objects at every object access, and accuracy is not needed.
1389 * To access a global var is faster than calling time(NULL) */
1390 server
.unixtime
= time(NULL
);
1392 /* Show some info about non-empty databases */
1393 for (j
= 0; j
< server
.dbnum
; j
++) {
1394 long long size
, used
, vkeys
;
1396 size
= dictSlots(server
.db
[j
].dict
);
1397 used
= dictSize(server
.db
[j
].dict
);
1398 vkeys
= dictSize(server
.db
[j
].expires
);
1399 if (!(loops
% 50) && (used
|| vkeys
)) {
1400 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
1401 /* dictPrintStats(server.dict); */
1405 /* We don't want to resize the hash tables while a bacground saving
1406 * is in progress: the saving child is created using fork() that is
1407 * implemented with a copy-on-write semantic in most modern systems, so
1408 * if we resize the HT while there is the saving child at work actually
1409 * a lot of memory movements in the parent will cause a lot of pages
1411 if (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1) {
1412 if (!(loops
% 10)) tryResizeHashTables();
1413 if (server
.activerehashing
) incrementallyRehash();
1416 /* Show information about connected clients */
1417 if (!(loops
% 50)) {
1418 redisLog(REDIS_VERBOSE
,"%d clients connected (%d slaves), %zu bytes in use",
1419 listLength(server
.clients
)-listLength(server
.slaves
),
1420 listLength(server
.slaves
),
1421 zmalloc_used_memory());
1424 /* Close connections of timedout clients */
1425 if ((server
.maxidletime
&& !(loops
% 100)) || server
.blpop_blocked_clients
)
1426 closeTimedoutClients();
1428 /* Check if a background saving or AOF rewrite in progress terminated */
1429 if (server
.bgsavechildpid
!= -1 || server
.bgrewritechildpid
!= -1) {
1433 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
1434 if (pid
== server
.bgsavechildpid
) {
1435 backgroundSaveDoneHandler(statloc
);
1437 backgroundRewriteDoneHandler(statloc
);
1439 updateDictResizePolicy();
1442 /* If there is not a background saving in progress check if
1443 * we have to save now */
1444 time_t now
= time(NULL
);
1445 for (j
= 0; j
< server
.saveparamslen
; j
++) {
1446 struct saveparam
*sp
= server
.saveparams
+j
;
1448 if (server
.dirty
>= sp
->changes
&&
1449 now
-server
.lastsave
> sp
->seconds
) {
1450 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
1451 sp
->changes
, sp
->seconds
);
1452 rdbSaveBackground(server
.dbfilename
);
1458 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1459 * will use few CPU cycles if there are few expiring keys, otherwise
1460 * it will get more aggressive to avoid that too much memory is used by
1461 * keys that can be removed from the keyspace. */
1462 for (j
= 0; j
< server
.dbnum
; j
++) {
1464 redisDb
*db
= server
.db
+j
;
1466 /* Continue to expire if at the end of the cycle more than 25%
1467 * of the keys were expired. */
1469 long num
= dictSize(db
->expires
);
1470 time_t now
= time(NULL
);
1473 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
1474 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
1479 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
1480 t
= (time_t) dictGetEntryVal(de
);
1482 deleteKey(db
,dictGetEntryKey(de
));
1484 server
.stat_expiredkeys
++;
1487 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
1490 /* Swap a few keys on disk if we are over the memory limit and VM
1491 * is enbled. Try to free objects from the free list first. */
1492 if (vmCanSwapOut()) {
1493 while (server
.vm_enabled
&& zmalloc_used_memory() >
1494 server
.vm_max_memory
)
1498 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
1499 retval
= (server
.vm_max_threads
== 0) ?
1500 vmSwapOneObjectBlocking() :
1501 vmSwapOneObjectThreaded();
1502 if (retval
== REDIS_ERR
&& !(loops
% 300) &&
1503 zmalloc_used_memory() >
1504 (server
.vm_max_memory
+server
.vm_max_memory
/10))
1506 redisLog(REDIS_WARNING
,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1508 /* Note that when using threade I/O we free just one object,
1509 * because anyway when the I/O thread in charge to swap this
1510 * object out will finish, the handler of completed jobs
1511 * will try to swap more objects if we are still out of memory. */
1512 if (retval
== REDIS_ERR
|| server
.vm_max_threads
> 0) break;
1516 /* Check if we should connect to a MASTER */
1517 if (server
.replstate
== REDIS_REPL_CONNECT
&& !(loops
% 10)) {
1518 redisLog(REDIS_NOTICE
,"Connecting to MASTER...");
1519 if (syncWithMaster() == REDIS_OK
) {
1520 redisLog(REDIS_NOTICE
,"MASTER <-> SLAVE sync succeeded");
1521 if (server
.appendonly
) rewriteAppendOnlyFileBackground();
1527 /* This function gets called every time Redis is entering the
1528 * main loop of the event driven library, that is, before to sleep
1529 * for ready file descriptors. */
1530 static void beforeSleep(struct aeEventLoop
*eventLoop
) {
1531 REDIS_NOTUSED(eventLoop
);
1533 /* Awake clients that got all the swapped keys they requested */
1534 if (server
.vm_enabled
&& listLength(server
.io_ready_clients
)) {
1538 listRewind(server
.io_ready_clients
,&li
);
1539 while((ln
= listNext(&li
))) {
1540 redisClient
*c
= ln
->value
;
1541 struct redisCommand
*cmd
;
1543 /* Resume the client. */
1544 listDelNode(server
.io_ready_clients
,ln
);
1545 c
->flags
&= (~REDIS_IO_WAIT
);
1546 server
.vm_blocked_clients
--;
1547 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
1548 readQueryFromClient
, c
);
1549 cmd
= lookupCommand(c
->argv
[0]->ptr
);
1550 assert(cmd
!= NULL
);
1553 /* There may be more data to process in the input buffer. */
1554 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0)
1555 processInputBuffer(c
);
1558 /* Write the AOF buffer on disk */
1559 flushAppendOnlyFile();
1562 static void createSharedObjects(void) {
1565 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1566 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1567 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1568 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1569 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1570 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1571 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1572 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1573 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1574 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1575 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1576 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1577 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1578 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1579 "-ERR no such key\r\n"));
1580 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1581 "-ERR syntax error\r\n"));
1582 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1583 "-ERR source and destination objects are the same\r\n"));
1584 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1585 "-ERR index out of range\r\n"));
1586 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1587 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1588 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1589 shared
.select0
= createStringObject("select 0\r\n",10);
1590 shared
.select1
= createStringObject("select 1\r\n",10);
1591 shared
.select2
= createStringObject("select 2\r\n",10);
1592 shared
.select3
= createStringObject("select 3\r\n",10);
1593 shared
.select4
= createStringObject("select 4\r\n",10);
1594 shared
.select5
= createStringObject("select 5\r\n",10);
1595 shared
.select6
= createStringObject("select 6\r\n",10);
1596 shared
.select7
= createStringObject("select 7\r\n",10);
1597 shared
.select8
= createStringObject("select 8\r\n",10);
1598 shared
.select9
= createStringObject("select 9\r\n",10);
1599 shared
.messagebulk
= createStringObject("$7\r\nmessage\r\n",13);
1600 shared
.pmessagebulk
= createStringObject("$8\r\npmessage\r\n",14);
1601 shared
.subscribebulk
= createStringObject("$9\r\nsubscribe\r\n",15);
1602 shared
.unsubscribebulk
= createStringObject("$11\r\nunsubscribe\r\n",18);
1603 shared
.psubscribebulk
= createStringObject("$10\r\npsubscribe\r\n",17);
1604 shared
.punsubscribebulk
= createStringObject("$12\r\npunsubscribe\r\n",19);
1605 shared
.mbulk3
= createStringObject("*3\r\n",4);
1606 shared
.mbulk4
= createStringObject("*4\r\n",4);
1607 for (j
= 0; j
< REDIS_SHARED_INTEGERS
; j
++) {
1608 shared
.integers
[j
] = createObject(REDIS_STRING
,(void*)(long)j
);
1609 shared
.integers
[j
]->encoding
= REDIS_ENCODING_INT
;
1613 static void appendServerSaveParams(time_t seconds
, int changes
) {
1614 server
.saveparams
= zrealloc(server
.saveparams
,sizeof(struct saveparam
)*(server
.saveparamslen
+1));
1615 server
.saveparams
[server
.saveparamslen
].seconds
= seconds
;
1616 server
.saveparams
[server
.saveparamslen
].changes
= changes
;
1617 server
.saveparamslen
++;
1620 static void resetServerSaveParams() {
1621 zfree(server
.saveparams
);
1622 server
.saveparams
= NULL
;
1623 server
.saveparamslen
= 0;
1626 static void initServerConfig() {
1627 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1628 server
.port
= REDIS_SERVERPORT
;
1629 server
.verbosity
= REDIS_VERBOSE
;
1630 server
.maxidletime
= REDIS_MAXIDLETIME
;
1631 server
.saveparams
= NULL
;
1632 server
.logfile
= NULL
; /* NULL = log on standard output */
1633 server
.bindaddr
= NULL
;
1634 server
.glueoutputbuf
= 1;
1635 server
.daemonize
= 0;
1636 server
.appendonly
= 0;
1637 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1638 server
.lastfsync
= time(NULL
);
1639 server
.appendfd
= -1;
1640 server
.appendseldb
= -1; /* Make sure the first time will not match */
1641 server
.pidfile
= zstrdup("/var/run/redis.pid");
1642 server
.dbfilename
= zstrdup("dump.rdb");
1643 server
.appendfilename
= zstrdup("appendonly.aof");
1644 server
.requirepass
= NULL
;
1645 server
.rdbcompression
= 1;
1646 server
.activerehashing
= 1;
1647 server
.maxclients
= 0;
1648 server
.blpop_blocked_clients
= 0;
1649 server
.maxmemory
= 0;
1650 server
.vm_enabled
= 0;
1651 server
.vm_swap_file
= zstrdup("/tmp/redis-%p.vm");
1652 server
.vm_page_size
= 256; /* 256 bytes per page */
1653 server
.vm_pages
= 1024*1024*100; /* 104 millions of pages */
1654 server
.vm_max_memory
= 1024LL*1024*1024*1; /* 1 GB of RAM */
1655 server
.vm_max_threads
= 4;
1656 server
.vm_blocked_clients
= 0;
1657 server
.hash_max_zipmap_entries
= REDIS_HASH_MAX_ZIPMAP_ENTRIES
;
1658 server
.hash_max_zipmap_value
= REDIS_HASH_MAX_ZIPMAP_VALUE
;
1660 resetServerSaveParams();
1662 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1663 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1664 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1665 /* Replication related */
1667 server
.masterauth
= NULL
;
1668 server
.masterhost
= NULL
;
1669 server
.masterport
= 6379;
1670 server
.master
= NULL
;
1671 server
.replstate
= REDIS_REPL_NONE
;
1673 /* Double constants initialization */
1675 R_PosInf
= 1.0/R_Zero
;
1676 R_NegInf
= -1.0/R_Zero
;
1677 R_Nan
= R_Zero
/R_Zero
;
1680 static void initServer() {
1683 signal(SIGHUP
, SIG_IGN
);
1684 signal(SIGPIPE
, SIG_IGN
);
1685 setupSigSegvAction();
1687 server
.devnull
= fopen("/dev/null","w");
1688 if (server
.devnull
== NULL
) {
1689 redisLog(REDIS_WARNING
, "Can't open /dev/null: %s", server
.neterr
);
1692 server
.clients
= listCreate();
1693 server
.slaves
= listCreate();
1694 server
.monitors
= listCreate();
1695 server
.objfreelist
= listCreate();
1696 createSharedObjects();
1697 server
.el
= aeCreateEventLoop();
1698 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1699 server
.fd
= anetTcpServer(server
.neterr
, server
.port
, server
.bindaddr
);
1700 if (server
.fd
== -1) {
1701 redisLog(REDIS_WARNING
, "Opening TCP port: %s", server
.neterr
);
1704 for (j
= 0; j
< server
.dbnum
; j
++) {
1705 server
.db
[j
].dict
= dictCreate(&dbDictType
,NULL
);
1706 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1707 server
.db
[j
].blockingkeys
= dictCreate(&keylistDictType
,NULL
);
1708 if (server
.vm_enabled
)
1709 server
.db
[j
].io_keys
= dictCreate(&keylistDictType
,NULL
);
1710 server
.db
[j
].id
= j
;
1712 server
.pubsub_channels
= dictCreate(&keylistDictType
,NULL
);
1713 server
.pubsub_patterns
= listCreate();
1714 listSetFreeMethod(server
.pubsub_patterns
,freePubsubPattern
);
1715 listSetMatchMethod(server
.pubsub_patterns
,listMatchPubsubPattern
);
1716 server
.cronloops
= 0;
1717 server
.bgsavechildpid
= -1;
1718 server
.bgrewritechildpid
= -1;
1719 server
.bgrewritebuf
= sdsempty();
1720 server
.aofbuf
= sdsempty();
1721 server
.lastsave
= time(NULL
);
1723 server
.stat_numcommands
= 0;
1724 server
.stat_numconnections
= 0;
1725 server
.stat_expiredkeys
= 0;
1726 server
.stat_starttime
= time(NULL
);
1727 server
.unixtime
= time(NULL
);
1728 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1729 if (aeCreateFileEvent(server
.el
, server
.fd
, AE_READABLE
,
1730 acceptHandler
, NULL
) == AE_ERR
) oom("creating file event");
1732 if (server
.appendonly
) {
1733 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1734 if (server
.appendfd
== -1) {
1735 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1741 if (server
.vm_enabled
) vmInit();
1744 /* Empty the whole database */
1745 static long long emptyDb() {
1747 long long removed
= 0;
1749 for (j
= 0; j
< server
.dbnum
; j
++) {
1750 removed
+= dictSize(server
.db
[j
].dict
);
1751 dictEmpty(server
.db
[j
].dict
);
1752 dictEmpty(server
.db
[j
].expires
);
1757 static int yesnotoi(char *s
) {
1758 if (!strcasecmp(s
,"yes")) return 1;
1759 else if (!strcasecmp(s
,"no")) return 0;
1763 /* I agree, this is a very rudimental way to load a configuration...
1764 will improve later if the config gets more complex */
1765 static void loadServerConfig(char *filename
) {
1767 char buf
[REDIS_CONFIGLINE_MAX
+1], *err
= NULL
;
1771 if (filename
[0] == '-' && filename
[1] == '\0')
1774 if ((fp
= fopen(filename
,"r")) == NULL
) {
1775 redisLog(REDIS_WARNING
, "Fatal error, can't open config file '%s'", filename
);
1780 while(fgets(buf
,REDIS_CONFIGLINE_MAX
+1,fp
) != NULL
) {
1786 line
= sdstrim(line
," \t\r\n");
1788 /* Skip comments and blank lines*/
1789 if (line
[0] == '#' || line
[0] == '\0') {
1794 /* Split into arguments */
1795 argv
= sdssplitlen(line
,sdslen(line
)," ",1,&argc
);
1796 sdstolower(argv
[0]);
1798 /* Execute config directives */
1799 if (!strcasecmp(argv
[0],"timeout") && argc
== 2) {
1800 server
.maxidletime
= atoi(argv
[1]);
1801 if (server
.maxidletime
< 0) {
1802 err
= "Invalid timeout value"; goto loaderr
;
1804 } else if (!strcasecmp(argv
[0],"port") && argc
== 2) {
1805 server
.port
= atoi(argv
[1]);
1806 if (server
.port
< 1 || server
.port
> 65535) {
1807 err
= "Invalid port"; goto loaderr
;
1809 } else if (!strcasecmp(argv
[0],"bind") && argc
== 2) {
1810 server
.bindaddr
= zstrdup(argv
[1]);
1811 } else if (!strcasecmp(argv
[0],"save") && argc
== 3) {
1812 int seconds
= atoi(argv
[1]);
1813 int changes
= atoi(argv
[2]);
1814 if (seconds
< 1 || changes
< 0) {
1815 err
= "Invalid save parameters"; goto loaderr
;
1817 appendServerSaveParams(seconds
,changes
);
1818 } else if (!strcasecmp(argv
[0],"dir") && argc
== 2) {
1819 if (chdir(argv
[1]) == -1) {
1820 redisLog(REDIS_WARNING
,"Can't chdir to '%s': %s",
1821 argv
[1], strerror(errno
));
1824 } else if (!strcasecmp(argv
[0],"loglevel") && argc
== 2) {
1825 if (!strcasecmp(argv
[1],"debug")) server
.verbosity
= REDIS_DEBUG
;
1826 else if (!strcasecmp(argv
[1],"verbose")) server
.verbosity
= REDIS_VERBOSE
;
1827 else if (!strcasecmp(argv
[1],"notice")) server
.verbosity
= REDIS_NOTICE
;
1828 else if (!strcasecmp(argv
[1],"warning")) server
.verbosity
= REDIS_WARNING
;
1830 err
= "Invalid log level. Must be one of debug, notice, warning";
1833 } else if (!strcasecmp(argv
[0],"logfile") && argc
== 2) {
1836 server
.logfile
= zstrdup(argv
[1]);
1837 if (!strcasecmp(server
.logfile
,"stdout")) {
1838 zfree(server
.logfile
);
1839 server
.logfile
= NULL
;
1841 if (server
.logfile
) {
1842 /* Test if we are able to open the file. The server will not
1843 * be able to abort just for this problem later... */
1844 logfp
= fopen(server
.logfile
,"a");
1845 if (logfp
== NULL
) {
1846 err
= sdscatprintf(sdsempty(),
1847 "Can't open the log file: %s", strerror(errno
));
1852 } else if (!strcasecmp(argv
[0],"databases") && argc
== 2) {
1853 server
.dbnum
= atoi(argv
[1]);
1854 if (server
.dbnum
< 1) {
1855 err
= "Invalid number of databases"; goto loaderr
;
1857 } else if (!strcasecmp(argv
[0],"include") && argc
== 2) {
1858 loadServerConfig(argv
[1]);
1859 } else if (!strcasecmp(argv
[0],"maxclients") && argc
== 2) {
1860 server
.maxclients
= atoi(argv
[1]);
1861 } else if (!strcasecmp(argv
[0],"maxmemory") && argc
== 2) {
1862 server
.maxmemory
= memtoll(argv
[1],NULL
);
1863 } else if (!strcasecmp(argv
[0],"slaveof") && argc
== 3) {
1864 server
.masterhost
= sdsnew(argv
[1]);
1865 server
.masterport
= atoi(argv
[2]);
1866 server
.replstate
= REDIS_REPL_CONNECT
;
1867 } else if (!strcasecmp(argv
[0],"masterauth") && argc
== 2) {
1868 server
.masterauth
= zstrdup(argv
[1]);
1869 } else if (!strcasecmp(argv
[0],"glueoutputbuf") && argc
== 2) {
1870 if ((server
.glueoutputbuf
= yesnotoi(argv
[1])) == -1) {
1871 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1873 } else if (!strcasecmp(argv
[0],"rdbcompression") && argc
== 2) {
1874 if ((server
.rdbcompression
= yesnotoi(argv
[1])) == -1) {
1875 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1877 } else if (!strcasecmp(argv
[0],"activerehashing") && argc
== 2) {
1878 if ((server
.activerehashing
= yesnotoi(argv
[1])) == -1) {
1879 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1881 } else if (!strcasecmp(argv
[0],"daemonize") && argc
== 2) {
1882 if ((server
.daemonize
= yesnotoi(argv
[1])) == -1) {
1883 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1885 } else if (!strcasecmp(argv
[0],"appendonly") && argc
== 2) {
1886 if ((server
.appendonly
= yesnotoi(argv
[1])) == -1) {
1887 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1889 } else if (!strcasecmp(argv
[0],"appendfsync") && argc
== 2) {
1890 if (!strcasecmp(argv
[1],"no")) {
1891 server
.appendfsync
= APPENDFSYNC_NO
;
1892 } else if (!strcasecmp(argv
[1],"always")) {
1893 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1894 } else if (!strcasecmp(argv
[1],"everysec")) {
1895 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1897 err
= "argument must be 'no', 'always' or 'everysec'";
1900 } else if (!strcasecmp(argv
[0],"requirepass") && argc
== 2) {
1901 server
.requirepass
= zstrdup(argv
[1]);
1902 } else if (!strcasecmp(argv
[0],"pidfile") && argc
== 2) {
1903 zfree(server
.pidfile
);
1904 server
.pidfile
= zstrdup(argv
[1]);
1905 } else if (!strcasecmp(argv
[0],"dbfilename") && argc
== 2) {
1906 zfree(server
.dbfilename
);
1907 server
.dbfilename
= zstrdup(argv
[1]);
1908 } else if (!strcasecmp(argv
[0],"vm-enabled") && argc
== 2) {
1909 if ((server
.vm_enabled
= yesnotoi(argv
[1])) == -1) {
1910 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1912 } else if (!strcasecmp(argv
[0],"vm-swap-file") && argc
== 2) {
1913 zfree(server
.vm_swap_file
);
1914 server
.vm_swap_file
= zstrdup(argv
[1]);
1915 } else if (!strcasecmp(argv
[0],"vm-max-memory") && argc
== 2) {
1916 server
.vm_max_memory
= memtoll(argv
[1],NULL
);
1917 } else if (!strcasecmp(argv
[0],"vm-page-size") && argc
== 2) {
1918 server
.vm_page_size
= memtoll(argv
[1], NULL
);
1919 } else if (!strcasecmp(argv
[0],"vm-pages") && argc
== 2) {
1920 server
.vm_pages
= memtoll(argv
[1], NULL
);
1921 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1922 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1923 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-entries") && argc
== 2){
1924 server
.hash_max_zipmap_entries
= memtoll(argv
[1], NULL
);
1925 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-value") && argc
== 2){
1926 server
.hash_max_zipmap_value
= memtoll(argv
[1], NULL
);
1928 err
= "Bad directive or wrong number of arguments"; goto loaderr
;
1930 for (j
= 0; j
< argc
; j
++)
1935 if (fp
!= stdin
) fclose(fp
);
1939 fprintf(stderr
, "\n*** FATAL CONFIG FILE ERROR ***\n");
1940 fprintf(stderr
, "Reading the configuration file, at line %d\n", linenum
);
1941 fprintf(stderr
, ">>> '%s'\n", line
);
1942 fprintf(stderr
, "%s\n", err
);
1946 static void freeClientArgv(redisClient
*c
) {
1949 for (j
= 0; j
< c
->argc
; j
++)
1950 decrRefCount(c
->argv
[j
]);
1951 for (j
= 0; j
< c
->mbargc
; j
++)
1952 decrRefCount(c
->mbargv
[j
]);
1957 static void freeClient(redisClient
*c
) {
1960 /* Note that if the client we are freeing is blocked into a blocking
1961 * call, we have to set querybuf to NULL *before* to call
1962 * unblockClientWaitingData() to avoid processInputBuffer() will get
1963 * called. Also it is important to remove the file events after
1964 * this, because this call adds the READABLE event. */
1965 sdsfree(c
->querybuf
);
1967 if (c
->flags
& REDIS_BLOCKED
)
1968 unblockClientWaitingData(c
);
1970 /* Unsubscribe from all the pubsub channels */
1971 pubsubUnsubscribeAllChannels(c
,0);
1972 pubsubUnsubscribeAllPatterns(c
,0);
1973 dictRelease(c
->pubsub_channels
);
1974 listRelease(c
->pubsub_patterns
);
1975 /* Obvious cleanup */
1976 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
1977 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1978 listRelease(c
->reply
);
1981 /* Remove from the list of clients */
1982 ln
= listSearchKey(server
.clients
,c
);
1983 redisAssert(ln
!= NULL
);
1984 listDelNode(server
.clients
,ln
);
1985 /* Remove from the list of clients waiting for swapped keys */
1986 if (c
->flags
& REDIS_IO_WAIT
&& listLength(c
->io_keys
) == 0) {
1987 ln
= listSearchKey(server
.io_ready_clients
,c
);
1989 listDelNode(server
.io_ready_clients
,ln
);
1990 server
.vm_blocked_clients
--;
1993 while (server
.vm_enabled
&& listLength(c
->io_keys
)) {
1994 ln
= listFirst(c
->io_keys
);
1995 dontWaitForSwappedKey(c
,ln
->value
);
1997 listRelease(c
->io_keys
);
1998 /* Master/slave cleanup */
1999 if (c
->flags
& REDIS_SLAVE
) {
2000 if (c
->replstate
== REDIS_REPL_SEND_BULK
&& c
->repldbfd
!= -1)
2002 list
*l
= (c
->flags
& REDIS_MONITOR
) ? server
.monitors
: server
.slaves
;
2003 ln
= listSearchKey(l
,c
);
2004 redisAssert(ln
!= NULL
);
2007 if (c
->flags
& REDIS_MASTER
) {
2008 server
.master
= NULL
;
2009 server
.replstate
= REDIS_REPL_CONNECT
;
2011 /* Release memory */
2014 freeClientMultiState(c
);
2018 #define GLUEREPLY_UP_TO (1024)
2019 static void glueReplyBuffersIfNeeded(redisClient
*c
) {
2021 char buf
[GLUEREPLY_UP_TO
];
2026 listRewind(c
->reply
,&li
);
2027 while((ln
= listNext(&li
))) {
2031 objlen
= sdslen(o
->ptr
);
2032 if (copylen
+ objlen
<= GLUEREPLY_UP_TO
) {
2033 memcpy(buf
+copylen
,o
->ptr
,objlen
);
2035 listDelNode(c
->reply
,ln
);
2037 if (copylen
== 0) return;
2041 /* Now the output buffer is empty, add the new single element */
2042 o
= createObject(REDIS_STRING
,sdsnewlen(buf
,copylen
));
2043 listAddNodeHead(c
->reply
,o
);
2046 static void sendReplyToClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2047 redisClient
*c
= privdata
;
2048 int nwritten
= 0, totwritten
= 0, objlen
;
2051 REDIS_NOTUSED(mask
);
2053 /* Use writev() if we have enough buffers to send */
2054 if (!server
.glueoutputbuf
&&
2055 listLength(c
->reply
) > REDIS_WRITEV_THRESHOLD
&&
2056 !(c
->flags
& REDIS_MASTER
))
2058 sendReplyToClientWritev(el
, fd
, privdata
, mask
);
2062 while(listLength(c
->reply
)) {
2063 if (server
.glueoutputbuf
&& listLength(c
->reply
) > 1)
2064 glueReplyBuffersIfNeeded(c
);
2066 o
= listNodeValue(listFirst(c
->reply
));
2067 objlen
= sdslen(o
->ptr
);
2070 listDelNode(c
->reply
,listFirst(c
->reply
));
2074 if (c
->flags
& REDIS_MASTER
) {
2075 /* Don't reply to a master */
2076 nwritten
= objlen
- c
->sentlen
;
2078 nwritten
= write(fd
, ((char*)o
->ptr
)+c
->sentlen
, objlen
- c
->sentlen
);
2079 if (nwritten
<= 0) break;
2081 c
->sentlen
+= nwritten
;
2082 totwritten
+= nwritten
;
2083 /* If we fully sent the object on head go to the next one */
2084 if (c
->sentlen
== objlen
) {
2085 listDelNode(c
->reply
,listFirst(c
->reply
));
2088 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
2089 * bytes, in a single threaded server it's a good idea to serve
2090 * other clients as well, even if a very large request comes from
2091 * super fast link that is always able to accept data (in real world
2092 * scenario think about 'KEYS *' against the loopback interfae) */
2093 if (totwritten
> REDIS_MAX_WRITE_PER_EVENT
) break;
2095 if (nwritten
== -1) {
2096 if (errno
== EAGAIN
) {
2099 redisLog(REDIS_VERBOSE
,
2100 "Error writing to client: %s", strerror(errno
));
2105 if (totwritten
> 0) c
->lastinteraction
= time(NULL
);
2106 if (listLength(c
->reply
) == 0) {
2108 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2112 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
)
2114 redisClient
*c
= privdata
;
2115 int nwritten
= 0, totwritten
= 0, objlen
, willwrite
;
2117 struct iovec iov
[REDIS_WRITEV_IOVEC_COUNT
];
2118 int offset
, ion
= 0;
2120 REDIS_NOTUSED(mask
);
2123 while (listLength(c
->reply
)) {
2124 offset
= c
->sentlen
;
2128 /* fill-in the iov[] array */
2129 for(node
= listFirst(c
->reply
); node
; node
= listNextNode(node
)) {
2130 o
= listNodeValue(node
);
2131 objlen
= sdslen(o
->ptr
);
2133 if (totwritten
+ objlen
- offset
> REDIS_MAX_WRITE_PER_EVENT
)
2136 if(ion
== REDIS_WRITEV_IOVEC_COUNT
)
2137 break; /* no more iovecs */
2139 iov
[ion
].iov_base
= ((char*)o
->ptr
) + offset
;
2140 iov
[ion
].iov_len
= objlen
- offset
;
2141 willwrite
+= objlen
- offset
;
2142 offset
= 0; /* just for the first item */
2149 /* write all collected blocks at once */
2150 if((nwritten
= writev(fd
, iov
, ion
)) < 0) {
2151 if (errno
!= EAGAIN
) {
2152 redisLog(REDIS_VERBOSE
,
2153 "Error writing to client: %s", strerror(errno
));
2160 totwritten
+= nwritten
;
2161 offset
= c
->sentlen
;
2163 /* remove written robjs from c->reply */
2164 while (nwritten
&& listLength(c
->reply
)) {
2165 o
= listNodeValue(listFirst(c
->reply
));
2166 objlen
= sdslen(o
->ptr
);
2168 if(nwritten
>= objlen
- offset
) {
2169 listDelNode(c
->reply
, listFirst(c
->reply
));
2170 nwritten
-= objlen
- offset
;
2174 c
->sentlen
+= nwritten
;
2182 c
->lastinteraction
= time(NULL
);
2184 if (listLength(c
->reply
) == 0) {
2186 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2190 static struct redisCommand
*lookupCommand(char *name
) {
2192 while(cmdTable
[j
].name
!= NULL
) {
2193 if (!strcasecmp(name
,cmdTable
[j
].name
)) return &cmdTable
[j
];
2199 /* resetClient prepare the client to process the next command */
2200 static void resetClient(redisClient
*c
) {
2206 /* Call() is the core of Redis execution of a command */
2207 static void call(redisClient
*c
, struct redisCommand
*cmd
) {
2210 dirty
= server
.dirty
;
2212 dirty
= server
.dirty
-dirty
;
2214 if (server
.appendonly
&& dirty
)
2215 feedAppendOnlyFile(cmd
,c
->db
->id
,c
->argv
,c
->argc
);
2216 if ((dirty
|| cmd
->flags
& REDIS_CMD_FORCE_REPLICATION
) &&
2217 listLength(server
.slaves
))
2218 replicationFeedSlaves(server
.slaves
,c
->db
->id
,c
->argv
,c
->argc
);
2219 if (listLength(server
.monitors
))
2220 replicationFeedMonitors(server
.monitors
,c
->db
->id
,c
->argv
,c
->argc
);
2221 server
.stat_numcommands
++;
2224 /* If this function gets called we already read a whole
2225 * command, argments are in the client argv/argc fields.
2226 * processCommand() execute the command or prepare the
2227 * server for a bulk read from the client.
2229 * If 1 is returned the client is still alive and valid and
2230 * and other operations can be performed by the caller. Otherwise
2231 * if 0 is returned the client was destroied (i.e. after QUIT). */
2232 static int processCommand(redisClient
*c
) {
2233 struct redisCommand
*cmd
;
2235 /* Free some memory if needed (maxmemory setting) */
2236 if (server
.maxmemory
) freeMemoryIfNeeded();
2238 /* Handle the multi bulk command type. This is an alternative protocol
2239 * supported by Redis in order to receive commands that are composed of
2240 * multiple binary-safe "bulk" arguments. The latency of processing is
2241 * a bit higher but this allows things like multi-sets, so if this
2242 * protocol is used only for MSET and similar commands this is a big win. */
2243 if (c
->multibulk
== 0 && c
->argc
== 1 && ((char*)(c
->argv
[0]->ptr
))[0] == '*') {
2244 c
->multibulk
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2245 if (c
->multibulk
<= 0) {
2249 decrRefCount(c
->argv
[c
->argc
-1]);
2253 } else if (c
->multibulk
) {
2254 if (c
->bulklen
== -1) {
2255 if (((char*)c
->argv
[0]->ptr
)[0] != '$') {
2256 addReplySds(c
,sdsnew("-ERR multi bulk protocol error\r\n"));
2260 int bulklen
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2261 decrRefCount(c
->argv
[0]);
2262 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2264 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2269 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2273 c
->mbargv
= zrealloc(c
->mbargv
,(sizeof(robj
*))*(c
->mbargc
+1));
2274 c
->mbargv
[c
->mbargc
] = c
->argv
[0];
2278 if (c
->multibulk
== 0) {
2282 /* Here we need to swap the multi-bulk argc/argv with the
2283 * normal argc/argv of the client structure. */
2285 c
->argv
= c
->mbargv
;
2286 c
->mbargv
= auxargv
;
2289 c
->argc
= c
->mbargc
;
2290 c
->mbargc
= auxargc
;
2292 /* We need to set bulklen to something different than -1
2293 * in order for the code below to process the command without
2294 * to try to read the last argument of a bulk command as
2295 * a special argument. */
2297 /* continue below and process the command */
2304 /* -- end of multi bulk commands processing -- */
2306 /* The QUIT command is handled as a special case. Normal command
2307 * procs are unable to close the client connection safely */
2308 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
2313 /* Now lookup the command and check ASAP about trivial error conditions
2314 * such wrong arity, bad command name and so forth. */
2315 cmd
= lookupCommand(c
->argv
[0]->ptr
);
2318 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2319 (char*)c
->argv
[0]->ptr
));
2322 } else if ((cmd
->arity
> 0 && cmd
->arity
!= c
->argc
) ||
2323 (c
->argc
< -cmd
->arity
)) {
2325 sdscatprintf(sdsempty(),
2326 "-ERR wrong number of arguments for '%s' command\r\n",
2330 } else if (cmd
->flags
& REDIS_CMD_BULK
&& c
->bulklen
== -1) {
2331 /* This is a bulk command, we have to read the last argument yet. */
2332 int bulklen
= atoi(c
->argv
[c
->argc
-1]->ptr
);
2334 decrRefCount(c
->argv
[c
->argc
-1]);
2335 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2337 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2342 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2343 /* It is possible that the bulk read is already in the
2344 * buffer. Check this condition and handle it accordingly.
2345 * This is just a fast path, alternative to call processInputBuffer().
2346 * It's a good idea since the code is small and this condition
2347 * happens most of the times. */
2348 if ((signed)sdslen(c
->querybuf
) >= c
->bulklen
) {
2349 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2351 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2353 /* Otherwise return... there is to read the last argument
2354 * from the socket. */
2358 /* Let's try to encode the bulk object to save space. */
2359 if (cmd
->flags
& REDIS_CMD_BULK
)
2360 c
->argv
[c
->argc
-1] = tryObjectEncoding(c
->argv
[c
->argc
-1]);
2362 /* Check if the user is authenticated */
2363 if (server
.requirepass
&& !c
->authenticated
&& cmd
->proc
!= authCommand
) {
2364 addReplySds(c
,sdsnew("-ERR operation not permitted\r\n"));
2369 /* Handle the maxmemory directive */
2370 if (server
.maxmemory
&& (cmd
->flags
& REDIS_CMD_DENYOOM
) &&
2371 zmalloc_used_memory() > server
.maxmemory
)
2373 addReplySds(c
,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2378 /* Only allow SUBSCRIBE and UNSUBSCRIBE in the context of Pub/Sub */
2379 if ((dictSize(c
->pubsub_channels
) > 0 || listLength(c
->pubsub_patterns
) > 0)
2381 cmd
->proc
!= subscribeCommand
&& cmd
->proc
!= unsubscribeCommand
&&
2382 cmd
->proc
!= psubscribeCommand
&& cmd
->proc
!= punsubscribeCommand
) {
2383 addReplySds(c
,sdsnew("-ERR only (P)SUBSCRIBE / (P)UNSUBSCRIBE / QUIT allowed in this context\r\n"));
2388 /* Exec the command */
2389 if (c
->flags
& REDIS_MULTI
&& cmd
->proc
!= execCommand
&& cmd
->proc
!= discardCommand
) {
2390 queueMultiCommand(c
,cmd
);
2391 addReply(c
,shared
.queued
);
2393 if (server
.vm_enabled
&& server
.vm_max_threads
> 0 &&
2394 blockClientOnSwappedKeys(cmd
,c
)) return 1;
2398 /* Prepare the client for the next command */
2403 static void replicationFeedSlaves(list
*slaves
, int dictid
, robj
**argv
, int argc
) {
2408 /* We need 1+(ARGS*3) objects since commands are using the new protocol
2409 * and we one 1 object for the first "*<count>\r\n" multibulk count, then
2410 * for every additional object we have "$<count>\r\n" + object + "\r\n". */
2411 robj
*static_outv
[REDIS_STATIC_ARGS
*3+1];
2414 if (argc
<= REDIS_STATIC_ARGS
) {
2417 outv
= zmalloc(sizeof(robj
*)*(argc
*3+1));
2420 lenobj
= createObject(REDIS_STRING
,
2421 sdscatprintf(sdsempty(), "*%d\r\n", argc
));
2422 lenobj
->refcount
= 0;
2423 outv
[outc
++] = lenobj
;
2424 for (j
= 0; j
< argc
; j
++) {
2425 lenobj
= createObject(REDIS_STRING
,
2426 sdscatprintf(sdsempty(),"$%lu\r\n",
2427 (unsigned long) stringObjectLen(argv
[j
])));
2428 lenobj
->refcount
= 0;
2429 outv
[outc
++] = lenobj
;
2430 outv
[outc
++] = argv
[j
];
2431 outv
[outc
++] = shared
.crlf
;
2434 /* Increment all the refcounts at start and decrement at end in order to
2435 * be sure to free objects if there is no slave in a replication state
2436 * able to be feed with commands */
2437 for (j
= 0; j
< outc
; j
++) incrRefCount(outv
[j
]);
2438 listRewind(slaves
,&li
);
2439 while((ln
= listNext(&li
))) {
2440 redisClient
*slave
= ln
->value
;
2442 /* Don't feed slaves that are still waiting for BGSAVE to start */
2443 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) continue;
2445 /* Feed all the other slaves, MONITORs and so on */
2446 if (slave
->slaveseldb
!= dictid
) {
2450 case 0: selectcmd
= shared
.select0
; break;
2451 case 1: selectcmd
= shared
.select1
; break;
2452 case 2: selectcmd
= shared
.select2
; break;
2453 case 3: selectcmd
= shared
.select3
; break;
2454 case 4: selectcmd
= shared
.select4
; break;
2455 case 5: selectcmd
= shared
.select5
; break;
2456 case 6: selectcmd
= shared
.select6
; break;
2457 case 7: selectcmd
= shared
.select7
; break;
2458 case 8: selectcmd
= shared
.select8
; break;
2459 case 9: selectcmd
= shared
.select9
; break;
2461 selectcmd
= createObject(REDIS_STRING
,
2462 sdscatprintf(sdsempty(),"select %d\r\n",dictid
));
2463 selectcmd
->refcount
= 0;
2466 addReply(slave
,selectcmd
);
2467 slave
->slaveseldb
= dictid
;
2469 for (j
= 0; j
< outc
; j
++) addReply(slave
,outv
[j
]);
2471 for (j
= 0; j
< outc
; j
++) decrRefCount(outv
[j
]);
2472 if (outv
!= static_outv
) zfree(outv
);
2475 static sds
sdscatrepr(sds s
, char *p
, size_t len
) {
2476 s
= sdscatlen(s
,"\"",1);
2481 s
= sdscatprintf(s
,"\\%c",*p
);
2483 case '\n': s
= sdscatlen(s
,"\\n",1); break;
2484 case '\r': s
= sdscatlen(s
,"\\r",1); break;
2485 case '\t': s
= sdscatlen(s
,"\\t",1); break;
2486 case '\a': s
= sdscatlen(s
,"\\a",1); break;
2487 case '\b': s
= sdscatlen(s
,"\\b",1); break;
2490 s
= sdscatprintf(s
,"%c",*p
);
2492 s
= sdscatprintf(s
,"\\x%02x",(unsigned char)*p
);
2497 return sdscatlen(s
,"\"",1);
2500 static void replicationFeedMonitors(list
*monitors
, int dictid
, robj
**argv
, int argc
) {
2504 sds cmdrepr
= sdsnew("+");
2508 gettimeofday(&tv
,NULL
);
2509 cmdrepr
= sdscatprintf(cmdrepr
,"%ld.%ld ",(long)tv
.tv_sec
,(long)tv
.tv_usec
);
2510 if (dictid
!= 0) cmdrepr
= sdscatprintf(cmdrepr
,"(db %d) ", dictid
);
2512 for (j
= 0; j
< argc
; j
++) {
2513 if (argv
[j
]->encoding
== REDIS_ENCODING_INT
) {
2514 cmdrepr
= sdscatprintf(cmdrepr
, "%ld", (long)argv
[j
]->ptr
);
2516 cmdrepr
= sdscatrepr(cmdrepr
,(char*)argv
[j
]->ptr
,
2517 sdslen(argv
[j
]->ptr
));
2520 cmdrepr
= sdscatlen(cmdrepr
," ",1);
2522 cmdrepr
= sdscatlen(cmdrepr
,"\r\n",2);
2523 cmdobj
= createObject(REDIS_STRING
,cmdrepr
);
2525 listRewind(monitors
,&li
);
2526 while((ln
= listNext(&li
))) {
2527 redisClient
*monitor
= ln
->value
;
2528 addReply(monitor
,cmdobj
);
2530 decrRefCount(cmdobj
);
2533 static void processInputBuffer(redisClient
*c
) {
2535 /* Before to process the input buffer, make sure the client is not
2536 * waitig for a blocking operation such as BLPOP. Note that the first
2537 * iteration the client is never blocked, otherwise the processInputBuffer
2538 * would not be called at all, but after the execution of the first commands
2539 * in the input buffer the client may be blocked, and the "goto again"
2540 * will try to reiterate. The following line will make it return asap. */
2541 if (c
->flags
& REDIS_BLOCKED
|| c
->flags
& REDIS_IO_WAIT
) return;
2542 if (c
->bulklen
== -1) {
2543 /* Read the first line of the query */
2544 char *p
= strchr(c
->querybuf
,'\n');
2551 query
= c
->querybuf
;
2552 c
->querybuf
= sdsempty();
2553 querylen
= 1+(p
-(query
));
2554 if (sdslen(query
) > querylen
) {
2555 /* leave data after the first line of the query in the buffer */
2556 c
->querybuf
= sdscatlen(c
->querybuf
,query
+querylen
,sdslen(query
)-querylen
);
2558 *p
= '\0'; /* remove "\n" */
2559 if (*(p
-1) == '\r') *(p
-1) = '\0'; /* and "\r" if any */
2560 sdsupdatelen(query
);
2562 /* Now we can split the query in arguments */
2563 argv
= sdssplitlen(query
,sdslen(query
)," ",1,&argc
);
2566 if (c
->argv
) zfree(c
->argv
);
2567 c
->argv
= zmalloc(sizeof(robj
*)*argc
);
2569 for (j
= 0; j
< argc
; j
++) {
2570 if (sdslen(argv
[j
])) {
2571 c
->argv
[c
->argc
] = createObject(REDIS_STRING
,argv
[j
]);
2579 /* Execute the command. If the client is still valid
2580 * after processCommand() return and there is something
2581 * on the query buffer try to process the next command. */
2582 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2584 /* Nothing to process, argc == 0. Just process the query
2585 * buffer if it's not empty or return to the caller */
2586 if (sdslen(c
->querybuf
)) goto again
;
2589 } else if (sdslen(c
->querybuf
) >= REDIS_REQUEST_MAX_SIZE
) {
2590 redisLog(REDIS_VERBOSE
, "Client protocol error");
2595 /* Bulk read handling. Note that if we are at this point
2596 the client already sent a command terminated with a newline,
2597 we are reading the bulk data that is actually the last
2598 argument of the command. */
2599 int qbl
= sdslen(c
->querybuf
);
2601 if (c
->bulklen
<= qbl
) {
2602 /* Copy everything but the final CRLF as final argument */
2603 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2605 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2606 /* Process the command. If the client is still valid after
2607 * the processing and there is more data in the buffer
2608 * try to parse it. */
2609 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2615 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2616 redisClient
*c
= (redisClient
*) privdata
;
2617 char buf
[REDIS_IOBUF_LEN
];
2620 REDIS_NOTUSED(mask
);
2622 nread
= read(fd
, buf
, REDIS_IOBUF_LEN
);
2624 if (errno
== EAGAIN
) {
2627 redisLog(REDIS_VERBOSE
, "Reading from client: %s",strerror(errno
));
2631 } else if (nread
== 0) {
2632 redisLog(REDIS_VERBOSE
, "Client closed connection");
2637 c
->querybuf
= sdscatlen(c
->querybuf
, buf
, nread
);
2638 c
->lastinteraction
= time(NULL
);
2642 processInputBuffer(c
);
2645 static int selectDb(redisClient
*c
, int id
) {
2646 if (id
< 0 || id
>= server
.dbnum
)
2648 c
->db
= &server
.db
[id
];
2652 static void *dupClientReplyValue(void *o
) {
2653 incrRefCount((robj
*)o
);
2657 static int listMatchObjects(void *a
, void *b
) {
2658 return compareStringObjects(a
,b
) == 0;
2661 static redisClient
*createClient(int fd
) {
2662 redisClient
*c
= zmalloc(sizeof(*c
));
2664 anetNonBlock(NULL
,fd
);
2665 anetTcpNoDelay(NULL
,fd
);
2666 if (!c
) return NULL
;
2669 c
->querybuf
= sdsempty();
2678 c
->lastinteraction
= time(NULL
);
2679 c
->authenticated
= 0;
2680 c
->replstate
= REDIS_REPL_NONE
;
2681 c
->reply
= listCreate();
2682 listSetFreeMethod(c
->reply
,decrRefCount
);
2683 listSetDupMethod(c
->reply
,dupClientReplyValue
);
2684 c
->blockingkeys
= NULL
;
2685 c
->blockingkeysnum
= 0;
2686 c
->io_keys
= listCreate();
2687 listSetFreeMethod(c
->io_keys
,decrRefCount
);
2688 c
->pubsub_channels
= dictCreate(&setDictType
,NULL
);
2689 c
->pubsub_patterns
= listCreate();
2690 listSetFreeMethod(c
->pubsub_patterns
,decrRefCount
);
2691 listSetMatchMethod(c
->pubsub_patterns
,listMatchObjects
);
2692 if (aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
2693 readQueryFromClient
, c
) == AE_ERR
) {
2697 listAddNodeTail(server
.clients
,c
);
2698 initClientMultiState(c
);
2702 static void addReply(redisClient
*c
, robj
*obj
) {
2703 if (listLength(c
->reply
) == 0 &&
2704 (c
->replstate
== REDIS_REPL_NONE
||
2705 c
->replstate
== REDIS_REPL_ONLINE
) &&
2706 aeCreateFileEvent(server
.el
, c
->fd
, AE_WRITABLE
,
2707 sendReplyToClient
, c
) == AE_ERR
) return;
2709 if (server
.vm_enabled
&& obj
->storage
!= REDIS_VM_MEMORY
) {
2710 obj
= dupStringObject(obj
);
2711 obj
->refcount
= 0; /* getDecodedObject() will increment the refcount */
2713 listAddNodeTail(c
->reply
,getDecodedObject(obj
));
2716 static void addReplySds(redisClient
*c
, sds s
) {
2717 robj
*o
= createObject(REDIS_STRING
,s
);
2722 static void addReplyDouble(redisClient
*c
, double d
) {
2725 snprintf(buf
,sizeof(buf
),"%.17g",d
);
2726 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2727 (unsigned long) strlen(buf
),buf
));
2730 static void addReplyLong(redisClient
*c
, long l
) {
2735 addReply(c
,shared
.czero
);
2737 } else if (l
== 1) {
2738 addReply(c
,shared
.cone
);
2741 len
= snprintf(buf
,sizeof(buf
),":%ld\r\n",l
);
2742 addReplySds(c
,sdsnewlen(buf
,len
));
2745 static void addReplyLongLong(redisClient
*c
, long long ll
) {
2750 addReply(c
,shared
.czero
);
2752 } else if (ll
== 1) {
2753 addReply(c
,shared
.cone
);
2756 len
= snprintf(buf
,sizeof(buf
),":%lld\r\n",ll
);
2757 addReplySds(c
,sdsnewlen(buf
,len
));
2760 static void addReplyUlong(redisClient
*c
, unsigned long ul
) {
2765 addReply(c
,shared
.czero
);
2767 } else if (ul
== 1) {
2768 addReply(c
,shared
.cone
);
2771 len
= snprintf(buf
,sizeof(buf
),":%lu\r\n",ul
);
2772 addReplySds(c
,sdsnewlen(buf
,len
));
2775 static void addReplyBulkLen(redisClient
*c
, robj
*obj
) {
2778 if (obj
->encoding
== REDIS_ENCODING_RAW
) {
2779 len
= sdslen(obj
->ptr
);
2781 long n
= (long)obj
->ptr
;
2783 /* Compute how many bytes will take this integer as a radix 10 string */
2789 while((n
= n
/10) != 0) {
2793 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",(unsigned long)len
));
2796 static void addReplyBulk(redisClient
*c
, robj
*obj
) {
2797 addReplyBulkLen(c
,obj
);
2799 addReply(c
,shared
.crlf
);
2802 /* In the CONFIG command we need to add vanilla C string as bulk replies */
2803 static void addReplyBulkCString(redisClient
*c
, char *s
) {
2805 addReply(c
,shared
.nullbulk
);
2807 robj
*o
= createStringObject(s
,strlen(s
));
2813 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2818 REDIS_NOTUSED(mask
);
2819 REDIS_NOTUSED(privdata
);
2821 cfd
= anetAccept(server
.neterr
, fd
, cip
, &cport
);
2822 if (cfd
== AE_ERR
) {
2823 redisLog(REDIS_VERBOSE
,"Accepting client connection: %s", server
.neterr
);
2826 redisLog(REDIS_VERBOSE
,"Accepted %s:%d", cip
, cport
);
2827 if ((c
= createClient(cfd
)) == NULL
) {
2828 redisLog(REDIS_WARNING
,"Error allocating resoures for the client");
2829 close(cfd
); /* May be already closed, just ingore errors */
2832 /* If maxclient directive is set and this is one client more... close the
2833 * connection. Note that we create the client instead to check before
2834 * for this condition, since now the socket is already set in nonblocking
2835 * mode and we can send an error for free using the Kernel I/O */
2836 if (server
.maxclients
&& listLength(server
.clients
) > server
.maxclients
) {
2837 char *err
= "-ERR max number of clients reached\r\n";
2839 /* That's a best effort error message, don't check write errors */
2840 if (write(c
->fd
,err
,strlen(err
)) == -1) {
2841 /* Nothing to do, Just to avoid the warning... */
2846 server
.stat_numconnections
++;
2849 /* ======================= Redis objects implementation ===================== */
2851 static robj
*createObject(int type
, void *ptr
) {
2854 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2855 if (listLength(server
.objfreelist
)) {
2856 listNode
*head
= listFirst(server
.objfreelist
);
2857 o
= listNodeValue(head
);
2858 listDelNode(server
.objfreelist
,head
);
2859 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2861 if (server
.vm_enabled
) {
2862 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2863 o
= zmalloc(sizeof(*o
));
2865 o
= zmalloc(sizeof(*o
)-sizeof(struct redisObjectVM
));
2869 o
->encoding
= REDIS_ENCODING_RAW
;
2872 if (server
.vm_enabled
) {
2873 /* Note that this code may run in the context of an I/O thread
2874 * and accessing to server.unixtime in theory is an error
2875 * (no locks). But in practice this is safe, and even if we read
2876 * garbage Redis will not fail, as it's just a statistical info */
2877 o
->vm
.atime
= server
.unixtime
;
2878 o
->storage
= REDIS_VM_MEMORY
;
2883 static robj
*createStringObject(char *ptr
, size_t len
) {
2884 return createObject(REDIS_STRING
,sdsnewlen(ptr
,len
));
2887 static robj
*createStringObjectFromLongLong(long long value
) {
2889 if (value
>= 0 && value
< REDIS_SHARED_INTEGERS
) {
2890 incrRefCount(shared
.integers
[value
]);
2891 o
= shared
.integers
[value
];
2893 o
= createObject(REDIS_STRING
, NULL
);
2894 if (value
>= LONG_MIN
&& value
<= LONG_MAX
) {
2895 o
->encoding
= REDIS_ENCODING_INT
;
2896 o
->ptr
= (void*)((long)value
);
2898 o
->ptr
= sdscatprintf(sdsempty(),"%lld",value
);
2904 static robj
*dupStringObject(robj
*o
) {
2905 assert(o
->encoding
== REDIS_ENCODING_RAW
);
2906 return createStringObject(o
->ptr
,sdslen(o
->ptr
));
2909 static robj
*createListObject(void) {
2910 list
*l
= listCreate();
2912 listSetFreeMethod(l
,decrRefCount
);
2913 return createObject(REDIS_LIST
,l
);
2916 static robj
*createSetObject(void) {
2917 dict
*d
= dictCreate(&setDictType
,NULL
);
2918 return createObject(REDIS_SET
,d
);
2921 static robj
*createHashObject(void) {
2922 /* All the Hashes start as zipmaps. Will be automatically converted
2923 * into hash tables if there are enough elements or big elements
2925 unsigned char *zm
= zipmapNew();
2926 robj
*o
= createObject(REDIS_HASH
,zm
);
2927 o
->encoding
= REDIS_ENCODING_ZIPMAP
;
2931 static robj
*createZsetObject(void) {
2932 zset
*zs
= zmalloc(sizeof(*zs
));
2934 zs
->dict
= dictCreate(&zsetDictType
,NULL
);
2935 zs
->zsl
= zslCreate();
2936 return createObject(REDIS_ZSET
,zs
);
2939 static void freeStringObject(robj
*o
) {
2940 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2945 static void freeListObject(robj
*o
) {
2946 listRelease((list
*) o
->ptr
);
2949 static void freeSetObject(robj
*o
) {
2950 dictRelease((dict
*) o
->ptr
);
2953 static void freeZsetObject(robj
*o
) {
2956 dictRelease(zs
->dict
);
2961 static void freeHashObject(robj
*o
) {
2962 switch (o
->encoding
) {
2963 case REDIS_ENCODING_HT
:
2964 dictRelease((dict
*) o
->ptr
);
2966 case REDIS_ENCODING_ZIPMAP
:
2970 redisPanic("Unknown hash encoding type");
2975 static void incrRefCount(robj
*o
) {
2979 static void decrRefCount(void *obj
) {
2982 if (o
->refcount
<= 0) redisPanic("decrRefCount against refcount <= 0");
2983 /* Object is a key of a swapped out value, or in the process of being
2985 if (server
.vm_enabled
&&
2986 (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
))
2988 if (o
->storage
== REDIS_VM_LOADING
) vmCancelThreadedIOJob(obj
);
2989 redisAssert(o
->type
== REDIS_STRING
);
2990 freeStringObject(o
);
2991 vmMarkPagesFree(o
->vm
.page
,o
->vm
.usedpages
);
2992 pthread_mutex_lock(&server
.obj_freelist_mutex
);
2993 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2994 !listAddNodeHead(server
.objfreelist
,o
))
2996 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2997 server
.vm_stats_swapped_objects
--;
3000 /* Object is in memory, or in the process of being swapped out. */
3001 if (--(o
->refcount
) == 0) {
3002 if (server
.vm_enabled
&& o
->storage
== REDIS_VM_SWAPPING
)
3003 vmCancelThreadedIOJob(obj
);
3005 case REDIS_STRING
: freeStringObject(o
); break;
3006 case REDIS_LIST
: freeListObject(o
); break;
3007 case REDIS_SET
: freeSetObject(o
); break;
3008 case REDIS_ZSET
: freeZsetObject(o
); break;
3009 case REDIS_HASH
: freeHashObject(o
); break;
3010 default: redisPanic("Unknown object type"); break;
3012 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
3013 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
3014 !listAddNodeHead(server
.objfreelist
,o
))
3016 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
3020 static robj
*lookupKey(redisDb
*db
, robj
*key
) {
3021 dictEntry
*de
= dictFind(db
->dict
,key
);
3023 robj
*key
= dictGetEntryKey(de
);
3024 robj
*val
= dictGetEntryVal(de
);
3026 if (server
.vm_enabled
) {
3027 if (key
->storage
== REDIS_VM_MEMORY
||
3028 key
->storage
== REDIS_VM_SWAPPING
)
3030 /* If we were swapping the object out, stop it, this key
3032 if (key
->storage
== REDIS_VM_SWAPPING
)
3033 vmCancelThreadedIOJob(key
);
3034 /* Update the access time of the key for the aging algorithm. */
3035 key
->vm
.atime
= server
.unixtime
;
3037 int notify
= (key
->storage
== REDIS_VM_LOADING
);
3039 /* Our value was swapped on disk. Bring it at home. */
3040 redisAssert(val
== NULL
);
3041 val
= vmLoadObject(key
);
3042 dictGetEntryVal(de
) = val
;
3044 /* Clients blocked by the VM subsystem may be waiting for
3046 if (notify
) handleClientsBlockedOnSwappedKey(db
,key
);
3055 static robj
*lookupKeyRead(redisDb
*db
, robj
*key
) {
3056 expireIfNeeded(db
,key
);
3057 return lookupKey(db
,key
);
3060 static robj
*lookupKeyWrite(redisDb
*db
, robj
*key
) {
3061 deleteIfVolatile(db
,key
);
3062 return lookupKey(db
,key
);
3065 static robj
*lookupKeyReadOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
3066 robj
*o
= lookupKeyRead(c
->db
, key
);
3067 if (!o
) addReply(c
,reply
);
3071 static robj
*lookupKeyWriteOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
3072 robj
*o
= lookupKeyWrite(c
->db
, key
);
3073 if (!o
) addReply(c
,reply
);
3077 static int checkType(redisClient
*c
, robj
*o
, int type
) {
3078 if (o
->type
!= type
) {
3079 addReply(c
,shared
.wrongtypeerr
);
3085 static int deleteKey(redisDb
*db
, robj
*key
) {
3088 /* We need to protect key from destruction: after the first dictDelete()
3089 * it may happen that 'key' is no longer valid if we don't increment
3090 * it's count. This may happen when we get the object reference directly
3091 * from the hash table with dictRandomKey() or dict iterators */
3093 if (dictSize(db
->expires
)) dictDelete(db
->expires
,key
);
3094 retval
= dictDelete(db
->dict
,key
);
3097 return retval
== DICT_OK
;
3100 /* Check if the nul-terminated string 's' can be represented by a long
3101 * (that is, is a number that fits into long without any other space or
3102 * character before or after the digits).
3104 * If so, the function returns REDIS_OK and *longval is set to the value
3105 * of the number. Otherwise REDIS_ERR is returned */
3106 static int isStringRepresentableAsLong(sds s
, long *longval
) {
3107 char buf
[32], *endptr
;
3111 value
= strtol(s
, &endptr
, 10);
3112 if (endptr
[0] != '\0') return REDIS_ERR
;
3113 slen
= snprintf(buf
,32,"%ld",value
);
3115 /* If the number converted back into a string is not identical
3116 * then it's not possible to encode the string as integer */
3117 if (sdslen(s
) != (unsigned)slen
|| memcmp(buf
,s
,slen
)) return REDIS_ERR
;
3118 if (longval
) *longval
= value
;
3122 /* Try to encode a string object in order to save space */
3123 static robj
*tryObjectEncoding(robj
*o
) {
3127 if (o
->encoding
!= REDIS_ENCODING_RAW
)
3128 return o
; /* Already encoded */
3130 /* It's not safe to encode shared objects: shared objects can be shared
3131 * everywhere in the "object space" of Redis. Encoded objects can only
3132 * appear as "values" (and not, for instance, as keys) */
3133 if (o
->refcount
> 1) return o
;
3135 /* Currently we try to encode only strings */
3136 redisAssert(o
->type
== REDIS_STRING
);
3138 /* Check if we can represent this string as a long integer */
3139 if (isStringRepresentableAsLong(s
,&value
) == REDIS_ERR
) return o
;
3141 /* Ok, this object can be encoded */
3142 if (value
>= 0 && value
< REDIS_SHARED_INTEGERS
) {
3144 incrRefCount(shared
.integers
[value
]);
3145 return shared
.integers
[value
];
3147 o
->encoding
= REDIS_ENCODING_INT
;
3149 o
->ptr
= (void*) value
;
3154 /* Get a decoded version of an encoded object (returned as a new object).
3155 * If the object is already raw-encoded just increment the ref count. */
3156 static robj
*getDecodedObject(robj
*o
) {
3159 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3163 if (o
->type
== REDIS_STRING
&& o
->encoding
== REDIS_ENCODING_INT
) {
3166 snprintf(buf
,32,"%ld",(long)o
->ptr
);
3167 dec
= createStringObject(buf
,strlen(buf
));
3170 redisPanic("Unknown encoding type");
3174 /* Compare two string objects via strcmp() or alike.
3175 * Note that the objects may be integer-encoded. In such a case we
3176 * use snprintf() to get a string representation of the numbers on the stack
3177 * and compare the strings, it's much faster than calling getDecodedObject().
3179 * Important note: if objects are not integer encoded, but binary-safe strings,
3180 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
3182 static int compareStringObjects(robj
*a
, robj
*b
) {
3183 redisAssert(a
->type
== REDIS_STRING
&& b
->type
== REDIS_STRING
);
3184 char bufa
[128], bufb
[128], *astr
, *bstr
;
3187 if (a
== b
) return 0;
3188 if (a
->encoding
!= REDIS_ENCODING_RAW
) {
3189 snprintf(bufa
,sizeof(bufa
),"%ld",(long) a
->ptr
);
3195 if (b
->encoding
!= REDIS_ENCODING_RAW
) {
3196 snprintf(bufb
,sizeof(bufb
),"%ld",(long) b
->ptr
);
3202 return bothsds
? sdscmp(astr
,bstr
) : strcmp(astr
,bstr
);
3205 static size_t stringObjectLen(robj
*o
) {
3206 redisAssert(o
->type
== REDIS_STRING
);
3207 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3208 return sdslen(o
->ptr
);
3212 return snprintf(buf
,32,"%ld",(long)o
->ptr
);
3216 static int getDoubleFromObject(robj
*o
, double *target
) {
3223 redisAssert(o
->type
== REDIS_STRING
);
3224 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3225 value
= strtod(o
->ptr
, &eptr
);
3226 if (eptr
[0] != '\0') return REDIS_ERR
;
3227 } else if (o
->encoding
== REDIS_ENCODING_INT
) {
3228 value
= (long)o
->ptr
;
3230 redisPanic("Unknown string encoding");
3238 static int getDoubleFromObjectOrReply(redisClient
*c
, robj
*o
, double *target
, const char *msg
) {
3240 if (getDoubleFromObject(o
, &value
) != REDIS_OK
) {
3242 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3244 addReplySds(c
, sdsnew("-ERR value is not a double\r\n"));
3253 static int getLongLongFromObject(robj
*o
, long long *target
) {
3260 redisAssert(o
->type
== REDIS_STRING
);
3261 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3262 value
= strtoll(o
->ptr
, &eptr
, 10);
3263 if (eptr
[0] != '\0') return REDIS_ERR
;
3264 } else if (o
->encoding
== REDIS_ENCODING_INT
) {
3265 value
= (long)o
->ptr
;
3267 redisPanic("Unknown string encoding");
3275 static int getLongLongFromObjectOrReply(redisClient
*c
, robj
*o
, long long *target
, const char *msg
) {
3277 if (getLongLongFromObject(o
, &value
) != REDIS_OK
) {
3279 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3281 addReplySds(c
, sdsnew("-ERR value is not an integer\r\n"));
3290 static int getLongFromObjectOrReply(redisClient
*c
, robj
*o
, long *target
, const char *msg
) {
3293 if (getLongLongFromObjectOrReply(c
, o
, &value
, msg
) != REDIS_OK
) return REDIS_ERR
;
3294 if (value
< LONG_MIN
|| value
> LONG_MAX
) {
3296 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3298 addReplySds(c
, sdsnew("-ERR value is out of range\r\n"));
3307 /*============================ RDB saving/loading =========================== */
3309 static int rdbSaveType(FILE *fp
, unsigned char type
) {
3310 if (fwrite(&type
,1,1,fp
) == 0) return -1;
3314 static int rdbSaveTime(FILE *fp
, time_t t
) {
3315 int32_t t32
= (int32_t) t
;
3316 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
3320 /* check rdbLoadLen() comments for more info */
3321 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
3322 unsigned char buf
[2];
3325 /* Save a 6 bit len */
3326 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
3327 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3328 } else if (len
< (1<<14)) {
3329 /* Save a 14 bit len */
3330 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
3332 if (fwrite(buf
,2,1,fp
) == 0) return -1;
3334 /* Save a 32 bit len */
3335 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
3336 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3338 if (fwrite(&len
,4,1,fp
) == 0) return -1;
3343 /* String objects in the form "2391" "-100" without any space and with a
3344 * range of values that can fit in an 8, 16 or 32 bit signed value can be
3345 * encoded as integers to save space */
3346 static int rdbTryIntegerEncoding(char *s
, size_t len
, unsigned char *enc
) {
3348 char *endptr
, buf
[32];
3350 /* Check if it's possible to encode this value as a number */
3351 value
= strtoll(s
, &endptr
, 10);
3352 if (endptr
[0] != '\0') return 0;
3353 snprintf(buf
,32,"%lld",value
);
3355 /* If the number converted back into a string is not identical
3356 * then it's not possible to encode the string as integer */
3357 if (strlen(buf
) != len
|| memcmp(buf
,s
,len
)) return 0;
3359 /* Finally check if it fits in our ranges */
3360 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
3361 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
3362 enc
[1] = value
&0xFF;
3364 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
3365 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
3366 enc
[1] = value
&0xFF;
3367 enc
[2] = (value
>>8)&0xFF;
3369 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
3370 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
3371 enc
[1] = value
&0xFF;
3372 enc
[2] = (value
>>8)&0xFF;
3373 enc
[3] = (value
>>16)&0xFF;
3374 enc
[4] = (value
>>24)&0xFF;
3381 static int rdbSaveLzfStringObject(FILE *fp
, unsigned char *s
, size_t len
) {
3382 size_t comprlen
, outlen
;
3386 /* We require at least four bytes compression for this to be worth it */
3387 if (len
<= 4) return 0;
3389 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
3390 comprlen
= lzf_compress(s
, len
, out
, outlen
);
3391 if (comprlen
== 0) {
3395 /* Data compressed! Let's save it on disk */
3396 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
3397 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
3398 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
3399 if (rdbSaveLen(fp
,len
) == -1) goto writeerr
;
3400 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
3409 /* Save a string objet as [len][data] on disk. If the object is a string
3410 * representation of an integer value we try to safe it in a special form */
3411 static int rdbSaveRawString(FILE *fp
, unsigned char *s
, size_t len
) {
3414 /* Try integer encoding */
3416 unsigned char buf
[5];
3417 if ((enclen
= rdbTryIntegerEncoding((char*)s
,len
,buf
)) > 0) {
3418 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3423 /* Try LZF compression - under 20 bytes it's unable to compress even
3424 * aaaaaaaaaaaaaaaaaa so skip it */
3425 if (server
.rdbcompression
&& len
> 20) {
3428 retval
= rdbSaveLzfStringObject(fp
,s
,len
);
3429 if (retval
== -1) return -1;
3430 if (retval
> 0) return 0;
3431 /* retval == 0 means data can't be compressed, save the old way */
3434 /* Store verbatim */
3435 if (rdbSaveLen(fp
,len
) == -1) return -1;
3436 if (len
&& fwrite(s
,len
,1,fp
) == 0) return -1;
3440 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
3441 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
3444 /* Avoid incr/decr ref count business when possible.
3445 * This plays well with copy-on-write given that we are probably
3446 * in a child process (BGSAVE). Also this makes sure key objects
3447 * of swapped objects are not incRefCount-ed (an assert does not allow
3448 * this in order to avoid bugs) */
3449 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
3450 obj
= getDecodedObject(obj
);
3451 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3454 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3459 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
3460 * 8 bit integer specifing the length of the representation.
3461 * This 8 bit integer has special values in order to specify the following
3467 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
3468 unsigned char buf
[128];
3474 } else if (!isfinite(val
)) {
3476 buf
[0] = (val
< 0) ? 255 : 254;
3478 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
3479 buf
[0] = strlen((char*)buf
+1);
3482 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
3486 /* Save a Redis object. */
3487 static int rdbSaveObject(FILE *fp
, robj
*o
) {
3488 if (o
->type
== REDIS_STRING
) {
3489 /* Save a string value */
3490 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
3491 } else if (o
->type
== REDIS_LIST
) {
3492 /* Save a list value */
3493 list
*list
= o
->ptr
;
3497 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
3498 listRewind(list
,&li
);
3499 while((ln
= listNext(&li
))) {
3500 robj
*eleobj
= listNodeValue(ln
);
3502 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3504 } else if (o
->type
== REDIS_SET
) {
3505 /* Save a set value */
3507 dictIterator
*di
= dictGetIterator(set
);
3510 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
3511 while((de
= dictNext(di
)) != NULL
) {
3512 robj
*eleobj
= dictGetEntryKey(de
);
3514 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3516 dictReleaseIterator(di
);
3517 } else if (o
->type
== REDIS_ZSET
) {
3518 /* Save a set value */
3520 dictIterator
*di
= dictGetIterator(zs
->dict
);
3523 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
3524 while((de
= dictNext(di
)) != NULL
) {
3525 robj
*eleobj
= dictGetEntryKey(de
);
3526 double *score
= dictGetEntryVal(de
);
3528 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3529 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
3531 dictReleaseIterator(di
);
3532 } else if (o
->type
== REDIS_HASH
) {
3533 /* Save a hash value */
3534 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3535 unsigned char *p
= zipmapRewind(o
->ptr
);
3536 unsigned int count
= zipmapLen(o
->ptr
);
3537 unsigned char *key
, *val
;
3538 unsigned int klen
, vlen
;
3540 if (rdbSaveLen(fp
,count
) == -1) return -1;
3541 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
3542 if (rdbSaveRawString(fp
,key
,klen
) == -1) return -1;
3543 if (rdbSaveRawString(fp
,val
,vlen
) == -1) return -1;
3546 dictIterator
*di
= dictGetIterator(o
->ptr
);
3549 if (rdbSaveLen(fp
,dictSize((dict
*)o
->ptr
)) == -1) return -1;
3550 while((de
= dictNext(di
)) != NULL
) {
3551 robj
*key
= dictGetEntryKey(de
);
3552 robj
*val
= dictGetEntryVal(de
);
3554 if (rdbSaveStringObject(fp
,key
) == -1) return -1;
3555 if (rdbSaveStringObject(fp
,val
) == -1) return -1;
3557 dictReleaseIterator(di
);
3560 redisPanic("Unknown object type");
3565 /* Return the length the object will have on disk if saved with
3566 * the rdbSaveObject() function. Currently we use a trick to get
3567 * this length with very little changes to the code. In the future
3568 * we could switch to a faster solution. */
3569 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
3570 if (fp
== NULL
) fp
= server
.devnull
;
3572 assert(rdbSaveObject(fp
,o
) != 1);
3576 /* Return the number of pages required to save this object in the swap file */
3577 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
3578 off_t bytes
= rdbSavedObjectLen(o
,fp
);
3580 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
3583 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3584 static int rdbSave(char *filename
) {
3585 dictIterator
*di
= NULL
;
3590 time_t now
= time(NULL
);
3592 /* Wait for I/O therads to terminate, just in case this is a
3593 * foreground-saving, to avoid seeking the swap file descriptor at the
3595 if (server
.vm_enabled
)
3596 waitEmptyIOJobsQueue();
3598 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3599 fp
= fopen(tmpfile
,"w");
3601 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3604 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3605 for (j
= 0; j
< server
.dbnum
; j
++) {
3606 redisDb
*db
= server
.db
+j
;
3608 if (dictSize(d
) == 0) continue;
3609 di
= dictGetIterator(d
);
3615 /* Write the SELECT DB opcode */
3616 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3617 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3619 /* Iterate this DB writing every entry */
3620 while((de
= dictNext(di
)) != NULL
) {
3621 robj
*key
= dictGetEntryKey(de
);
3622 robj
*o
= dictGetEntryVal(de
);
3623 time_t expiretime
= getExpire(db
,key
);
3625 /* Save the expire time */
3626 if (expiretime
!= -1) {
3627 /* If this key is already expired skip it */
3628 if (expiretime
< now
) continue;
3629 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3630 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3632 /* Save the key and associated value. This requires special
3633 * handling if the value is swapped out. */
3634 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
3635 key
->storage
== REDIS_VM_SWAPPING
) {
3636 /* Save type, key, value */
3637 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3638 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3639 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3641 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3643 /* Get a preview of the object in memory */
3644 po
= vmPreviewObject(key
);
3645 /* Save type, key, value */
3646 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
3647 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3648 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3649 /* Remove the loaded object from memory */
3653 dictReleaseIterator(di
);
3656 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3658 /* Make sure data will not remain on the OS's output buffers */
3663 /* Use RENAME to make sure the DB file is changed atomically only
3664 * if the generate DB file is ok. */
3665 if (rename(tmpfile
,filename
) == -1) {
3666 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3670 redisLog(REDIS_NOTICE
,"DB saved on disk");
3672 server
.lastsave
= time(NULL
);
3678 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3679 if (di
) dictReleaseIterator(di
);
3683 static int rdbSaveBackground(char *filename
) {
3686 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3687 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
3688 if ((childpid
= fork()) == 0) {
3690 if (server
.vm_enabled
) vmReopenSwapFile();
3692 if (rdbSave(filename
) == REDIS_OK
) {
3699 if (childpid
== -1) {
3700 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3704 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3705 server
.bgsavechildpid
= childpid
;
3706 updateDictResizePolicy();
3709 return REDIS_OK
; /* unreached */
3712 static void rdbRemoveTempFile(pid_t childpid
) {
3715 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
3719 static int rdbLoadType(FILE *fp
) {
3721 if (fread(&type
,1,1,fp
) == 0) return -1;
3725 static time_t rdbLoadTime(FILE *fp
) {
3727 if (fread(&t32
,4,1,fp
) == 0) return -1;
3728 return (time_t) t32
;
3731 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3732 * of this file for a description of how this are stored on disk.
3734 * isencoded is set to 1 if the readed length is not actually a length but
3735 * an "encoding type", check the above comments for more info */
3736 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3737 unsigned char buf
[2];
3741 if (isencoded
) *isencoded
= 0;
3742 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3743 type
= (buf
[0]&0xC0)>>6;
3744 if (type
== REDIS_RDB_6BITLEN
) {
3745 /* Read a 6 bit len */
3747 } else if (type
== REDIS_RDB_ENCVAL
) {
3748 /* Read a 6 bit len encoding type */
3749 if (isencoded
) *isencoded
= 1;
3751 } else if (type
== REDIS_RDB_14BITLEN
) {
3752 /* Read a 14 bit len */
3753 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3754 return ((buf
[0]&0x3F)<<8)|buf
[1];
3756 /* Read a 32 bit len */
3757 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3762 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
) {
3763 unsigned char enc
[4];
3766 if (enctype
== REDIS_RDB_ENC_INT8
) {
3767 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3768 val
= (signed char)enc
[0];
3769 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3771 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3772 v
= enc
[0]|(enc
[1]<<8);
3774 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3776 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3777 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3780 val
= 0; /* anti-warning */
3781 redisPanic("Unknown RDB integer encoding type");
3783 return createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",val
));
3786 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3787 unsigned int len
, clen
;
3788 unsigned char *c
= NULL
;
3791 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3792 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3793 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3794 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3795 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3796 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3798 return createObject(REDIS_STRING
,val
);
3805 static robj
*rdbLoadStringObject(FILE*fp
) {
3810 len
= rdbLoadLen(fp
,&isencoded
);
3813 case REDIS_RDB_ENC_INT8
:
3814 case REDIS_RDB_ENC_INT16
:
3815 case REDIS_RDB_ENC_INT32
:
3816 return rdbLoadIntegerObject(fp
,len
);
3817 case REDIS_RDB_ENC_LZF
:
3818 return rdbLoadLzfStringObject(fp
);
3820 redisPanic("Unknown RDB encoding type");
3824 if (len
== REDIS_RDB_LENERR
) return NULL
;
3825 val
= sdsnewlen(NULL
,len
);
3826 if (len
&& fread(val
,len
,1,fp
) == 0) {
3830 return createObject(REDIS_STRING
,val
);
3833 /* For information about double serialization check rdbSaveDoubleValue() */
3834 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
3838 if (fread(&len
,1,1,fp
) == 0) return -1;
3840 case 255: *val
= R_NegInf
; return 0;
3841 case 254: *val
= R_PosInf
; return 0;
3842 case 253: *val
= R_Nan
; return 0;
3844 if (fread(buf
,len
,1,fp
) == 0) return -1;
3846 sscanf(buf
, "%lg", val
);
3851 /* Load a Redis object of the specified type from the specified file.
3852 * On success a newly allocated object is returned, otherwise NULL. */
3853 static robj
*rdbLoadObject(int type
, FILE *fp
) {
3856 redisLog(REDIS_DEBUG
,"LOADING OBJECT %d (at %d)\n",type
,ftell(fp
));
3857 if (type
== REDIS_STRING
) {
3858 /* Read string value */
3859 if ((o
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3860 o
= tryObjectEncoding(o
);
3861 } else if (type
== REDIS_LIST
|| type
== REDIS_SET
) {
3862 /* Read list/set value */
3865 if ((listlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3866 o
= (type
== REDIS_LIST
) ? createListObject() : createSetObject();
3867 /* It's faster to expand the dict to the right size asap in order
3868 * to avoid rehashing */
3869 if (type
== REDIS_SET
&& listlen
> DICT_HT_INITIAL_SIZE
)
3870 dictExpand(o
->ptr
,listlen
);
3871 /* Load every single element of the list/set */
3875 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3876 ele
= tryObjectEncoding(ele
);
3877 if (type
== REDIS_LIST
) {
3878 listAddNodeTail((list
*)o
->ptr
,ele
);
3880 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
3883 } else if (type
== REDIS_ZSET
) {
3884 /* Read list/set value */
3888 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3889 o
= createZsetObject();
3891 /* Load every single element of the list/set */
3894 double *score
= zmalloc(sizeof(double));
3896 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3897 ele
= tryObjectEncoding(ele
);
3898 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
3899 dictAdd(zs
->dict
,ele
,score
);
3900 zslInsert(zs
->zsl
,*score
,ele
);
3901 incrRefCount(ele
); /* added to skiplist */
3903 } else if (type
== REDIS_HASH
) {
3906 if ((hashlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3907 o
= createHashObject();
3908 /* Too many entries? Use an hash table. */
3909 if (hashlen
> server
.hash_max_zipmap_entries
)
3910 convertToRealHash(o
);
3911 /* Load every key/value, then set it into the zipmap or hash
3912 * table, as needed. */
3916 if ((key
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3917 if ((val
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3918 /* If we are using a zipmap and there are too big values
3919 * the object is converted to real hash table encoding. */
3920 if (o
->encoding
!= REDIS_ENCODING_HT
&&
3921 (sdslen(key
->ptr
) > server
.hash_max_zipmap_value
||
3922 sdslen(val
->ptr
) > server
.hash_max_zipmap_value
))
3924 convertToRealHash(o
);
3927 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3928 unsigned char *zm
= o
->ptr
;
3930 zm
= zipmapSet(zm
,key
->ptr
,sdslen(key
->ptr
),
3931 val
->ptr
,sdslen(val
->ptr
),NULL
);
3936 key
= tryObjectEncoding(key
);
3937 val
= tryObjectEncoding(val
);
3938 dictAdd((dict
*)o
->ptr
,key
,val
);
3942 redisPanic("Unknown object type");
3947 static int rdbLoad(char *filename
) {
3949 robj
*keyobj
= NULL
;
3951 int type
, retval
, rdbver
;
3952 dict
*d
= server
.db
[0].dict
;
3953 redisDb
*db
= server
.db
+0;
3955 time_t expiretime
= -1, now
= time(NULL
);
3956 long long loadedkeys
= 0;
3958 fp
= fopen(filename
,"r");
3959 if (!fp
) return REDIS_ERR
;
3960 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
3962 if (memcmp(buf
,"REDIS",5) != 0) {
3964 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
3967 rdbver
= atoi(buf
+5);
3970 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
3977 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3978 if (type
== REDIS_EXPIRETIME
) {
3979 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
3980 /* We read the time so we need to read the object type again */
3981 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3983 if (type
== REDIS_EOF
) break;
3984 /* Handle SELECT DB opcode as a special case */
3985 if (type
== REDIS_SELECTDB
) {
3986 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
3988 if (dbid
>= (unsigned)server
.dbnum
) {
3989 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
3992 db
= server
.db
+dbid
;
3997 if ((keyobj
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
3999 if ((o
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
4000 /* Add the new object in the hash table */
4001 retval
= dictAdd(d
,keyobj
,o
);
4002 if (retval
== DICT_ERR
) {
4003 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", keyobj
->ptr
);
4006 /* Set the expire time if needed */
4007 if (expiretime
!= -1) {
4008 setExpire(db
,keyobj
,expiretime
);
4009 /* Delete this key if already expired */
4010 if (expiretime
< now
) deleteKey(db
,keyobj
);
4014 /* Handle swapping while loading big datasets when VM is on */
4016 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
4017 while (zmalloc_used_memory() > server
.vm_max_memory
) {
4018 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
4025 eoferr
: /* unexpected end of file is handled here with a fatal exit */
4026 if (keyobj
) decrRefCount(keyobj
);
4027 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
4029 return REDIS_ERR
; /* Just to avoid warning */
4032 /*================================== Commands =============================== */
4034 static void authCommand(redisClient
*c
) {
4035 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
4036 c
->authenticated
= 1;
4037 addReply(c
,shared
.ok
);
4039 c
->authenticated
= 0;
4040 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
4044 static void pingCommand(redisClient
*c
) {
4045 addReply(c
,shared
.pong
);
4048 static void echoCommand(redisClient
*c
) {
4049 addReplyBulk(c
,c
->argv
[1]);
4052 /*=================================== Strings =============================== */
4054 static void setGenericCommand(redisClient
*c
, int nx
, robj
*key
, robj
*val
, robj
*expire
) {
4056 long seconds
= 0; /* initialized to avoid an harmness warning */
4059 if (getLongFromObjectOrReply(c
, expire
, &seconds
, NULL
) != REDIS_OK
)
4062 addReplySds(c
,sdsnew("-ERR invalid expire time in SETEX\r\n"));
4067 if (nx
) deleteIfVolatile(c
->db
,key
);
4068 retval
= dictAdd(c
->db
->dict
,key
,val
);
4069 if (retval
== DICT_ERR
) {
4071 /* If the key is about a swapped value, we want a new key object
4072 * to overwrite the old. So we delete the old key in the database.
4073 * This will also make sure that swap pages about the old object
4074 * will be marked as free. */
4075 if (server
.vm_enabled
&& deleteIfSwapped(c
->db
,key
))
4077 dictReplace(c
->db
->dict
,key
,val
);
4080 addReply(c
,shared
.czero
);
4088 removeExpire(c
->db
,key
);
4089 if (expire
) setExpire(c
->db
,key
,time(NULL
)+seconds
);
4090 addReply(c
, nx
? shared
.cone
: shared
.ok
);
4093 static void setCommand(redisClient
*c
) {
4094 setGenericCommand(c
,0,c
->argv
[1],c
->argv
[2],NULL
);
4097 static void setnxCommand(redisClient
*c
) {
4098 setGenericCommand(c
,1,c
->argv
[1],c
->argv
[2],NULL
);
4101 static void setexCommand(redisClient
*c
) {
4102 setGenericCommand(c
,0,c
->argv
[1],c
->argv
[3],c
->argv
[2]);
4105 static int getGenericCommand(redisClient
*c
) {
4108 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
)
4111 if (o
->type
!= REDIS_STRING
) {
4112 addReply(c
,shared
.wrongtypeerr
);
4120 static void getCommand(redisClient
*c
) {
4121 getGenericCommand(c
);
4124 static void getsetCommand(redisClient
*c
) {
4125 if (getGenericCommand(c
) == REDIS_ERR
) return;
4126 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
4127 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4129 incrRefCount(c
->argv
[1]);
4131 incrRefCount(c
->argv
[2]);
4133 removeExpire(c
->db
,c
->argv
[1]);
4136 static void mgetCommand(redisClient
*c
) {
4139 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
4140 for (j
= 1; j
< c
->argc
; j
++) {
4141 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
4143 addReply(c
,shared
.nullbulk
);
4145 if (o
->type
!= REDIS_STRING
) {
4146 addReply(c
,shared
.nullbulk
);
4154 static void msetGenericCommand(redisClient
*c
, int nx
) {
4155 int j
, busykeys
= 0;
4157 if ((c
->argc
% 2) == 0) {
4158 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
4161 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
4162 * set nothing at all if at least one already key exists. */
4164 for (j
= 1; j
< c
->argc
; j
+= 2) {
4165 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
4171 addReply(c
, shared
.czero
);
4175 for (j
= 1; j
< c
->argc
; j
+= 2) {
4178 c
->argv
[j
+1] = tryObjectEncoding(c
->argv
[j
+1]);
4179 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
4180 if (retval
== DICT_ERR
) {
4181 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
4182 incrRefCount(c
->argv
[j
+1]);
4184 incrRefCount(c
->argv
[j
]);
4185 incrRefCount(c
->argv
[j
+1]);
4187 removeExpire(c
->db
,c
->argv
[j
]);
4189 server
.dirty
+= (c
->argc
-1)/2;
4190 addReply(c
, nx
? shared
.cone
: shared
.ok
);
4193 static void msetCommand(redisClient
*c
) {
4194 msetGenericCommand(c
,0);
4197 static void msetnxCommand(redisClient
*c
) {
4198 msetGenericCommand(c
,1);
4201 static void incrDecrCommand(redisClient
*c
, long long incr
) {
4206 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4208 if (getLongLongFromObjectOrReply(c
, o
, &value
, NULL
) != REDIS_OK
) return;
4211 o
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
4212 o
= tryObjectEncoding(o
);
4213 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
4214 if (retval
== DICT_ERR
) {
4215 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4216 removeExpire(c
->db
,c
->argv
[1]);
4218 incrRefCount(c
->argv
[1]);
4221 addReply(c
,shared
.colon
);
4223 addReply(c
,shared
.crlf
);
4226 static void incrCommand(redisClient
*c
) {
4227 incrDecrCommand(c
,1);
4230 static void decrCommand(redisClient
*c
) {
4231 incrDecrCommand(c
,-1);
4234 static void incrbyCommand(redisClient
*c
) {
4237 if (getLongLongFromObjectOrReply(c
, c
->argv
[2], &incr
, NULL
) != REDIS_OK
) return;
4238 incrDecrCommand(c
,incr
);
4241 static void decrbyCommand(redisClient
*c
) {
4244 if (getLongLongFromObjectOrReply(c
, c
->argv
[2], &incr
, NULL
) != REDIS_OK
) return;
4245 incrDecrCommand(c
,-incr
);
4248 static void appendCommand(redisClient
*c
) {
4253 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4255 /* Create the key */
4256 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4257 incrRefCount(c
->argv
[1]);
4258 incrRefCount(c
->argv
[2]);
4259 totlen
= stringObjectLen(c
->argv
[2]);
4263 de
= dictFind(c
->db
->dict
,c
->argv
[1]);
4266 o
= dictGetEntryVal(de
);
4267 if (o
->type
!= REDIS_STRING
) {
4268 addReply(c
,shared
.wrongtypeerr
);
4271 /* If the object is specially encoded or shared we have to make
4273 if (o
->refcount
!= 1 || o
->encoding
!= REDIS_ENCODING_RAW
) {
4274 robj
*decoded
= getDecodedObject(o
);
4276 o
= createStringObject(decoded
->ptr
, sdslen(decoded
->ptr
));
4277 decrRefCount(decoded
);
4278 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4281 if (c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
) {
4282 o
->ptr
= sdscatlen(o
->ptr
,
4283 c
->argv
[2]->ptr
, sdslen(c
->argv
[2]->ptr
));
4285 o
->ptr
= sdscatprintf(o
->ptr
, "%ld",
4286 (unsigned long) c
->argv
[2]->ptr
);
4288 totlen
= sdslen(o
->ptr
);
4291 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen
));
4294 static void substrCommand(redisClient
*c
) {
4296 long start
= atoi(c
->argv
[2]->ptr
);
4297 long end
= atoi(c
->argv
[3]->ptr
);
4298 size_t rangelen
, strlen
;
4301 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4302 checkType(c
,o
,REDIS_STRING
)) return;
4304 o
= getDecodedObject(o
);
4305 strlen
= sdslen(o
->ptr
);
4307 /* convert negative indexes */
4308 if (start
< 0) start
= strlen
+start
;
4309 if (end
< 0) end
= strlen
+end
;
4310 if (start
< 0) start
= 0;
4311 if (end
< 0) end
= 0;
4313 /* indexes sanity checks */
4314 if (start
> end
|| (size_t)start
>= strlen
) {
4315 /* Out of range start or start > end result in null reply */
4316 addReply(c
,shared
.nullbulk
);
4320 if ((size_t)end
>= strlen
) end
= strlen
-1;
4321 rangelen
= (end
-start
)+1;
4323 /* Return the result */
4324 addReplySds(c
,sdscatprintf(sdsempty(),"$%zu\r\n",rangelen
));
4325 range
= sdsnewlen((char*)o
->ptr
+start
,rangelen
);
4326 addReplySds(c
,range
);
4327 addReply(c
,shared
.crlf
);
4331 /* ========================= Type agnostic commands ========================= */
4333 static void delCommand(redisClient
*c
) {
4336 for (j
= 1; j
< c
->argc
; j
++) {
4337 if (deleteKey(c
->db
,c
->argv
[j
])) {
4342 addReplyLong(c
,deleted
);
4345 static void existsCommand(redisClient
*c
) {
4346 addReply(c
,lookupKeyRead(c
->db
,c
->argv
[1]) ? shared
.cone
: shared
.czero
);
4349 static void selectCommand(redisClient
*c
) {
4350 int id
= atoi(c
->argv
[1]->ptr
);
4352 if (selectDb(c
,id
) == REDIS_ERR
) {
4353 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
4355 addReply(c
,shared
.ok
);
4359 static void randomkeyCommand(redisClient
*c
) {
4364 de
= dictGetRandomKey(c
->db
->dict
);
4365 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
4369 addReply(c
,shared
.nullbulk
);
4373 key
= dictGetEntryKey(de
);
4374 if (server
.vm_enabled
) {
4375 key
= dupStringObject(key
);
4376 addReplyBulk(c
,key
);
4379 addReplyBulk(c
,key
);
4383 static void keysCommand(redisClient
*c
) {
4386 sds pattern
= c
->argv
[1]->ptr
;
4387 int plen
= sdslen(pattern
);
4388 unsigned long numkeys
= 0;
4389 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
4391 di
= dictGetIterator(c
->db
->dict
);
4393 decrRefCount(lenobj
);
4394 while((de
= dictNext(di
)) != NULL
) {
4395 robj
*keyobj
= dictGetEntryKey(de
);
4397 sds key
= keyobj
->ptr
;
4398 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
4399 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
4400 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
4401 addReplyBulk(c
,keyobj
);
4406 dictReleaseIterator(di
);
4407 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",numkeys
);
4410 static void dbsizeCommand(redisClient
*c
) {
4412 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
4415 static void lastsaveCommand(redisClient
*c
) {
4417 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
4420 static void typeCommand(redisClient
*c
) {
4424 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4429 case REDIS_STRING
: type
= "+string"; break;
4430 case REDIS_LIST
: type
= "+list"; break;
4431 case REDIS_SET
: type
= "+set"; break;
4432 case REDIS_ZSET
: type
= "+zset"; break;
4433 case REDIS_HASH
: type
= "+hash"; break;
4434 default: type
= "+unknown"; break;
4437 addReplySds(c
,sdsnew(type
));
4438 addReply(c
,shared
.crlf
);
4441 static void saveCommand(redisClient
*c
) {
4442 if (server
.bgsavechildpid
!= -1) {
4443 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
4446 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4447 addReply(c
,shared
.ok
);
4449 addReply(c
,shared
.err
);
4453 static void bgsaveCommand(redisClient
*c
) {
4454 if (server
.bgsavechildpid
!= -1) {
4455 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
4458 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
4459 char *status
= "+Background saving started\r\n";
4460 addReplySds(c
,sdsnew(status
));
4462 addReply(c
,shared
.err
);
4466 static void shutdownCommand(redisClient
*c
) {
4467 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
4468 /* Kill the saving child if there is a background saving in progress.
4469 We want to avoid race conditions, for instance our saving child may
4470 overwrite the synchronous saving did by SHUTDOWN. */
4471 if (server
.bgsavechildpid
!= -1) {
4472 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
4473 kill(server
.bgsavechildpid
,SIGKILL
);
4474 rdbRemoveTempFile(server
.bgsavechildpid
);
4476 if (server
.appendonly
) {
4477 /* Append only file: fsync() the AOF and exit */
4478 fsync(server
.appendfd
);
4479 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4482 /* Snapshotting. Perform a SYNC SAVE and exit */
4483 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4484 if (server
.daemonize
)
4485 unlink(server
.pidfile
);
4486 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
4487 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
4490 /* Ooops.. error saving! The best we can do is to continue
4491 * operating. Note that if there was a background saving process,
4492 * in the next cron() Redis will be notified that the background
4493 * saving aborted, handling special stuff like slaves pending for
4494 * synchronization... */
4495 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
4497 sdsnew("-ERR can't quit, problems saving the DB\r\n"));
4502 static void renameGenericCommand(redisClient
*c
, int nx
) {
4505 /* To use the same key as src and dst is probably an error */
4506 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
4507 addReply(c
,shared
.sameobjecterr
);
4511 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
)
4515 deleteIfVolatile(c
->db
,c
->argv
[2]);
4516 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
4519 addReply(c
,shared
.czero
);
4522 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
4524 incrRefCount(c
->argv
[2]);
4526 deleteKey(c
->db
,c
->argv
[1]);
4528 addReply(c
,nx
? shared
.cone
: shared
.ok
);
4531 static void renameCommand(redisClient
*c
) {
4532 renameGenericCommand(c
,0);
4535 static void renamenxCommand(redisClient
*c
) {
4536 renameGenericCommand(c
,1);
4539 static void moveCommand(redisClient
*c
) {
4544 /* Obtain source and target DB pointers */
4547 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
4548 addReply(c
,shared
.outofrangeerr
);
4552 selectDb(c
,srcid
); /* Back to the source DB */
4554 /* If the user is moving using as target the same
4555 * DB as the source DB it is probably an error. */
4557 addReply(c
,shared
.sameobjecterr
);
4561 /* Check if the element exists and get a reference */
4562 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4564 addReply(c
,shared
.czero
);
4568 /* Try to add the element to the target DB */
4569 deleteIfVolatile(dst
,c
->argv
[1]);
4570 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
4571 addReply(c
,shared
.czero
);
4574 incrRefCount(c
->argv
[1]);
4577 /* OK! key moved, free the entry in the source DB */
4578 deleteKey(src
,c
->argv
[1]);
4580 addReply(c
,shared
.cone
);
4583 /* =================================== Lists ================================ */
4584 static void pushGenericCommand(redisClient
*c
, int where
) {
4588 lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4590 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4591 addReply(c
,shared
.cone
);
4594 lobj
= createListObject();
4596 if (where
== REDIS_HEAD
) {
4597 listAddNodeHead(list
,c
->argv
[2]);
4599 listAddNodeTail(list
,c
->argv
[2]);
4601 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
4602 incrRefCount(c
->argv
[1]);
4603 incrRefCount(c
->argv
[2]);
4605 if (lobj
->type
!= REDIS_LIST
) {
4606 addReply(c
,shared
.wrongtypeerr
);
4609 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4610 addReply(c
,shared
.cone
);
4614 if (where
== REDIS_HEAD
) {
4615 listAddNodeHead(list
,c
->argv
[2]);
4617 listAddNodeTail(list
,c
->argv
[2]);
4619 incrRefCount(c
->argv
[2]);
4622 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",listLength(list
)));
4625 static void lpushCommand(redisClient
*c
) {
4626 pushGenericCommand(c
,REDIS_HEAD
);
4629 static void rpushCommand(redisClient
*c
) {
4630 pushGenericCommand(c
,REDIS_TAIL
);
4633 static void llenCommand(redisClient
*c
) {
4637 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4638 checkType(c
,o
,REDIS_LIST
)) return;
4641 addReplyUlong(c
,listLength(l
));
4644 static void lindexCommand(redisClient
*c
) {
4646 int index
= atoi(c
->argv
[2]->ptr
);
4650 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4651 checkType(c
,o
,REDIS_LIST
)) return;
4654 ln
= listIndex(list
, index
);
4656 addReply(c
,shared
.nullbulk
);
4658 robj
*ele
= listNodeValue(ln
);
4659 addReplyBulk(c
,ele
);
4663 static void lsetCommand(redisClient
*c
) {
4665 int index
= atoi(c
->argv
[2]->ptr
);
4669 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
||
4670 checkType(c
,o
,REDIS_LIST
)) return;
4673 ln
= listIndex(list
, index
);
4675 addReply(c
,shared
.outofrangeerr
);
4677 robj
*ele
= listNodeValue(ln
);
4680 listNodeValue(ln
) = c
->argv
[3];
4681 incrRefCount(c
->argv
[3]);
4682 addReply(c
,shared
.ok
);
4687 static void popGenericCommand(redisClient
*c
, int where
) {
4692 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4693 checkType(c
,o
,REDIS_LIST
)) return;
4696 if (where
== REDIS_HEAD
)
4697 ln
= listFirst(list
);
4699 ln
= listLast(list
);
4702 addReply(c
,shared
.nullbulk
);
4704 robj
*ele
= listNodeValue(ln
);
4705 addReplyBulk(c
,ele
);
4706 listDelNode(list
,ln
);
4707 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4712 static void lpopCommand(redisClient
*c
) {
4713 popGenericCommand(c
,REDIS_HEAD
);
4716 static void rpopCommand(redisClient
*c
) {
4717 popGenericCommand(c
,REDIS_TAIL
);
4720 static void lrangeCommand(redisClient
*c
) {
4722 int start
= atoi(c
->argv
[2]->ptr
);
4723 int end
= atoi(c
->argv
[3]->ptr
);
4730 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
4731 || checkType(c
,o
,REDIS_LIST
)) return;
4733 llen
= listLength(list
);
4735 /* convert negative indexes */
4736 if (start
< 0) start
= llen
+start
;
4737 if (end
< 0) end
= llen
+end
;
4738 if (start
< 0) start
= 0;
4739 if (end
< 0) end
= 0;
4741 /* indexes sanity checks */
4742 if (start
> end
|| start
>= llen
) {
4743 /* Out of range start or start > end result in empty list */
4744 addReply(c
,shared
.emptymultibulk
);
4747 if (end
>= llen
) end
= llen
-1;
4748 rangelen
= (end
-start
)+1;
4750 /* Return the result in form of a multi-bulk reply */
4751 ln
= listIndex(list
, start
);
4752 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
4753 for (j
= 0; j
< rangelen
; j
++) {
4754 ele
= listNodeValue(ln
);
4755 addReplyBulk(c
,ele
);
4760 static void ltrimCommand(redisClient
*c
) {
4762 int start
= atoi(c
->argv
[2]->ptr
);
4763 int end
= atoi(c
->argv
[3]->ptr
);
4765 int j
, ltrim
, rtrim
;
4769 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.ok
)) == NULL
||
4770 checkType(c
,o
,REDIS_LIST
)) return;
4772 llen
= listLength(list
);
4774 /* convert negative indexes */
4775 if (start
< 0) start
= llen
+start
;
4776 if (end
< 0) end
= llen
+end
;
4777 if (start
< 0) start
= 0;
4778 if (end
< 0) end
= 0;
4780 /* indexes sanity checks */
4781 if (start
> end
|| start
>= llen
) {
4782 /* Out of range start or start > end result in empty list */
4786 if (end
>= llen
) end
= llen
-1;
4791 /* Remove list elements to perform the trim */
4792 for (j
= 0; j
< ltrim
; j
++) {
4793 ln
= listFirst(list
);
4794 listDelNode(list
,ln
);
4796 for (j
= 0; j
< rtrim
; j
++) {
4797 ln
= listLast(list
);
4798 listDelNode(list
,ln
);
4800 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4802 addReply(c
,shared
.ok
);
4805 static void lremCommand(redisClient
*c
) {
4808 listNode
*ln
, *next
;
4809 int toremove
= atoi(c
->argv
[2]->ptr
);
4813 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4814 checkType(c
,o
,REDIS_LIST
)) return;
4818 toremove
= -toremove
;
4821 ln
= fromtail
? list
->tail
: list
->head
;
4823 robj
*ele
= listNodeValue(ln
);
4825 next
= fromtail
? ln
->prev
: ln
->next
;
4826 if (compareStringObjects(ele
,c
->argv
[3]) == 0) {
4827 listDelNode(list
,ln
);
4830 if (toremove
&& removed
== toremove
) break;
4834 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4835 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
4838 /* This is the semantic of this command:
4839 * RPOPLPUSH srclist dstlist:
4840 * IF LLEN(srclist) > 0
4841 * element = RPOP srclist
4842 * LPUSH dstlist element
4849 * The idea is to be able to get an element from a list in a reliable way
4850 * since the element is not just returned but pushed against another list
4851 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4853 static void rpoplpushcommand(redisClient
*c
) {
4858 if ((sobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4859 checkType(c
,sobj
,REDIS_LIST
)) return;
4860 srclist
= sobj
->ptr
;
4861 ln
= listLast(srclist
);
4864 addReply(c
,shared
.nullbulk
);
4866 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4867 robj
*ele
= listNodeValue(ln
);
4870 if (dobj
&& dobj
->type
!= REDIS_LIST
) {
4871 addReply(c
,shared
.wrongtypeerr
);
4875 /* Add the element to the target list (unless it's directly
4876 * passed to some BLPOP-ing client */
4877 if (!handleClientsWaitingListPush(c
,c
->argv
[2],ele
)) {
4879 /* Create the list if the key does not exist */
4880 dobj
= createListObject();
4881 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
4882 incrRefCount(c
->argv
[2]);
4884 dstlist
= dobj
->ptr
;
4885 listAddNodeHead(dstlist
,ele
);
4889 /* Send the element to the client as reply as well */
4890 addReplyBulk(c
,ele
);
4892 /* Finally remove the element from the source list */
4893 listDelNode(srclist
,ln
);
4894 if (listLength(srclist
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4899 /* ==================================== Sets ================================ */
4901 static void saddCommand(redisClient
*c
) {
4904 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4906 set
= createSetObject();
4907 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
4908 incrRefCount(c
->argv
[1]);
4910 if (set
->type
!= REDIS_SET
) {
4911 addReply(c
,shared
.wrongtypeerr
);
4915 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
4916 incrRefCount(c
->argv
[2]);
4918 addReply(c
,shared
.cone
);
4920 addReply(c
,shared
.czero
);
4924 static void sremCommand(redisClient
*c
) {
4927 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4928 checkType(c
,set
,REDIS_SET
)) return;
4930 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
4932 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4933 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4934 addReply(c
,shared
.cone
);
4936 addReply(c
,shared
.czero
);
4940 static void smoveCommand(redisClient
*c
) {
4941 robj
*srcset
, *dstset
;
4943 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4944 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4946 /* If the source key does not exist return 0, if it's of the wrong type
4948 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
4949 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
4952 /* Error if the destination key is not a set as well */
4953 if (dstset
&& dstset
->type
!= REDIS_SET
) {
4954 addReply(c
,shared
.wrongtypeerr
);
4957 /* Remove the element from the source set */
4958 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
4959 /* Key not found in the src set! return zero */
4960 addReply(c
,shared
.czero
);
4963 if (dictSize((dict
*)srcset
->ptr
) == 0 && srcset
!= dstset
)
4964 deleteKey(c
->db
,c
->argv
[1]);
4966 /* Add the element to the destination set */
4968 dstset
= createSetObject();
4969 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
4970 incrRefCount(c
->argv
[2]);
4972 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
4973 incrRefCount(c
->argv
[3]);
4974 addReply(c
,shared
.cone
);
4977 static void sismemberCommand(redisClient
*c
) {
4980 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4981 checkType(c
,set
,REDIS_SET
)) return;
4983 if (dictFind(set
->ptr
,c
->argv
[2]))
4984 addReply(c
,shared
.cone
);
4986 addReply(c
,shared
.czero
);
4989 static void scardCommand(redisClient
*c
) {
4993 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4994 checkType(c
,o
,REDIS_SET
)) return;
4997 addReplyUlong(c
,dictSize(s
));
5000 static void spopCommand(redisClient
*c
) {
5004 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5005 checkType(c
,set
,REDIS_SET
)) return;
5007 de
= dictGetRandomKey(set
->ptr
);
5009 addReply(c
,shared
.nullbulk
);
5011 robj
*ele
= dictGetEntryKey(de
);
5013 addReplyBulk(c
,ele
);
5014 dictDelete(set
->ptr
,ele
);
5015 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
5016 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5021 static void srandmemberCommand(redisClient
*c
) {
5025 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5026 checkType(c
,set
,REDIS_SET
)) return;
5028 de
= dictGetRandomKey(set
->ptr
);
5030 addReply(c
,shared
.nullbulk
);
5032 robj
*ele
= dictGetEntryKey(de
);
5034 addReplyBulk(c
,ele
);
5038 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
5039 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
5041 return dictSize(*d1
)-dictSize(*d2
);
5044 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
5045 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
5048 robj
*lenobj
= NULL
, *dstset
= NULL
;
5049 unsigned long j
, cardinality
= 0;
5051 for (j
= 0; j
< setsnum
; j
++) {
5055 lookupKeyWrite(c
->db
,setskeys
[j
]) :
5056 lookupKeyRead(c
->db
,setskeys
[j
]);
5060 if (deleteKey(c
->db
,dstkey
))
5062 addReply(c
,shared
.czero
);
5064 addReply(c
,shared
.emptymultibulk
);
5068 if (setobj
->type
!= REDIS_SET
) {
5070 addReply(c
,shared
.wrongtypeerr
);
5073 dv
[j
] = setobj
->ptr
;
5075 /* Sort sets from the smallest to largest, this will improve our
5076 * algorithm's performace */
5077 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
5079 /* The first thing we should output is the total number of elements...
5080 * since this is a multi-bulk write, but at this stage we don't know
5081 * the intersection set size, so we use a trick, append an empty object
5082 * to the output list and save the pointer to later modify it with the
5085 lenobj
= createObject(REDIS_STRING
,NULL
);
5087 decrRefCount(lenobj
);
5089 /* If we have a target key where to store the resulting set
5090 * create this key with an empty set inside */
5091 dstset
= createSetObject();
5094 /* Iterate all the elements of the first (smallest) set, and test
5095 * the element against all the other sets, if at least one set does
5096 * not include the element it is discarded */
5097 di
= dictGetIterator(dv
[0]);
5099 while((de
= dictNext(di
)) != NULL
) {
5102 for (j
= 1; j
< setsnum
; j
++)
5103 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
5105 continue; /* at least one set does not contain the member */
5106 ele
= dictGetEntryKey(de
);
5108 addReplyBulk(c
,ele
);
5111 dictAdd(dstset
->ptr
,ele
,NULL
);
5115 dictReleaseIterator(di
);
5118 /* Store the resulting set into the target, if the intersection
5119 * is not an empty set. */
5120 deleteKey(c
->db
,dstkey
);
5121 if (dictSize((dict
*)dstset
->ptr
) > 0) {
5122 dictAdd(c
->db
->dict
,dstkey
,dstset
);
5123 incrRefCount(dstkey
);
5124 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
5126 decrRefCount(dstset
);
5127 addReply(c
,shared
.czero
);
5131 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
5136 static void sinterCommand(redisClient
*c
) {
5137 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
5140 static void sinterstoreCommand(redisClient
*c
) {
5141 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
5144 #define REDIS_OP_UNION 0
5145 #define REDIS_OP_DIFF 1
5146 #define REDIS_OP_INTER 2
5148 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
5149 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
5152 robj
*dstset
= NULL
;
5153 int j
, cardinality
= 0;
5155 for (j
= 0; j
< setsnum
; j
++) {
5159 lookupKeyWrite(c
->db
,setskeys
[j
]) :
5160 lookupKeyRead(c
->db
,setskeys
[j
]);
5165 if (setobj
->type
!= REDIS_SET
) {
5167 addReply(c
,shared
.wrongtypeerr
);
5170 dv
[j
] = setobj
->ptr
;
5173 /* We need a temp set object to store our union. If the dstkey
5174 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
5175 * this set object will be the resulting object to set into the target key*/
5176 dstset
= createSetObject();
5178 /* Iterate all the elements of all the sets, add every element a single
5179 * time to the result set */
5180 for (j
= 0; j
< setsnum
; j
++) {
5181 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
5182 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
5184 di
= dictGetIterator(dv
[j
]);
5186 while((de
= dictNext(di
)) != NULL
) {
5189 /* dictAdd will not add the same element multiple times */
5190 ele
= dictGetEntryKey(de
);
5191 if (op
== REDIS_OP_UNION
|| j
== 0) {
5192 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
5196 } else if (op
== REDIS_OP_DIFF
) {
5197 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
5202 dictReleaseIterator(di
);
5204 /* result set is empty? Exit asap. */
5205 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break;
5208 /* Output the content of the resulting set, if not in STORE mode */
5210 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
5211 di
= dictGetIterator(dstset
->ptr
);
5212 while((de
= dictNext(di
)) != NULL
) {
5215 ele
= dictGetEntryKey(de
);
5216 addReplyBulk(c
,ele
);
5218 dictReleaseIterator(di
);
5219 decrRefCount(dstset
);
5221 /* If we have a target key where to store the resulting set
5222 * create this key with the result set inside */
5223 deleteKey(c
->db
,dstkey
);
5224 if (dictSize((dict
*)dstset
->ptr
) > 0) {
5225 dictAdd(c
->db
->dict
,dstkey
,dstset
);
5226 incrRefCount(dstkey
);
5227 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
5229 decrRefCount(dstset
);
5230 addReply(c
,shared
.czero
);
5237 static void sunionCommand(redisClient
*c
) {
5238 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
5241 static void sunionstoreCommand(redisClient
*c
) {
5242 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
5245 static void sdiffCommand(redisClient
*c
) {
5246 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
5249 static void sdiffstoreCommand(redisClient
*c
) {
5250 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
5253 /* ==================================== ZSets =============================== */
5255 /* ZSETs are ordered sets using two data structures to hold the same elements
5256 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
5259 * The elements are added to an hash table mapping Redis objects to scores.
5260 * At the same time the elements are added to a skip list mapping scores
5261 * to Redis objects (so objects are sorted by scores in this "view"). */
5263 /* This skiplist implementation is almost a C translation of the original
5264 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
5265 * Alternative to Balanced Trees", modified in three ways:
5266 * a) this implementation allows for repeated values.
5267 * b) the comparison is not just by key (our 'score') but by satellite data.
5268 * c) there is a back pointer, so it's a doubly linked list with the back
5269 * pointers being only at "level 1". This allows to traverse the list
5270 * from tail to head, useful for ZREVRANGE. */
5272 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
5273 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
5275 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
5277 zn
->span
= zmalloc(sizeof(unsigned int) * (level
- 1));
5283 static zskiplist
*zslCreate(void) {
5287 zsl
= zmalloc(sizeof(*zsl
));
5290 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
5291 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++) {
5292 zsl
->header
->forward
[j
] = NULL
;
5294 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
5295 if (j
< ZSKIPLIST_MAXLEVEL
-1)
5296 zsl
->header
->span
[j
] = 0;
5298 zsl
->header
->backward
= NULL
;
5303 static void zslFreeNode(zskiplistNode
*node
) {
5304 decrRefCount(node
->obj
);
5305 zfree(node
->forward
);
5310 static void zslFree(zskiplist
*zsl
) {
5311 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
5313 zfree(zsl
->header
->forward
);
5314 zfree(zsl
->header
->span
);
5317 next
= node
->forward
[0];
5324 static int zslRandomLevel(void) {
5326 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
5328 return (level
<ZSKIPLIST_MAXLEVEL
) ? level
: ZSKIPLIST_MAXLEVEL
;
5331 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
5332 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5333 unsigned int rank
[ZSKIPLIST_MAXLEVEL
];
5337 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5338 /* store rank that is crossed to reach the insert position */
5339 rank
[i
] = i
== (zsl
->level
-1) ? 0 : rank
[i
+1];
5341 while (x
->forward
[i
] &&
5342 (x
->forward
[i
]->score
< score
||
5343 (x
->forward
[i
]->score
== score
&&
5344 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0))) {
5345 rank
[i
] += i
> 0 ? x
->span
[i
-1] : 1;
5350 /* we assume the key is not already inside, since we allow duplicated
5351 * scores, and the re-insertion of score and redis object should never
5352 * happpen since the caller of zslInsert() should test in the hash table
5353 * if the element is already inside or not. */
5354 level
= zslRandomLevel();
5355 if (level
> zsl
->level
) {
5356 for (i
= zsl
->level
; i
< level
; i
++) {
5358 update
[i
] = zsl
->header
;
5359 update
[i
]->span
[i
-1] = zsl
->length
;
5363 x
= zslCreateNode(level
,score
,obj
);
5364 for (i
= 0; i
< level
; i
++) {
5365 x
->forward
[i
] = update
[i
]->forward
[i
];
5366 update
[i
]->forward
[i
] = x
;
5368 /* update span covered by update[i] as x is inserted here */
5370 x
->span
[i
-1] = update
[i
]->span
[i
-1] - (rank
[0] - rank
[i
]);
5371 update
[i
]->span
[i
-1] = (rank
[0] - rank
[i
]) + 1;
5375 /* increment span for untouched levels */
5376 for (i
= level
; i
< zsl
->level
; i
++) {
5377 update
[i
]->span
[i
-1]++;
5380 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
5382 x
->forward
[0]->backward
= x
;
5388 /* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank */
5389 void zslDeleteNode(zskiplist
*zsl
, zskiplistNode
*x
, zskiplistNode
**update
) {
5391 for (i
= 0; i
< zsl
->level
; i
++) {
5392 if (update
[i
]->forward
[i
] == x
) {
5394 update
[i
]->span
[i
-1] += x
->span
[i
-1] - 1;
5396 update
[i
]->forward
[i
] = x
->forward
[i
];
5398 /* invariant: i > 0, because update[0]->forward[0]
5399 * is always equal to x */
5400 update
[i
]->span
[i
-1] -= 1;
5403 if (x
->forward
[0]) {
5404 x
->forward
[0]->backward
= x
->backward
;
5406 zsl
->tail
= x
->backward
;
5408 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
5413 /* Delete an element with matching score/object from the skiplist. */
5414 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
5415 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5419 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5420 while (x
->forward
[i
] &&
5421 (x
->forward
[i
]->score
< score
||
5422 (x
->forward
[i
]->score
== score
&&
5423 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
5427 /* We may have multiple elements with the same score, what we need
5428 * is to find the element with both the right score and object. */
5430 if (x
&& score
== x
->score
&& compareStringObjects(x
->obj
,obj
) == 0) {
5431 zslDeleteNode(zsl
, x
, update
);
5435 return 0; /* not found */
5437 return 0; /* not found */
5440 /* Delete all the elements with score between min and max from the skiplist.
5441 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
5442 * Note that this function takes the reference to the hash table view of the
5443 * sorted set, in order to remove the elements from the hash table too. */
5444 static unsigned long zslDeleteRangeByScore(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
5445 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5446 unsigned long removed
= 0;
5450 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5451 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
5455 /* We may have multiple elements with the same score, what we need
5456 * is to find the element with both the right score and object. */
5458 while (x
&& x
->score
<= max
) {
5459 zskiplistNode
*next
= x
->forward
[0];
5460 zslDeleteNode(zsl
, x
, update
);
5461 dictDelete(dict
,x
->obj
);
5466 return removed
; /* not found */
5469 /* Delete all the elements with rank between start and end from the skiplist.
5470 * Start and end are inclusive. Note that start and end need to be 1-based */
5471 static unsigned long zslDeleteRangeByRank(zskiplist
*zsl
, unsigned int start
, unsigned int end
, dict
*dict
) {
5472 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5473 unsigned long traversed
= 0, removed
= 0;
5477 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5478 while (x
->forward
[i
] && (traversed
+ (i
> 0 ? x
->span
[i
-1] : 1)) < start
) {
5479 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5487 while (x
&& traversed
<= end
) {
5488 zskiplistNode
*next
= x
->forward
[0];
5489 zslDeleteNode(zsl
, x
, update
);
5490 dictDelete(dict
,x
->obj
);
5499 /* Find the first node having a score equal or greater than the specified one.
5500 * Returns NULL if there is no match. */
5501 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
5506 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5507 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
5510 /* We may have multiple elements with the same score, what we need
5511 * is to find the element with both the right score and object. */
5512 return x
->forward
[0];
5515 /* Find the rank for an element by both score and key.
5516 * Returns 0 when the element cannot be found, rank otherwise.
5517 * Note that the rank is 1-based due to the span of zsl->header to the
5519 static unsigned long zslGetRank(zskiplist
*zsl
, double score
, robj
*o
) {
5521 unsigned long rank
= 0;
5525 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5526 while (x
->forward
[i
] &&
5527 (x
->forward
[i
]->score
< score
||
5528 (x
->forward
[i
]->score
== score
&&
5529 compareStringObjects(x
->forward
[i
]->obj
,o
) <= 0))) {
5530 rank
+= i
> 0 ? x
->span
[i
-1] : 1;
5534 /* x might be equal to zsl->header, so test if obj is non-NULL */
5535 if (x
->obj
&& compareStringObjects(x
->obj
,o
) == 0) {
5542 /* Finds an element by its rank. The rank argument needs to be 1-based. */
5543 zskiplistNode
* zslGetElementByRank(zskiplist
*zsl
, unsigned long rank
) {
5545 unsigned long traversed
= 0;
5549 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5550 while (x
->forward
[i
] && (traversed
+ (i
>0 ? x
->span
[i
-1] : 1)) <= rank
)
5552 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5555 if (traversed
== rank
) {
5562 /* The actual Z-commands implementations */
5564 /* This generic command implements both ZADD and ZINCRBY.
5565 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
5566 * the increment if the operation is a ZINCRBY (doincrement == 1). */
5567 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
5572 zsetobj
= lookupKeyWrite(c
->db
,key
);
5573 if (zsetobj
== NULL
) {
5574 zsetobj
= createZsetObject();
5575 dictAdd(c
->db
->dict
,key
,zsetobj
);
5578 if (zsetobj
->type
!= REDIS_ZSET
) {
5579 addReply(c
,shared
.wrongtypeerr
);
5585 /* Ok now since we implement both ZADD and ZINCRBY here the code
5586 * needs to handle the two different conditions. It's all about setting
5587 * '*score', that is, the new score to set, to the right value. */
5588 score
= zmalloc(sizeof(double));
5592 /* Read the old score. If the element was not present starts from 0 */
5593 de
= dictFind(zs
->dict
,ele
);
5595 double *oldscore
= dictGetEntryVal(de
);
5596 *score
= *oldscore
+ scoreval
;
5604 /* What follows is a simple remove and re-insert operation that is common
5605 * to both ZADD and ZINCRBY... */
5606 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
5607 /* case 1: New element */
5608 incrRefCount(ele
); /* added to hash */
5609 zslInsert(zs
->zsl
,*score
,ele
);
5610 incrRefCount(ele
); /* added to skiplist */
5613 addReplyDouble(c
,*score
);
5615 addReply(c
,shared
.cone
);
5620 /* case 2: Score update operation */
5621 de
= dictFind(zs
->dict
,ele
);
5622 redisAssert(de
!= NULL
);
5623 oldscore
= dictGetEntryVal(de
);
5624 if (*score
!= *oldscore
) {
5627 /* Remove and insert the element in the skip list with new score */
5628 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
5629 redisAssert(deleted
!= 0);
5630 zslInsert(zs
->zsl
,*score
,ele
);
5632 /* Update the score in the hash table */
5633 dictReplace(zs
->dict
,ele
,score
);
5639 addReplyDouble(c
,*score
);
5641 addReply(c
,shared
.czero
);
5645 static void zaddCommand(redisClient
*c
) {
5648 if (getDoubleFromObjectOrReply(c
, c
->argv
[2], &scoreval
, NULL
) != REDIS_OK
) return;
5649 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
5652 static void zincrbyCommand(redisClient
*c
) {
5655 if (getDoubleFromObjectOrReply(c
, c
->argv
[2], &scoreval
, NULL
) != REDIS_OK
) return;
5656 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
5659 static void zremCommand(redisClient
*c
) {
5666 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5667 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5670 de
= dictFind(zs
->dict
,c
->argv
[2]);
5672 addReply(c
,shared
.czero
);
5675 /* Delete from the skiplist */
5676 oldscore
= dictGetEntryVal(de
);
5677 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
5678 redisAssert(deleted
!= 0);
5680 /* Delete from the hash table */
5681 dictDelete(zs
->dict
,c
->argv
[2]);
5682 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5683 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5685 addReply(c
,shared
.cone
);
5688 static void zremrangebyscoreCommand(redisClient
*c
) {
5695 if ((getDoubleFromObjectOrReply(c
, c
->argv
[2], &min
, NULL
) != REDIS_OK
) ||
5696 (getDoubleFromObjectOrReply(c
, c
->argv
[3], &max
, NULL
) != REDIS_OK
)) return;
5698 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5699 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5702 deleted
= zslDeleteRangeByScore(zs
->zsl
,min
,max
,zs
->dict
);
5703 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5704 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5705 server
.dirty
+= deleted
;
5706 addReplyLong(c
,deleted
);
5709 static void zremrangebyrankCommand(redisClient
*c
) {
5717 if ((getLongFromObjectOrReply(c
, c
->argv
[2], &start
, NULL
) != REDIS_OK
) ||
5718 (getLongFromObjectOrReply(c
, c
->argv
[3], &end
, NULL
) != REDIS_OK
)) return;
5720 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5721 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5723 llen
= zs
->zsl
->length
;
5725 /* convert negative indexes */
5726 if (start
< 0) start
= llen
+start
;
5727 if (end
< 0) end
= llen
+end
;
5728 if (start
< 0) start
= 0;
5729 if (end
< 0) end
= 0;
5731 /* indexes sanity checks */
5732 if (start
> end
|| start
>= llen
) {
5733 addReply(c
,shared
.czero
);
5736 if (end
>= llen
) end
= llen
-1;
5738 /* increment start and end because zsl*Rank functions
5739 * use 1-based rank */
5740 deleted
= zslDeleteRangeByRank(zs
->zsl
,start
+1,end
+1,zs
->dict
);
5741 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5742 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5743 server
.dirty
+= deleted
;
5744 addReplyLong(c
, deleted
);
5752 static int qsortCompareZsetopsrcByCardinality(const void *s1
, const void *s2
) {
5753 zsetopsrc
*d1
= (void*) s1
, *d2
= (void*) s2
;
5754 unsigned long size1
, size2
;
5755 size1
= d1
->dict
? dictSize(d1
->dict
) : 0;
5756 size2
= d2
->dict
? dictSize(d2
->dict
) : 0;
5757 return size1
- size2
;
5760 #define REDIS_AGGR_SUM 1
5761 #define REDIS_AGGR_MIN 2
5762 #define REDIS_AGGR_MAX 3
5764 inline static void zunionInterAggregate(double *target
, double val
, int aggregate
) {
5765 if (aggregate
== REDIS_AGGR_SUM
) {
5766 *target
= *target
+ val
;
5767 } else if (aggregate
== REDIS_AGGR_MIN
) {
5768 *target
= val
< *target
? val
: *target
;
5769 } else if (aggregate
== REDIS_AGGR_MAX
) {
5770 *target
= val
> *target
? val
: *target
;
5773 redisPanic("Unknown ZUNION/INTER aggregate type");
5777 static void zunionInterGenericCommand(redisClient
*c
, robj
*dstkey
, int op
) {
5779 int aggregate
= REDIS_AGGR_SUM
;
5786 /* expect zsetnum input keys to be given */
5787 zsetnum
= atoi(c
->argv
[2]->ptr
);
5789 addReplySds(c
,sdsnew("-ERR at least 1 input key is needed for ZUNION/ZINTER\r\n"));
5793 /* test if the expected number of keys would overflow */
5794 if (3+zsetnum
> c
->argc
) {
5795 addReply(c
,shared
.syntaxerr
);
5799 /* read keys to be used for input */
5800 src
= zmalloc(sizeof(zsetopsrc
) * zsetnum
);
5801 for (i
= 0, j
= 3; i
< zsetnum
; i
++, j
++) {
5802 robj
*zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
5806 if (zsetobj
->type
!= REDIS_ZSET
) {
5808 addReply(c
,shared
.wrongtypeerr
);
5811 src
[i
].dict
= ((zset
*)zsetobj
->ptr
)->dict
;
5814 /* default all weights to 1 */
5815 src
[i
].weight
= 1.0;
5818 /* parse optional extra arguments */
5820 int remaining
= c
->argc
- j
;
5823 if (remaining
>= (zsetnum
+ 1) && !strcasecmp(c
->argv
[j
]->ptr
,"weights")) {
5825 for (i
= 0; i
< zsetnum
; i
++, j
++, remaining
--) {
5826 if (getDoubleFromObjectOrReply(c
, c
->argv
[j
], &src
[i
].weight
, NULL
) != REDIS_OK
)
5829 } else if (remaining
>= 2 && !strcasecmp(c
->argv
[j
]->ptr
,"aggregate")) {
5831 if (!strcasecmp(c
->argv
[j
]->ptr
,"sum")) {
5832 aggregate
= REDIS_AGGR_SUM
;
5833 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"min")) {
5834 aggregate
= REDIS_AGGR_MIN
;
5835 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"max")) {
5836 aggregate
= REDIS_AGGR_MAX
;
5839 addReply(c
,shared
.syntaxerr
);
5845 addReply(c
,shared
.syntaxerr
);
5851 /* sort sets from the smallest to largest, this will improve our
5852 * algorithm's performance */
5853 qsort(src
,zsetnum
,sizeof(zsetopsrc
), qsortCompareZsetopsrcByCardinality
);
5855 dstobj
= createZsetObject();
5856 dstzset
= dstobj
->ptr
;
5858 if (op
== REDIS_OP_INTER
) {
5859 /* skip going over all entries if the smallest zset is NULL or empty */
5860 if (src
[0].dict
&& dictSize(src
[0].dict
) > 0) {
5861 /* precondition: as src[0].dict is non-empty and the zsets are ordered
5862 * from small to large, all src[i > 0].dict are non-empty too */
5863 di
= dictGetIterator(src
[0].dict
);
5864 while((de
= dictNext(di
)) != NULL
) {
5865 double *score
= zmalloc(sizeof(double)), value
;
5866 *score
= src
[0].weight
* (*(double*)dictGetEntryVal(de
));
5868 for (j
= 1; j
< zsetnum
; j
++) {
5869 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5871 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5872 zunionInterAggregate(score
, value
, aggregate
);
5878 /* skip entry when not present in every source dict */
5882 robj
*o
= dictGetEntryKey(de
);
5883 dictAdd(dstzset
->dict
,o
,score
);
5884 incrRefCount(o
); /* added to dictionary */
5885 zslInsert(dstzset
->zsl
,*score
,o
);
5886 incrRefCount(o
); /* added to skiplist */
5889 dictReleaseIterator(di
);
5891 } else if (op
== REDIS_OP_UNION
) {
5892 for (i
= 0; i
< zsetnum
; i
++) {
5893 if (!src
[i
].dict
) continue;
5895 di
= dictGetIterator(src
[i
].dict
);
5896 while((de
= dictNext(di
)) != NULL
) {
5897 /* skip key when already processed */
5898 if (dictFind(dstzset
->dict
,dictGetEntryKey(de
)) != NULL
) continue;
5900 double *score
= zmalloc(sizeof(double)), value
;
5901 *score
= src
[i
].weight
* (*(double*)dictGetEntryVal(de
));
5903 /* because the zsets are sorted by size, its only possible
5904 * for sets at larger indices to hold this entry */
5905 for (j
= (i
+1); j
< zsetnum
; j
++) {
5906 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5908 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5909 zunionInterAggregate(score
, value
, aggregate
);
5913 robj
*o
= dictGetEntryKey(de
);
5914 dictAdd(dstzset
->dict
,o
,score
);
5915 incrRefCount(o
); /* added to dictionary */
5916 zslInsert(dstzset
->zsl
,*score
,o
);
5917 incrRefCount(o
); /* added to skiplist */
5919 dictReleaseIterator(di
);
5922 /* unknown operator */
5923 redisAssert(op
== REDIS_OP_INTER
|| op
== REDIS_OP_UNION
);
5926 deleteKey(c
->db
,dstkey
);
5927 if (dstzset
->zsl
->length
) {
5928 dictAdd(c
->db
->dict
,dstkey
,dstobj
);
5929 incrRefCount(dstkey
);
5930 addReplyLong(c
, dstzset
->zsl
->length
);
5933 decrRefCount(dstobj
);
5934 addReply(c
, shared
.czero
);
5939 static void zunionCommand(redisClient
*c
) {
5940 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_UNION
);
5943 static void zinterCommand(redisClient
*c
) {
5944 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_INTER
);
5947 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
5959 if ((getLongFromObjectOrReply(c
, c
->argv
[2], &start
, NULL
) != REDIS_OK
) ||
5960 (getLongFromObjectOrReply(c
, c
->argv
[3], &end
, NULL
) != REDIS_OK
)) return;
5962 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
5964 } else if (c
->argc
>= 5) {
5965 addReply(c
,shared
.syntaxerr
);
5969 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
5970 || checkType(c
,o
,REDIS_ZSET
)) return;
5975 /* convert negative indexes */
5976 if (start
< 0) start
= llen
+start
;
5977 if (end
< 0) end
= llen
+end
;
5978 if (start
< 0) start
= 0;
5979 if (end
< 0) end
= 0;
5981 /* indexes sanity checks */
5982 if (start
> end
|| start
>= llen
) {
5983 /* Out of range start or start > end result in empty list */
5984 addReply(c
,shared
.emptymultibulk
);
5987 if (end
>= llen
) end
= llen
-1;
5988 rangelen
= (end
-start
)+1;
5990 /* check if starting point is trivial, before searching
5991 * the element in log(N) time */
5993 ln
= start
== 0 ? zsl
->tail
: zslGetElementByRank(zsl
, llen
-start
);
5996 zsl
->header
->forward
[0] : zslGetElementByRank(zsl
, start
+1);
5999 /* Return the result in form of a multi-bulk reply */
6000 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
6001 withscores
? (rangelen
*2) : rangelen
));
6002 for (j
= 0; j
< rangelen
; j
++) {
6004 addReplyBulk(c
,ele
);
6006 addReplyDouble(c
,ln
->score
);
6007 ln
= reverse
? ln
->backward
: ln
->forward
[0];
6011 static void zrangeCommand(redisClient
*c
) {
6012 zrangeGenericCommand(c
,0);
6015 static void zrevrangeCommand(redisClient
*c
) {
6016 zrangeGenericCommand(c
,1);
6019 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
6020 * If justcount is non-zero, just the count is returned. */
6021 static void genericZrangebyscoreCommand(redisClient
*c
, int justcount
) {
6024 int minex
= 0, maxex
= 0; /* are min or max exclusive? */
6025 int offset
= 0, limit
= -1;
6029 /* Parse the min-max interval. If one of the values is prefixed
6030 * by the "(" character, it's considered "open". For instance
6031 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
6032 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
6033 if (((char*)c
->argv
[2]->ptr
)[0] == '(') {
6034 min
= strtod((char*)c
->argv
[2]->ptr
+1,NULL
);
6037 min
= strtod(c
->argv
[2]->ptr
,NULL
);
6039 if (((char*)c
->argv
[3]->ptr
)[0] == '(') {
6040 max
= strtod((char*)c
->argv
[3]->ptr
+1,NULL
);
6043 max
= strtod(c
->argv
[3]->ptr
,NULL
);
6046 /* Parse "WITHSCORES": note that if the command was called with
6047 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
6048 * enter the following paths to parse WITHSCORES and LIMIT. */
6049 if (c
->argc
== 5 || c
->argc
== 8) {
6050 if (strcasecmp(c
->argv
[c
->argc
-1]->ptr
,"withscores") == 0)
6055 if (c
->argc
!= (4 + withscores
) && c
->argc
!= (7 + withscores
))
6059 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
6064 if (c
->argc
== (7 + withscores
) && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
6065 addReply(c
,shared
.syntaxerr
);
6067 } else if (c
->argc
== (7 + withscores
)) {
6068 offset
= atoi(c
->argv
[5]->ptr
);
6069 limit
= atoi(c
->argv
[6]->ptr
);
6070 if (offset
< 0) offset
= 0;
6073 /* Ok, lookup the key and get the range */
6074 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
6076 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
6078 if (o
->type
!= REDIS_ZSET
) {
6079 addReply(c
,shared
.wrongtypeerr
);
6081 zset
*zsetobj
= o
->ptr
;
6082 zskiplist
*zsl
= zsetobj
->zsl
;
6084 robj
*ele
, *lenobj
= NULL
;
6085 unsigned long rangelen
= 0;
6087 /* Get the first node with the score >= min, or with
6088 * score > min if 'minex' is true. */
6089 ln
= zslFirstWithScore(zsl
,min
);
6090 while (minex
&& ln
&& ln
->score
== min
) ln
= ln
->forward
[0];
6093 /* No element matching the speciifed interval */
6094 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
6098 /* We don't know in advance how many matching elements there
6099 * are in the list, so we push this object that will represent
6100 * the multi-bulk length in the output buffer, and will "fix"
6103 lenobj
= createObject(REDIS_STRING
,NULL
);
6105 decrRefCount(lenobj
);
6108 while(ln
&& (maxex
? (ln
->score
< max
) : (ln
->score
<= max
))) {
6111 ln
= ln
->forward
[0];
6114 if (limit
== 0) break;
6117 addReplyBulk(c
,ele
);
6119 addReplyDouble(c
,ln
->score
);
6121 ln
= ln
->forward
[0];
6123 if (limit
> 0) limit
--;
6126 addReplyLong(c
,(long)rangelen
);
6128 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",
6129 withscores
? (rangelen
*2) : rangelen
);
6135 static void zrangebyscoreCommand(redisClient
*c
) {
6136 genericZrangebyscoreCommand(c
,0);
6139 static void zcountCommand(redisClient
*c
) {
6140 genericZrangebyscoreCommand(c
,1);
6143 static void zcardCommand(redisClient
*c
) {
6147 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6148 checkType(c
,o
,REDIS_ZSET
)) return;
6151 addReplyUlong(c
,zs
->zsl
->length
);
6154 static void zscoreCommand(redisClient
*c
) {
6159 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6160 checkType(c
,o
,REDIS_ZSET
)) return;
6163 de
= dictFind(zs
->dict
,c
->argv
[2]);
6165 addReply(c
,shared
.nullbulk
);
6167 double *score
= dictGetEntryVal(de
);
6169 addReplyDouble(c
,*score
);
6173 static void zrankGenericCommand(redisClient
*c
, int reverse
) {
6181 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6182 checkType(c
,o
,REDIS_ZSET
)) return;
6186 de
= dictFind(zs
->dict
,c
->argv
[2]);
6188 addReply(c
,shared
.nullbulk
);
6192 score
= dictGetEntryVal(de
);
6193 rank
= zslGetRank(zsl
, *score
, c
->argv
[2]);
6196 addReplyLong(c
, zsl
->length
- rank
);
6198 addReplyLong(c
, rank
-1);
6201 addReply(c
,shared
.nullbulk
);
6205 static void zrankCommand(redisClient
*c
) {
6206 zrankGenericCommand(c
, 0);
6209 static void zrevrankCommand(redisClient
*c
) {
6210 zrankGenericCommand(c
, 1);
6213 /* ========================= Hashes utility functions ======================= */
6214 #define REDIS_HASH_KEY 1
6215 #define REDIS_HASH_VALUE 2
6217 /* Check the length of a number of objects to see if we need to convert a
6218 * zipmap to a real hash. Note that we only check string encoded objects
6219 * as their string length can be queried in constant time. */
6220 static void hashTryConversion(robj
*subject
, robj
**argv
, int start
, int end
) {
6222 if (subject
->encoding
!= REDIS_ENCODING_ZIPMAP
) return;
6224 for (i
= start
; i
<= end
; i
++) {
6225 if (argv
[i
]->encoding
== REDIS_ENCODING_RAW
&&
6226 sdslen(argv
[i
]->ptr
) > server
.hash_max_zipmap_value
)
6228 convertToRealHash(subject
);
6234 /* Encode given objects in-place when the hash uses a dict. */
6235 static void hashTryObjectEncoding(robj
*subject
, robj
**o1
, robj
**o2
) {
6236 if (subject
->encoding
== REDIS_ENCODING_HT
) {
6237 if (o1
) *o1
= tryObjectEncoding(*o1
);
6238 if (o2
) *o2
= tryObjectEncoding(*o2
);
6242 /* Get the value from a hash identified by key. Returns either a string
6243 * object or NULL if the value cannot be found. The refcount of the object
6244 * is always increased by 1 when the value was found. */
6245 static robj
*hashGet(robj
*o
, robj
*key
) {
6247 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6250 key
= getDecodedObject(key
);
6251 if (zipmapGet(o
->ptr
,key
->ptr
,sdslen(key
->ptr
),&v
,&vlen
)) {
6252 value
= createStringObject((char*)v
,vlen
);
6256 dictEntry
*de
= dictFind(o
->ptr
,key
);
6258 value
= dictGetEntryVal(de
);
6259 incrRefCount(value
);
6265 /* Test if the key exists in the given hash. Returns 1 if the key
6266 * exists and 0 when it doesn't. */
6267 static int hashExists(robj
*o
, robj
*key
) {
6268 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6269 key
= getDecodedObject(key
);
6270 if (zipmapExists(o
->ptr
,key
->ptr
,sdslen(key
->ptr
))) {
6276 if (dictFind(o
->ptr
,key
) != NULL
) {
6283 /* Add an element, discard the old if the key already exists.
6284 * Return 0 on insert and 1 on update. */
6285 static int hashSet(robj
*o
, robj
*key
, robj
*value
) {
6287 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6288 key
= getDecodedObject(key
);
6289 value
= getDecodedObject(value
);
6290 o
->ptr
= zipmapSet(o
->ptr
,
6291 key
->ptr
,sdslen(key
->ptr
),
6292 value
->ptr
,sdslen(value
->ptr
), &update
);
6294 decrRefCount(value
);
6296 /* Check if the zipmap needs to be upgraded to a real hash table */
6297 if (zipmapLen(o
->ptr
) > server
.hash_max_zipmap_entries
)
6298 convertToRealHash(o
);
6300 if (dictReplace(o
->ptr
,key
,value
)) {
6307 incrRefCount(value
);
6312 /* Delete an element from a hash.
6313 * Return 1 on deleted and 0 on not found. */
6314 static int hashDelete(robj
*o
, robj
*key
) {
6316 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6317 key
= getDecodedObject(key
);
6318 o
->ptr
= zipmapDel(o
->ptr
,key
->ptr
,sdslen(key
->ptr
), &deleted
);
6321 deleted
= dictDelete((dict
*)o
->ptr
,key
) == DICT_OK
;
6322 /* Always check if the dictionary needs a resize after a delete. */
6323 if (deleted
&& htNeedsResize(o
->ptr
)) dictResize(o
->ptr
);
6328 /* Return the number of elements in a hash. */
6329 static unsigned long hashLength(robj
*o
) {
6330 return (o
->encoding
== REDIS_ENCODING_ZIPMAP
) ?
6331 zipmapLen((unsigned char*)o
->ptr
) : dictSize((dict
*)o
->ptr
);
6334 /* Structure to hold hash iteration abstration. Note that iteration over
6335 * hashes involves both fields and values. Because it is possible that
6336 * not both are required, store pointers in the iterator to avoid
6337 * unnecessary memory allocation for fields/values. */
6341 unsigned char *zk
, *zv
;
6342 unsigned int zklen
, zvlen
;
6348 static hashIterator
*hashInitIterator(robj
*subject
) {
6349 hashIterator
*hi
= zmalloc(sizeof(hashIterator
));
6350 hi
->encoding
= subject
->encoding
;
6351 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6352 hi
->zi
= zipmapRewind(subject
->ptr
);
6353 } else if (hi
->encoding
== REDIS_ENCODING_HT
) {
6354 hi
->di
= dictGetIterator(subject
->ptr
);
6361 static void hashReleaseIterator(hashIterator
*hi
) {
6362 if (hi
->encoding
== REDIS_ENCODING_HT
) {
6363 dictReleaseIterator(hi
->di
);
6368 /* Move to the next entry in the hash. Return REDIS_OK when the next entry
6369 * could be found and REDIS_ERR when the iterator reaches the end. */
6370 static int hashNext(hashIterator
*hi
) {
6371 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6372 if ((hi
->zi
= zipmapNext(hi
->zi
, &hi
->zk
, &hi
->zklen
,
6373 &hi
->zv
, &hi
->zvlen
)) == NULL
) return REDIS_ERR
;
6375 if ((hi
->de
= dictNext(hi
->di
)) == NULL
) return REDIS_ERR
;
6380 /* Get key or value object at current iteration position.
6381 * This increases the refcount of the field object by 1. */
6382 static robj
*hashCurrent(hashIterator
*hi
, int what
) {
6384 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6385 if (what
& REDIS_HASH_KEY
) {
6386 o
= createStringObject((char*)hi
->zk
,hi
->zklen
);
6388 o
= createStringObject((char*)hi
->zv
,hi
->zvlen
);
6391 if (what
& REDIS_HASH_KEY
) {
6392 o
= dictGetEntryKey(hi
->de
);
6394 o
= dictGetEntryVal(hi
->de
);
6401 static robj
*hashLookupWriteOrCreate(redisClient
*c
, robj
*key
) {
6402 robj
*o
= lookupKeyWrite(c
->db
,key
);
6404 o
= createHashObject();
6405 dictAdd(c
->db
->dict
,key
,o
);
6408 if (o
->type
!= REDIS_HASH
) {
6409 addReply(c
,shared
.wrongtypeerr
);
6416 /* ============================= Hash commands ============================== */
6417 static void hsetCommand(redisClient
*c
) {
6421 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6422 hashTryConversion(o
,c
->argv
,2,3);
6423 hashTryObjectEncoding(o
,&c
->argv
[2], &c
->argv
[3]);
6424 update
= hashSet(o
,c
->argv
[2],c
->argv
[3]);
6425 addReply(c
, update
? shared
.czero
: shared
.cone
);
6429 static void hsetnxCommand(redisClient
*c
) {
6431 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6432 hashTryConversion(o
,c
->argv
,2,3);
6434 if (hashExists(o
, c
->argv
[2])) {
6435 addReply(c
, shared
.czero
);
6437 hashTryObjectEncoding(o
,&c
->argv
[2], &c
->argv
[3]);
6438 hashSet(o
,c
->argv
[2],c
->argv
[3]);
6439 addReply(c
, shared
.cone
);
6444 static void hmsetCommand(redisClient
*c
) {
6448 if ((c
->argc
% 2) == 1) {
6449 addReplySds(c
,sdsnew("-ERR wrong number of arguments for HMSET\r\n"));
6453 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6454 hashTryConversion(o
,c
->argv
,2,c
->argc
-1);
6455 for (i
= 2; i
< c
->argc
; i
+= 2) {
6456 hashTryObjectEncoding(o
,&c
->argv
[i
], &c
->argv
[i
+1]);
6457 hashSet(o
,c
->argv
[i
],c
->argv
[i
+1]);
6459 addReply(c
, shared
.ok
);
6463 static void hincrbyCommand(redisClient
*c
) {
6464 long long value
, incr
;
6465 robj
*o
, *current
, *new;
6467 if (getLongLongFromObjectOrReply(c
,c
->argv
[3],&incr
,NULL
) != REDIS_OK
) return;
6468 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6469 if ((current
= hashGet(o
,c
->argv
[2])) != NULL
) {
6470 if (getLongLongFromObjectOrReply(c
,current
,&value
,
6471 "hash value is not an integer") != REDIS_OK
) {
6472 decrRefCount(current
);
6475 decrRefCount(current
);
6481 new = createStringObjectFromLongLong(value
);
6482 hashTryObjectEncoding(o
,&c
->argv
[2],NULL
);
6483 hashSet(o
,c
->argv
[2],new);
6485 addReplyLongLong(c
,value
);
6489 static void hgetCommand(redisClient
*c
) {
6491 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6492 checkType(c
,o
,REDIS_HASH
)) return;
6494 if ((value
= hashGet(o
,c
->argv
[2])) != NULL
) {
6495 addReplyBulk(c
,value
);
6496 decrRefCount(value
);
6498 addReply(c
,shared
.nullbulk
);
6502 static void hmgetCommand(redisClient
*c
) {
6505 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
6506 if (o
!= NULL
&& o
->type
!= REDIS_HASH
) {
6507 addReply(c
,shared
.wrongtypeerr
);
6510 /* Note the check for o != NULL happens inside the loop. This is
6511 * done because objects that cannot be found are considered to be
6512 * an empty hash. The reply should then be a series of NULLs. */
6513 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-2));
6514 for (i
= 2; i
< c
->argc
; i
++) {
6515 if (o
!= NULL
&& (value
= hashGet(o
,c
->argv
[i
])) != NULL
) {
6516 addReplyBulk(c
,value
);
6517 decrRefCount(value
);
6519 addReply(c
,shared
.nullbulk
);
6524 static void hdelCommand(redisClient
*c
) {
6526 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6527 checkType(c
,o
,REDIS_HASH
)) return;
6529 if (hashDelete(o
,c
->argv
[2])) {
6530 if (hashLength(o
) == 0) deleteKey(c
->db
,c
->argv
[1]);
6531 addReply(c
,shared
.cone
);
6534 addReply(c
,shared
.czero
);
6538 static void hlenCommand(redisClient
*c
) {
6540 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6541 checkType(c
,o
,REDIS_HASH
)) return;
6543 addReplyUlong(c
,hashLength(o
));
6546 static void genericHgetallCommand(redisClient
*c
, int flags
) {
6547 robj
*o
, *lenobj
, *obj
;
6548 unsigned long count
= 0;
6551 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
6552 || checkType(c
,o
,REDIS_HASH
)) return;
6554 lenobj
= createObject(REDIS_STRING
,NULL
);
6556 decrRefCount(lenobj
);
6558 hi
= hashInitIterator(o
);
6559 while (hashNext(hi
) != REDIS_ERR
) {
6560 if (flags
& REDIS_HASH_KEY
) {
6561 obj
= hashCurrent(hi
,REDIS_HASH_KEY
);
6562 addReplyBulk(c
,obj
);
6566 if (flags
& REDIS_HASH_VALUE
) {
6567 obj
= hashCurrent(hi
,REDIS_HASH_VALUE
);
6568 addReplyBulk(c
,obj
);
6573 hashReleaseIterator(hi
);
6575 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",count
);
6578 static void hkeysCommand(redisClient
*c
) {
6579 genericHgetallCommand(c
,REDIS_HASH_KEY
);
6582 static void hvalsCommand(redisClient
*c
) {
6583 genericHgetallCommand(c
,REDIS_HASH_VALUE
);
6586 static void hgetallCommand(redisClient
*c
) {
6587 genericHgetallCommand(c
,REDIS_HASH_KEY
|REDIS_HASH_VALUE
);
6590 static void hexistsCommand(redisClient
*c
) {
6592 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6593 checkType(c
,o
,REDIS_HASH
)) return;
6595 addReply(c
, hashExists(o
,c
->argv
[2]) ? shared
.cone
: shared
.czero
);
6598 static void convertToRealHash(robj
*o
) {
6599 unsigned char *key
, *val
, *p
, *zm
= o
->ptr
;
6600 unsigned int klen
, vlen
;
6601 dict
*dict
= dictCreate(&hashDictType
,NULL
);
6603 assert(o
->type
== REDIS_HASH
&& o
->encoding
!= REDIS_ENCODING_HT
);
6604 p
= zipmapRewind(zm
);
6605 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
6606 robj
*keyobj
, *valobj
;
6608 keyobj
= createStringObject((char*)key
,klen
);
6609 valobj
= createStringObject((char*)val
,vlen
);
6610 keyobj
= tryObjectEncoding(keyobj
);
6611 valobj
= tryObjectEncoding(valobj
);
6612 dictAdd(dict
,keyobj
,valobj
);
6614 o
->encoding
= REDIS_ENCODING_HT
;
6619 /* ========================= Non type-specific commands ==================== */
6621 static void flushdbCommand(redisClient
*c
) {
6622 server
.dirty
+= dictSize(c
->db
->dict
);
6623 dictEmpty(c
->db
->dict
);
6624 dictEmpty(c
->db
->expires
);
6625 addReply(c
,shared
.ok
);
6628 static void flushallCommand(redisClient
*c
) {
6629 server
.dirty
+= emptyDb();
6630 addReply(c
,shared
.ok
);
6631 if (server
.bgsavechildpid
!= -1) {
6632 kill(server
.bgsavechildpid
,SIGKILL
);
6633 rdbRemoveTempFile(server
.bgsavechildpid
);
6635 rdbSave(server
.dbfilename
);
6639 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
6640 redisSortOperation
*so
= zmalloc(sizeof(*so
));
6642 so
->pattern
= pattern
;
6646 /* Return the value associated to the key with a name obtained
6647 * substituting the first occurence of '*' in 'pattern' with 'subst'.
6648 * The returned object will always have its refcount increased by 1
6649 * when it is non-NULL. */
6650 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
6653 robj keyobj
, fieldobj
, *o
;
6654 int prefixlen
, sublen
, postfixlen
, fieldlen
;
6655 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
6659 char buf
[REDIS_SORTKEY_MAX
+1];
6660 } keyname
, fieldname
;
6662 /* If the pattern is "#" return the substitution object itself in order
6663 * to implement the "SORT ... GET #" feature. */
6664 spat
= pattern
->ptr
;
6665 if (spat
[0] == '#' && spat
[1] == '\0') {
6666 incrRefCount(subst
);
6670 /* The substitution object may be specially encoded. If so we create
6671 * a decoded object on the fly. Otherwise getDecodedObject will just
6672 * increment the ref count, that we'll decrement later. */
6673 subst
= getDecodedObject(subst
);
6676 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
6677 p
= strchr(spat
,'*');
6679 decrRefCount(subst
);
6683 /* Find out if we're dealing with a hash dereference. */
6684 if ((f
= strstr(p
+1, "->")) != NULL
) {
6685 fieldlen
= sdslen(spat
)-(f
-spat
);
6686 /* this also copies \0 character */
6687 memcpy(fieldname
.buf
,f
+2,fieldlen
-1);
6688 fieldname
.len
= fieldlen
-2;
6694 sublen
= sdslen(ssub
);
6695 postfixlen
= sdslen(spat
)-(prefixlen
+1)-fieldlen
;
6696 memcpy(keyname
.buf
,spat
,prefixlen
);
6697 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
6698 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
6699 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
6700 keyname
.len
= prefixlen
+sublen
+postfixlen
;
6701 decrRefCount(subst
);
6703 /* Lookup substituted key */
6704 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2));
6705 o
= lookupKeyRead(db
,&keyobj
);
6706 if (o
== NULL
) return NULL
;
6709 if (o
->type
!= REDIS_HASH
|| fieldname
.len
< 1) return NULL
;
6711 /* Retrieve value from hash by the field name. This operation
6712 * already increases the refcount of the returned object. */
6713 initStaticStringObject(fieldobj
,((char*)&fieldname
)+(sizeof(long)*2));
6714 o
= hashGet(o
, &fieldobj
);
6716 if (o
->type
!= REDIS_STRING
) return NULL
;
6718 /* Every object that this function returns needs to have its refcount
6719 * increased. sortCommand decreases it again. */
6726 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
6727 * the additional parameter is not standard but a BSD-specific we have to
6728 * pass sorting parameters via the global 'server' structure */
6729 static int sortCompare(const void *s1
, const void *s2
) {
6730 const redisSortObject
*so1
= s1
, *so2
= s2
;
6733 if (!server
.sort_alpha
) {
6734 /* Numeric sorting. Here it's trivial as we precomputed scores */
6735 if (so1
->u
.score
> so2
->u
.score
) {
6737 } else if (so1
->u
.score
< so2
->u
.score
) {
6743 /* Alphanumeric sorting */
6744 if (server
.sort_bypattern
) {
6745 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
6746 /* At least one compare object is NULL */
6747 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
6749 else if (so1
->u
.cmpobj
== NULL
)
6754 /* We have both the objects, use strcoll */
6755 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
6758 /* Compare elements directly. */
6759 cmp
= compareStringObjects(so1
->obj
,so2
->obj
);
6762 return server
.sort_desc
? -cmp
: cmp
;
6765 /* The SORT command is the most complex command in Redis. Warning: this code
6766 * is optimized for speed and a bit less for readability */
6767 static void sortCommand(redisClient
*c
) {
6770 int desc
= 0, alpha
= 0;
6771 int limit_start
= 0, limit_count
= -1, start
, end
;
6772 int j
, dontsort
= 0, vectorlen
;
6773 int getop
= 0; /* GET operation counter */
6774 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
6775 redisSortObject
*vector
; /* Resulting vector to sort */
6777 /* Lookup the key to sort. It must be of the right types */
6778 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
6779 if (sortval
== NULL
) {
6780 addReply(c
,shared
.emptymultibulk
);
6783 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
6784 sortval
->type
!= REDIS_ZSET
)
6786 addReply(c
,shared
.wrongtypeerr
);
6790 /* Create a list of operations to perform for every sorted element.
6791 * Operations can be GET/DEL/INCR/DECR */
6792 operations
= listCreate();
6793 listSetFreeMethod(operations
,zfree
);
6796 /* Now we need to protect sortval incrementing its count, in the future
6797 * SORT may have options able to overwrite/delete keys during the sorting
6798 * and the sorted key itself may get destroied */
6799 incrRefCount(sortval
);
6801 /* The SORT command has an SQL-alike syntax, parse it */
6802 while(j
< c
->argc
) {
6803 int leftargs
= c
->argc
-j
-1;
6804 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
6806 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
6808 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
6810 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
6811 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
6812 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
6814 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
6815 storekey
= c
->argv
[j
+1];
6817 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
6818 sortby
= c
->argv
[j
+1];
6819 /* If the BY pattern does not contain '*', i.e. it is constant,
6820 * we don't need to sort nor to lookup the weight keys. */
6821 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
6823 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
6824 listAddNodeTail(operations
,createSortOperation(
6825 REDIS_SORT_GET
,c
->argv
[j
+1]));
6829 decrRefCount(sortval
);
6830 listRelease(operations
);
6831 addReply(c
,shared
.syntaxerr
);
6837 /* Load the sorting vector with all the objects to sort */
6838 switch(sortval
->type
) {
6839 case REDIS_LIST
: vectorlen
= listLength((list
*)sortval
->ptr
); break;
6840 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
6841 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
6842 default: vectorlen
= 0; redisPanic("Bad SORT type"); /* Avoid GCC warning */
6844 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
6847 if (sortval
->type
== REDIS_LIST
) {
6848 list
*list
= sortval
->ptr
;
6852 listRewind(list
,&li
);
6853 while((ln
= listNext(&li
))) {
6854 robj
*ele
= ln
->value
;
6855 vector
[j
].obj
= ele
;
6856 vector
[j
].u
.score
= 0;
6857 vector
[j
].u
.cmpobj
= NULL
;
6865 if (sortval
->type
== REDIS_SET
) {
6868 zset
*zs
= sortval
->ptr
;
6872 di
= dictGetIterator(set
);
6873 while((setele
= dictNext(di
)) != NULL
) {
6874 vector
[j
].obj
= dictGetEntryKey(setele
);
6875 vector
[j
].u
.score
= 0;
6876 vector
[j
].u
.cmpobj
= NULL
;
6879 dictReleaseIterator(di
);
6881 redisAssert(j
== vectorlen
);
6883 /* Now it's time to load the right scores in the sorting vector */
6884 if (dontsort
== 0) {
6885 for (j
= 0; j
< vectorlen
; j
++) {
6888 /* lookup value to sort by */
6889 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
6890 if (!byval
) continue;
6892 /* use object itself to sort by */
6893 byval
= vector
[j
].obj
;
6897 if (sortby
) vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
6899 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
6900 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
6901 } else if (byval
->encoding
== REDIS_ENCODING_INT
) {
6902 /* Don't need to decode the object if it's
6903 * integer-encoded (the only encoding supported) so
6904 * far. We can just cast it */
6905 vector
[j
].u
.score
= (long)byval
->ptr
;
6907 redisAssert(1 != 1);
6911 /* when the object was retrieved using lookupKeyByPattern,
6912 * its refcount needs to be decreased. */
6914 decrRefCount(byval
);
6919 /* We are ready to sort the vector... perform a bit of sanity check
6920 * on the LIMIT option too. We'll use a partial version of quicksort. */
6921 start
= (limit_start
< 0) ? 0 : limit_start
;
6922 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
6923 if (start
>= vectorlen
) {
6924 start
= vectorlen
-1;
6927 if (end
>= vectorlen
) end
= vectorlen
-1;
6929 if (dontsort
== 0) {
6930 server
.sort_desc
= desc
;
6931 server
.sort_alpha
= alpha
;
6932 server
.sort_bypattern
= sortby
? 1 : 0;
6933 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
6934 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
6936 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
6939 /* Send command output to the output buffer, performing the specified
6940 * GET/DEL/INCR/DECR operations if any. */
6941 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
6942 if (storekey
== NULL
) {
6943 /* STORE option not specified, sent the sorting result to client */
6944 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
6945 for (j
= start
; j
<= end
; j
++) {
6949 if (!getop
) addReplyBulk(c
,vector
[j
].obj
);
6950 listRewind(operations
,&li
);
6951 while((ln
= listNext(&li
))) {
6952 redisSortOperation
*sop
= ln
->value
;
6953 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
6956 if (sop
->type
== REDIS_SORT_GET
) {
6958 addReply(c
,shared
.nullbulk
);
6960 addReplyBulk(c
,val
);
6964 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
6969 robj
*listObject
= createListObject();
6970 list
*listPtr
= (list
*) listObject
->ptr
;
6972 /* STORE option specified, set the sorting result as a List object */
6973 for (j
= start
; j
<= end
; j
++) {
6978 listAddNodeTail(listPtr
,vector
[j
].obj
);
6979 incrRefCount(vector
[j
].obj
);
6981 listRewind(operations
,&li
);
6982 while((ln
= listNext(&li
))) {
6983 redisSortOperation
*sop
= ln
->value
;
6984 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
6987 if (sop
->type
== REDIS_SORT_GET
) {
6989 listAddNodeTail(listPtr
,createStringObject("",0));
6991 /* We should do a incrRefCount on val because it is
6992 * added to the list, but also a decrRefCount because
6993 * it is returned by lookupKeyByPattern. This results
6994 * in doing nothing at all. */
6995 listAddNodeTail(listPtr
,val
);
6998 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
7002 if (dictReplace(c
->db
->dict
,storekey
,listObject
)) {
7003 incrRefCount(storekey
);
7005 /* Note: we add 1 because the DB is dirty anyway since even if the
7006 * SORT result is empty a new key is set and maybe the old content
7008 server
.dirty
+= 1+outputlen
;
7009 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
7013 decrRefCount(sortval
);
7014 listRelease(operations
);
7015 for (j
= 0; j
< vectorlen
; j
++) {
7016 if (alpha
&& vector
[j
].u
.cmpobj
)
7017 decrRefCount(vector
[j
].u
.cmpobj
);
7022 /* Convert an amount of bytes into a human readable string in the form
7023 * of 100B, 2G, 100M, 4K, and so forth. */
7024 static void bytesToHuman(char *s
, unsigned long long n
) {
7029 sprintf(s
,"%lluB",n
);
7031 } else if (n
< (1024*1024)) {
7032 d
= (double)n
/(1024);
7033 sprintf(s
,"%.2fK",d
);
7034 } else if (n
< (1024LL*1024*1024)) {
7035 d
= (double)n
/(1024*1024);
7036 sprintf(s
,"%.2fM",d
);
7037 } else if (n
< (1024LL*1024*1024*1024)) {
7038 d
= (double)n
/(1024LL*1024*1024);
7039 sprintf(s
,"%.2fG",d
);
7043 /* Create the string returned by the INFO command. This is decoupled
7044 * by the INFO command itself as we need to report the same information
7045 * on memory corruption problems. */
7046 static sds
genRedisInfoString(void) {
7048 time_t uptime
= time(NULL
)-server
.stat_starttime
;
7052 bytesToHuman(hmem
,zmalloc_used_memory());
7053 info
= sdscatprintf(sdsempty(),
7054 "redis_version:%s\r\n"
7056 "multiplexing_api:%s\r\n"
7057 "process_id:%ld\r\n"
7058 "uptime_in_seconds:%ld\r\n"
7059 "uptime_in_days:%ld\r\n"
7060 "connected_clients:%d\r\n"
7061 "connected_slaves:%d\r\n"
7062 "blocked_clients:%d\r\n"
7063 "used_memory:%zu\r\n"
7064 "used_memory_human:%s\r\n"
7065 "changes_since_last_save:%lld\r\n"
7066 "bgsave_in_progress:%d\r\n"
7067 "last_save_time:%ld\r\n"
7068 "bgrewriteaof_in_progress:%d\r\n"
7069 "total_connections_received:%lld\r\n"
7070 "total_commands_processed:%lld\r\n"
7071 "expired_keys:%lld\r\n"
7072 "hash_max_zipmap_entries:%ld\r\n"
7073 "hash_max_zipmap_value:%ld\r\n"
7074 "pubsub_channels:%ld\r\n"
7075 "pubsub_patterns:%u\r\n"
7079 (sizeof(long) == 8) ? "64" : "32",
7084 listLength(server
.clients
)-listLength(server
.slaves
),
7085 listLength(server
.slaves
),
7086 server
.blpop_blocked_clients
,
7087 zmalloc_used_memory(),
7090 server
.bgsavechildpid
!= -1,
7092 server
.bgrewritechildpid
!= -1,
7093 server
.stat_numconnections
,
7094 server
.stat_numcommands
,
7095 server
.stat_expiredkeys
,
7096 server
.hash_max_zipmap_entries
,
7097 server
.hash_max_zipmap_value
,
7098 dictSize(server
.pubsub_channels
),
7099 listLength(server
.pubsub_patterns
),
7100 server
.vm_enabled
!= 0,
7101 server
.masterhost
== NULL
? "master" : "slave"
7103 if (server
.masterhost
) {
7104 info
= sdscatprintf(info
,
7105 "master_host:%s\r\n"
7106 "master_port:%d\r\n"
7107 "master_link_status:%s\r\n"
7108 "master_last_io_seconds_ago:%d\r\n"
7111 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
7113 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
7116 if (server
.vm_enabled
) {
7118 info
= sdscatprintf(info
,
7119 "vm_conf_max_memory:%llu\r\n"
7120 "vm_conf_page_size:%llu\r\n"
7121 "vm_conf_pages:%llu\r\n"
7122 "vm_stats_used_pages:%llu\r\n"
7123 "vm_stats_swapped_objects:%llu\r\n"
7124 "vm_stats_swappin_count:%llu\r\n"
7125 "vm_stats_swappout_count:%llu\r\n"
7126 "vm_stats_io_newjobs_len:%lu\r\n"
7127 "vm_stats_io_processing_len:%lu\r\n"
7128 "vm_stats_io_processed_len:%lu\r\n"
7129 "vm_stats_io_active_threads:%lu\r\n"
7130 "vm_stats_blocked_clients:%lu\r\n"
7131 ,(unsigned long long) server
.vm_max_memory
,
7132 (unsigned long long) server
.vm_page_size
,
7133 (unsigned long long) server
.vm_pages
,
7134 (unsigned long long) server
.vm_stats_used_pages
,
7135 (unsigned long long) server
.vm_stats_swapped_objects
,
7136 (unsigned long long) server
.vm_stats_swapins
,
7137 (unsigned long long) server
.vm_stats_swapouts
,
7138 (unsigned long) listLength(server
.io_newjobs
),
7139 (unsigned long) listLength(server
.io_processing
),
7140 (unsigned long) listLength(server
.io_processed
),
7141 (unsigned long) server
.io_active_threads
,
7142 (unsigned long) server
.vm_blocked_clients
7146 for (j
= 0; j
< server
.dbnum
; j
++) {
7147 long long keys
, vkeys
;
7149 keys
= dictSize(server
.db
[j
].dict
);
7150 vkeys
= dictSize(server
.db
[j
].expires
);
7151 if (keys
|| vkeys
) {
7152 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
7159 static void infoCommand(redisClient
*c
) {
7160 sds info
= genRedisInfoString();
7161 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
7162 (unsigned long)sdslen(info
)));
7163 addReplySds(c
,info
);
7164 addReply(c
,shared
.crlf
);
7167 static void monitorCommand(redisClient
*c
) {
7168 /* ignore MONITOR if aleady slave or in monitor mode */
7169 if (c
->flags
& REDIS_SLAVE
) return;
7171 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
7173 listAddNodeTail(server
.monitors
,c
);
7174 addReply(c
,shared
.ok
);
7177 /* ================================= Expire ================================= */
7178 static int removeExpire(redisDb
*db
, robj
*key
) {
7179 if (dictDelete(db
->expires
,key
) == DICT_OK
) {
7186 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
7187 if (dictAdd(db
->expires
,key
,(void*)when
) == DICT_ERR
) {
7195 /* Return the expire time of the specified key, or -1 if no expire
7196 * is associated with this key (i.e. the key is non volatile) */
7197 static time_t getExpire(redisDb
*db
, robj
*key
) {
7200 /* No expire? return ASAP */
7201 if (dictSize(db
->expires
) == 0 ||
7202 (de
= dictFind(db
->expires
,key
)) == NULL
) return -1;
7204 return (time_t) dictGetEntryVal(de
);
7207 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
7211 /* No expire? return ASAP */
7212 if (dictSize(db
->expires
) == 0 ||
7213 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
7215 /* Lookup the expire */
7216 when
= (time_t) dictGetEntryVal(de
);
7217 if (time(NULL
) <= when
) return 0;
7219 /* Delete the key */
7220 dictDelete(db
->expires
,key
);
7221 server
.stat_expiredkeys
++;
7222 return dictDelete(db
->dict
,key
) == DICT_OK
;
7225 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
7228 /* No expire? return ASAP */
7229 if (dictSize(db
->expires
) == 0 ||
7230 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
7232 /* Delete the key */
7234 server
.stat_expiredkeys
++;
7235 dictDelete(db
->expires
,key
);
7236 return dictDelete(db
->dict
,key
) == DICT_OK
;
7239 static void expireGenericCommand(redisClient
*c
, robj
*key
, robj
*param
, long offset
) {
7243 if (getLongFromObjectOrReply(c
, param
, &seconds
, NULL
) != REDIS_OK
) return;
7247 de
= dictFind(c
->db
->dict
,key
);
7249 addReply(c
,shared
.czero
);
7253 if (deleteKey(c
->db
,key
)) server
.dirty
++;
7254 addReply(c
, shared
.cone
);
7257 time_t when
= time(NULL
)+seconds
;
7258 if (setExpire(c
->db
,key
,when
)) {
7259 addReply(c
,shared
.cone
);
7262 addReply(c
,shared
.czero
);
7268 static void expireCommand(redisClient
*c
) {
7269 expireGenericCommand(c
,c
->argv
[1],c
->argv
[2],0);
7272 static void expireatCommand(redisClient
*c
) {
7273 expireGenericCommand(c
,c
->argv
[1],c
->argv
[2],time(NULL
));
7276 static void ttlCommand(redisClient
*c
) {
7280 expire
= getExpire(c
->db
,c
->argv
[1]);
7282 ttl
= (int) (expire
-time(NULL
));
7283 if (ttl
< 0) ttl
= -1;
7285 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
7288 /* ================================ MULTI/EXEC ============================== */
7290 /* Client state initialization for MULTI/EXEC */
7291 static void initClientMultiState(redisClient
*c
) {
7292 c
->mstate
.commands
= NULL
;
7293 c
->mstate
.count
= 0;
7296 /* Release all the resources associated with MULTI/EXEC state */
7297 static void freeClientMultiState(redisClient
*c
) {
7300 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7302 multiCmd
*mc
= c
->mstate
.commands
+j
;
7304 for (i
= 0; i
< mc
->argc
; i
++)
7305 decrRefCount(mc
->argv
[i
]);
7308 zfree(c
->mstate
.commands
);
7311 /* Add a new command into the MULTI commands queue */
7312 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
7316 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
7317 sizeof(multiCmd
)*(c
->mstate
.count
+1));
7318 mc
= c
->mstate
.commands
+c
->mstate
.count
;
7321 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
7322 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
7323 for (j
= 0; j
< c
->argc
; j
++)
7324 incrRefCount(mc
->argv
[j
]);
7328 static void multiCommand(redisClient
*c
) {
7329 c
->flags
|= REDIS_MULTI
;
7330 addReply(c
,shared
.ok
);
7333 static void discardCommand(redisClient
*c
) {
7334 if (!(c
->flags
& REDIS_MULTI
)) {
7335 addReplySds(c
,sdsnew("-ERR DISCARD without MULTI\r\n"));
7339 freeClientMultiState(c
);
7340 initClientMultiState(c
);
7341 c
->flags
&= (~REDIS_MULTI
);
7342 addReply(c
,shared
.ok
);
7345 /* Send a MULTI command to all the slaves and AOF file. Check the execCommand
7346 * implememntation for more information. */
7347 static void execCommandReplicateMulti(redisClient
*c
) {
7348 struct redisCommand
*cmd
;
7349 robj
*multistring
= createStringObject("MULTI",5);
7351 cmd
= lookupCommand("multi");
7352 if (server
.appendonly
)
7353 feedAppendOnlyFile(cmd
,c
->db
->id
,&multistring
,1);
7354 if (listLength(server
.slaves
))
7355 replicationFeedSlaves(server
.slaves
,c
->db
->id
,&multistring
,1);
7356 decrRefCount(multistring
);
7359 static void execCommand(redisClient
*c
) {
7364 if (!(c
->flags
& REDIS_MULTI
)) {
7365 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
7369 /* Replicate a MULTI request now that we are sure the block is executed.
7370 * This way we'll deliver the MULTI/..../EXEC block as a whole and
7371 * both the AOF and the replication link will have the same consistency
7372 * and atomicity guarantees. */
7373 execCommandReplicateMulti(c
);
7375 /* Exec all the queued commands */
7376 orig_argv
= c
->argv
;
7377 orig_argc
= c
->argc
;
7378 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
7379 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7380 c
->argc
= c
->mstate
.commands
[j
].argc
;
7381 c
->argv
= c
->mstate
.commands
[j
].argv
;
7382 call(c
,c
->mstate
.commands
[j
].cmd
);
7384 c
->argv
= orig_argv
;
7385 c
->argc
= orig_argc
;
7386 freeClientMultiState(c
);
7387 initClientMultiState(c
);
7388 c
->flags
&= (~REDIS_MULTI
);
7389 /* Make sure the EXEC command is always replicated / AOF, since we
7390 * always send the MULTI command (we can't know beforehand if the
7391 * next operations will contain at least a modification to the DB). */
7395 /* =========================== Blocking Operations ========================= */
7397 /* Currently Redis blocking operations support is limited to list POP ops,
7398 * so the current implementation is not fully generic, but it is also not
7399 * completely specific so it will not require a rewrite to support new
7400 * kind of blocking operations in the future.
7402 * Still it's important to note that list blocking operations can be already
7403 * used as a notification mechanism in order to implement other blocking
7404 * operations at application level, so there must be a very strong evidence
7405 * of usefulness and generality before new blocking operations are implemented.
7407 * This is how the current blocking POP works, we use BLPOP as example:
7408 * - If the user calls BLPOP and the key exists and contains a non empty list
7409 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
7410 * if there is not to block.
7411 * - If instead BLPOP is called and the key does not exists or the list is
7412 * empty we need to block. In order to do so we remove the notification for
7413 * new data to read in the client socket (so that we'll not serve new
7414 * requests if the blocking request is not served). Also we put the client
7415 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
7416 * blocking for this keys.
7417 * - If a PUSH operation against a key with blocked clients waiting is
7418 * performed, we serve the first in the list: basically instead to push
7419 * the new element inside the list we return it to the (first / oldest)
7420 * blocking client, unblock the client, and remove it form the list.
7422 * The above comment and the source code should be enough in order to understand
7423 * the implementation and modify / fix it later.
7426 /* Set a client in blocking mode for the specified key, with the specified
7428 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
7433 c
->blockingkeys
= zmalloc(sizeof(robj
*)*numkeys
);
7434 c
->blockingkeysnum
= numkeys
;
7435 c
->blockingto
= timeout
;
7436 for (j
= 0; j
< numkeys
; j
++) {
7437 /* Add the key in the client structure, to map clients -> keys */
7438 c
->blockingkeys
[j
] = keys
[j
];
7439 incrRefCount(keys
[j
]);
7441 /* And in the other "side", to map keys -> clients */
7442 de
= dictFind(c
->db
->blockingkeys
,keys
[j
]);
7446 /* For every key we take a list of clients blocked for it */
7448 retval
= dictAdd(c
->db
->blockingkeys
,keys
[j
],l
);
7449 incrRefCount(keys
[j
]);
7450 assert(retval
== DICT_OK
);
7452 l
= dictGetEntryVal(de
);
7454 listAddNodeTail(l
,c
);
7456 /* Mark the client as a blocked client */
7457 c
->flags
|= REDIS_BLOCKED
;
7458 server
.blpop_blocked_clients
++;
7461 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
7462 static void unblockClientWaitingData(redisClient
*c
) {
7467 assert(c
->blockingkeys
!= NULL
);
7468 /* The client may wait for multiple keys, so unblock it for every key. */
7469 for (j
= 0; j
< c
->blockingkeysnum
; j
++) {
7470 /* Remove this client from the list of clients waiting for this key. */
7471 de
= dictFind(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
7473 l
= dictGetEntryVal(de
);
7474 listDelNode(l
,listSearchKey(l
,c
));
7475 /* If the list is empty we need to remove it to avoid wasting memory */
7476 if (listLength(l
) == 0)
7477 dictDelete(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
7478 decrRefCount(c
->blockingkeys
[j
]);
7480 /* Cleanup the client structure */
7481 zfree(c
->blockingkeys
);
7482 c
->blockingkeys
= NULL
;
7483 c
->flags
&= (~REDIS_BLOCKED
);
7484 server
.blpop_blocked_clients
--;
7485 /* We want to process data if there is some command waiting
7486 * in the input buffer. Note that this is safe even if
7487 * unblockClientWaitingData() gets called from freeClient() because
7488 * freeClient() will be smart enough to call this function
7489 * *after* c->querybuf was set to NULL. */
7490 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
7493 /* This should be called from any function PUSHing into lists.
7494 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
7495 * 'ele' is the element pushed.
7497 * If the function returns 0 there was no client waiting for a list push
7500 * If the function returns 1 there was a client waiting for a list push
7501 * against this key, the element was passed to this client thus it's not
7502 * needed to actually add it to the list and the caller should return asap. */
7503 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
7504 struct dictEntry
*de
;
7505 redisClient
*receiver
;
7509 de
= dictFind(c
->db
->blockingkeys
,key
);
7510 if (de
== NULL
) return 0;
7511 l
= dictGetEntryVal(de
);
7514 receiver
= ln
->value
;
7516 addReplySds(receiver
,sdsnew("*2\r\n"));
7517 addReplyBulk(receiver
,key
);
7518 addReplyBulk(receiver
,ele
);
7519 unblockClientWaitingData(receiver
);
7523 /* Blocking RPOP/LPOP */
7524 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
7529 for (j
= 1; j
< c
->argc
-1; j
++) {
7530 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
7532 if (o
->type
!= REDIS_LIST
) {
7533 addReply(c
,shared
.wrongtypeerr
);
7536 list
*list
= o
->ptr
;
7537 if (listLength(list
) != 0) {
7538 /* If the list contains elements fall back to the usual
7539 * non-blocking POP operation */
7540 robj
*argv
[2], **orig_argv
;
7543 /* We need to alter the command arguments before to call
7544 * popGenericCommand() as the command takes a single key. */
7545 orig_argv
= c
->argv
;
7546 orig_argc
= c
->argc
;
7547 argv
[1] = c
->argv
[j
];
7551 /* Also the return value is different, we need to output
7552 * the multi bulk reply header and the key name. The
7553 * "real" command will add the last element (the value)
7554 * for us. If this souds like an hack to you it's just
7555 * because it is... */
7556 addReplySds(c
,sdsnew("*2\r\n"));
7557 addReplyBulk(c
,argv
[1]);
7558 popGenericCommand(c
,where
);
7560 /* Fix the client structure with the original stuff */
7561 c
->argv
= orig_argv
;
7562 c
->argc
= orig_argc
;
7568 /* If the list is empty or the key does not exists we must block */
7569 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
7570 if (timeout
> 0) timeout
+= time(NULL
);
7571 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
7574 static void blpopCommand(redisClient
*c
) {
7575 blockingPopGenericCommand(c
,REDIS_HEAD
);
7578 static void brpopCommand(redisClient
*c
) {
7579 blockingPopGenericCommand(c
,REDIS_TAIL
);
7582 /* =============================== Replication ============================= */
7584 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7585 ssize_t nwritten
, ret
= size
;
7586 time_t start
= time(NULL
);
7590 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
7591 nwritten
= write(fd
,ptr
,size
);
7592 if (nwritten
== -1) return -1;
7596 if ((time(NULL
)-start
) > timeout
) {
7604 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7605 ssize_t nread
, totread
= 0;
7606 time_t start
= time(NULL
);
7610 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
7611 nread
= read(fd
,ptr
,size
);
7612 if (nread
== -1) return -1;
7617 if ((time(NULL
)-start
) > timeout
) {
7625 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7632 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
7635 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
7646 static void syncCommand(redisClient
*c
) {
7647 /* ignore SYNC if aleady slave or in monitor mode */
7648 if (c
->flags
& REDIS_SLAVE
) return;
7650 /* SYNC can't be issued when the server has pending data to send to
7651 * the client about already issued commands. We need a fresh reply
7652 * buffer registering the differences between the BGSAVE and the current
7653 * dataset, so that we can copy to other slaves if needed. */
7654 if (listLength(c
->reply
) != 0) {
7655 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
7659 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
7660 /* Here we need to check if there is a background saving operation
7661 * in progress, or if it is required to start one */
7662 if (server
.bgsavechildpid
!= -1) {
7663 /* Ok a background save is in progress. Let's check if it is a good
7664 * one for replication, i.e. if there is another slave that is
7665 * registering differences since the server forked to save */
7670 listRewind(server
.slaves
,&li
);
7671 while((ln
= listNext(&li
))) {
7673 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
7676 /* Perfect, the server is already registering differences for
7677 * another slave. Set the right state, and copy the buffer. */
7678 listRelease(c
->reply
);
7679 c
->reply
= listDup(slave
->reply
);
7680 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7681 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
7683 /* No way, we need to wait for the next BGSAVE in order to
7684 * register differences */
7685 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7686 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
7689 /* Ok we don't have a BGSAVE in progress, let's start one */
7690 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
7691 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7692 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
7693 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
7696 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7699 c
->flags
|= REDIS_SLAVE
;
7701 listAddNodeTail(server
.slaves
,c
);
7705 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
7706 redisClient
*slave
= privdata
;
7708 REDIS_NOTUSED(mask
);
7709 char buf
[REDIS_IOBUF_LEN
];
7710 ssize_t nwritten
, buflen
;
7712 if (slave
->repldboff
== 0) {
7713 /* Write the bulk write count before to transfer the DB. In theory here
7714 * we don't know how much room there is in the output buffer of the
7715 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
7716 * operations) will never be smaller than the few bytes we need. */
7719 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
7721 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
7729 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
7730 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
7732 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
7733 (buflen
== 0) ? "premature EOF" : strerror(errno
));
7737 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
7738 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
7743 slave
->repldboff
+= nwritten
;
7744 if (slave
->repldboff
== slave
->repldbsize
) {
7745 close(slave
->repldbfd
);
7746 slave
->repldbfd
= -1;
7747 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7748 slave
->replstate
= REDIS_REPL_ONLINE
;
7749 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
7750 sendReplyToClient
, slave
) == AE_ERR
) {
7754 addReplySds(slave
,sdsempty());
7755 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
7759 /* This function is called at the end of every backgrond saving.
7760 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
7761 * otherwise REDIS_ERR is passed to the function.
7763 * The goal of this function is to handle slaves waiting for a successful
7764 * background saving in order to perform non-blocking synchronization. */
7765 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
7767 int startbgsave
= 0;
7770 listRewind(server
.slaves
,&li
);
7771 while((ln
= listNext(&li
))) {
7772 redisClient
*slave
= ln
->value
;
7774 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
7776 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7777 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
7778 struct redis_stat buf
;
7780 if (bgsaveerr
!= REDIS_OK
) {
7782 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
7785 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
7786 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
7788 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
7791 slave
->repldboff
= 0;
7792 slave
->repldbsize
= buf
.st_size
;
7793 slave
->replstate
= REDIS_REPL_SEND_BULK
;
7794 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7795 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
7802 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7805 listRewind(server
.slaves
,&li
);
7806 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
7807 while((ln
= listNext(&li
))) {
7808 redisClient
*slave
= ln
->value
;
7810 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
7817 static int syncWithMaster(void) {
7818 char buf
[1024], tmpfile
[256], authcmd
[1024];
7820 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
7821 int dfd
, maxtries
= 5;
7824 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
7829 /* AUTH with the master if required. */
7830 if(server
.masterauth
) {
7831 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
7832 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
7834 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
7838 /* Read the AUTH result. */
7839 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7841 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
7845 if (buf
[0] != '+') {
7847 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
7852 /* Issue the SYNC command */
7853 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
7855 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
7859 /* Read the bulk write count */
7860 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7862 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
7866 if (buf
[0] != '$') {
7868 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
7871 dumpsize
= strtol(buf
+1,NULL
,10);
7872 redisLog(REDIS_NOTICE
,"Receiving %ld bytes data dump from MASTER",dumpsize
);
7873 /* Read the bulk write data on a temp file */
7875 snprintf(tmpfile
,256,
7876 "temp-%d.%ld.rdb",(int)time(NULL
),(long int)getpid());
7877 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
|O_EXCL
,0644);
7878 if (dfd
!= -1) break;
7883 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
7887 int nread
, nwritten
;
7889 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
7891 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
7897 nwritten
= write(dfd
,buf
,nread
);
7898 if (nwritten
== -1) {
7899 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
7907 if (rename(tmpfile
,server
.dbfilename
) == -1) {
7908 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
7914 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
7915 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
7919 server
.master
= createClient(fd
);
7920 server
.master
->flags
|= REDIS_MASTER
;
7921 server
.master
->authenticated
= 1;
7922 server
.replstate
= REDIS_REPL_CONNECTED
;
7926 static void slaveofCommand(redisClient
*c
) {
7927 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
7928 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
7929 if (server
.masterhost
) {
7930 sdsfree(server
.masterhost
);
7931 server
.masterhost
= NULL
;
7932 if (server
.master
) freeClient(server
.master
);
7933 server
.replstate
= REDIS_REPL_NONE
;
7934 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
7937 sdsfree(server
.masterhost
);
7938 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
7939 server
.masterport
= atoi(c
->argv
[2]->ptr
);
7940 if (server
.master
) freeClient(server
.master
);
7941 server
.replstate
= REDIS_REPL_CONNECT
;
7942 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
7943 server
.masterhost
, server
.masterport
);
7945 addReply(c
,shared
.ok
);
7948 /* ============================ Maxmemory directive ======================== */
7950 /* Try to free one object form the pre-allocated objects free list.
7951 * This is useful under low mem conditions as by default we take 1 million
7952 * free objects allocated. On success REDIS_OK is returned, otherwise
7954 static int tryFreeOneObjectFromFreelist(void) {
7957 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
7958 if (listLength(server
.objfreelist
)) {
7959 listNode
*head
= listFirst(server
.objfreelist
);
7960 o
= listNodeValue(head
);
7961 listDelNode(server
.objfreelist
,head
);
7962 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7966 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7971 /* This function gets called when 'maxmemory' is set on the config file to limit
7972 * the max memory used by the server, and we are out of memory.
7973 * This function will try to, in order:
7975 * - Free objects from the free list
7976 * - Try to remove keys with an EXPIRE set
7978 * It is not possible to free enough memory to reach used-memory < maxmemory
7979 * the server will start refusing commands that will enlarge even more the
7982 static void freeMemoryIfNeeded(void) {
7983 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
7984 int j
, k
, freed
= 0;
7986 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
7987 for (j
= 0; j
< server
.dbnum
; j
++) {
7989 robj
*minkey
= NULL
;
7990 struct dictEntry
*de
;
7992 if (dictSize(server
.db
[j
].expires
)) {
7994 /* From a sample of three keys drop the one nearest to
7995 * the natural expire */
7996 for (k
= 0; k
< 3; k
++) {
7999 de
= dictGetRandomKey(server
.db
[j
].expires
);
8000 t
= (time_t) dictGetEntryVal(de
);
8001 if (minttl
== -1 || t
< minttl
) {
8002 minkey
= dictGetEntryKey(de
);
8006 deleteKey(server
.db
+j
,minkey
);
8009 if (!freed
) return; /* nothing to free... */
8013 /* ============================== Append Only file ========================== */
8015 /* Write the append only file buffer on disk.
8017 * Since we are required to write the AOF before replying to the client,
8018 * and the only way the client socket can get a write is entering when the
8019 * the event loop, we accumulate all the AOF writes in a memory
8020 * buffer and write it on disk using this function just before entering
8021 * the event loop again. */
8022 static void flushAppendOnlyFile(void) {
8026 if (sdslen(server
.aofbuf
) == 0) return;
8028 /* We want to perform a single write. This should be guaranteed atomic
8029 * at least if the filesystem we are writing is a real physical one.
8030 * While this will save us against the server being killed I don't think
8031 * there is much to do about the whole server stopping for power problems
8033 nwritten
= write(server
.appendfd
,server
.aofbuf
,sdslen(server
.aofbuf
));
8034 if (nwritten
!= (signed)sdslen(server
.aofbuf
)) {
8035 /* Ooops, we are in troubles. The best thing to do for now is
8036 * aborting instead of giving the illusion that everything is
8037 * working as expected. */
8038 if (nwritten
== -1) {
8039 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
8041 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
8045 sdsfree(server
.aofbuf
);
8046 server
.aofbuf
= sdsempty();
8048 /* Fsync if needed */
8050 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
8051 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
8052 now
-server
.lastfsync
> 1))
8054 /* aof_fsync is defined as fdatasync() for Linux in order to avoid
8055 * flushing metadata. */
8056 aof_fsync(server
.appendfd
); /* Let's try to get this data on the disk */
8057 server
.lastfsync
= now
;
8061 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
8062 sds buf
= sdsempty();
8066 /* The DB this command was targetting is not the same as the last command
8067 * we appendend. To issue a SELECT command is needed. */
8068 if (dictid
!= server
.appendseldb
) {
8071 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
8072 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
8073 (unsigned long)strlen(seldb
),seldb
);
8074 server
.appendseldb
= dictid
;
8077 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
8078 * EXPIREs into EXPIREATs calls */
8079 if (cmd
->proc
== expireCommand
) {
8082 tmpargv
[0] = createStringObject("EXPIREAT",8);
8083 tmpargv
[1] = argv
[1];
8084 incrRefCount(argv
[1]);
8085 when
= time(NULL
)+strtol(argv
[2]->ptr
,NULL
,10);
8086 tmpargv
[2] = createObject(REDIS_STRING
,
8087 sdscatprintf(sdsempty(),"%ld",when
));
8091 /* Append the actual command */
8092 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
8093 for (j
= 0; j
< argc
; j
++) {
8096 o
= getDecodedObject(o
);
8097 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
8098 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
8099 buf
= sdscatlen(buf
,"\r\n",2);
8103 /* Free the objects from the modified argv for EXPIREAT */
8104 if (cmd
->proc
== expireCommand
) {
8105 for (j
= 0; j
< 3; j
++)
8106 decrRefCount(argv
[j
]);
8109 /* Append to the AOF buffer. This will be flushed on disk just before
8110 * of re-entering the event loop, so before the client will get a
8111 * positive reply about the operation performed. */
8112 server
.aofbuf
= sdscatlen(server
.aofbuf
,buf
,sdslen(buf
));
8114 /* If a background append only file rewriting is in progress we want to
8115 * accumulate the differences between the child DB and the current one
8116 * in a buffer, so that when the child process will do its work we
8117 * can append the differences to the new append only file. */
8118 if (server
.bgrewritechildpid
!= -1)
8119 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
8124 /* In Redis commands are always executed in the context of a client, so in
8125 * order to load the append only file we need to create a fake client. */
8126 static struct redisClient
*createFakeClient(void) {
8127 struct redisClient
*c
= zmalloc(sizeof(*c
));
8131 c
->querybuf
= sdsempty();
8135 /* We set the fake client as a slave waiting for the synchronization
8136 * so that Redis will not try to send replies to this client. */
8137 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
8138 c
->reply
= listCreate();
8139 listSetFreeMethod(c
->reply
,decrRefCount
);
8140 listSetDupMethod(c
->reply
,dupClientReplyValue
);
8141 initClientMultiState(c
);
8145 static void freeFakeClient(struct redisClient
*c
) {
8146 sdsfree(c
->querybuf
);
8147 listRelease(c
->reply
);
8148 freeClientMultiState(c
);
8152 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
8153 * error (the append only file is zero-length) REDIS_ERR is returned. On
8154 * fatal error an error message is logged and the program exists. */
8155 int loadAppendOnlyFile(char *filename
) {
8156 struct redisClient
*fakeClient
;
8157 FILE *fp
= fopen(filename
,"r");
8158 struct redis_stat sb
;
8159 unsigned long long loadedkeys
= 0;
8160 int appendonly
= server
.appendonly
;
8162 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
8166 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
8170 /* Temporarily disable AOF, to prevent EXEC from feeding a MULTI
8171 * to the same file we're about to read. */
8172 server
.appendonly
= 0;
8174 fakeClient
= createFakeClient();
8181 struct redisCommand
*cmd
;
8183 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
8189 if (buf
[0] != '*') goto fmterr
;
8191 argv
= zmalloc(sizeof(robj
*)*argc
);
8192 for (j
= 0; j
< argc
; j
++) {
8193 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
8194 if (buf
[0] != '$') goto fmterr
;
8195 len
= strtol(buf
+1,NULL
,10);
8196 argsds
= sdsnewlen(NULL
,len
);
8197 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
8198 argv
[j
] = createObject(REDIS_STRING
,argsds
);
8199 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
8202 /* Command lookup */
8203 cmd
= lookupCommand(argv
[0]->ptr
);
8205 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
8208 /* Try object encoding */
8209 if (cmd
->flags
& REDIS_CMD_BULK
)
8210 argv
[argc
-1] = tryObjectEncoding(argv
[argc
-1]);
8211 /* Run the command in the context of a fake client */
8212 fakeClient
->argc
= argc
;
8213 fakeClient
->argv
= argv
;
8214 cmd
->proc(fakeClient
);
8215 /* Discard the reply objects list from the fake client */
8216 while(listLength(fakeClient
->reply
))
8217 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
8218 /* Clean up, ready for the next command */
8219 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
8221 /* Handle swapping while loading big datasets when VM is on */
8223 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
8224 while (zmalloc_used_memory() > server
.vm_max_memory
) {
8225 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
8230 /* This point can only be reached when EOF is reached without errors.
8231 * If the client is in the middle of a MULTI/EXEC, log error and quit. */
8232 if (fakeClient
->flags
& REDIS_MULTI
) goto readerr
;
8235 freeFakeClient(fakeClient
);
8236 server
.appendonly
= appendonly
;
8241 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
8243 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
8247 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
8251 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
8252 static int fwriteBulkObject(FILE *fp
, robj
*obj
) {
8256 /* Avoid the incr/decr ref count business if possible to help
8257 * copy-on-write (we are often in a child process when this function
8259 * Also makes sure that key objects don't get incrRefCount-ed when VM
8261 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
8262 obj
= getDecodedObject(obj
);
8265 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
8266 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
8267 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
8269 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
8270 if (decrrc
) decrRefCount(obj
);
8273 if (decrrc
) decrRefCount(obj
);
8277 /* Write binary-safe string into a file in the bulkformat
8278 * $<count>\r\n<payload>\r\n */
8279 static int fwriteBulkString(FILE *fp
, char *s
, unsigned long len
) {
8282 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(unsigned long)len
);
8283 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8284 if (len
&& fwrite(s
,len
,1,fp
) == 0) return 0;
8285 if (fwrite("\r\n",2,1,fp
) == 0) return 0;
8289 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
8290 static int fwriteBulkDouble(FILE *fp
, double d
) {
8291 char buf
[128], dbuf
[128];
8293 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
8294 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
8295 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8296 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
8300 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
8301 static int fwriteBulkLong(FILE *fp
, long l
) {
8302 char buf
[128], lbuf
[128];
8304 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
8305 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
8306 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8307 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
8311 /* Write a sequence of commands able to fully rebuild the dataset into
8312 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
8313 static int rewriteAppendOnlyFile(char *filename
) {
8314 dictIterator
*di
= NULL
;
8319 time_t now
= time(NULL
);
8321 /* Note that we have to use a different temp name here compared to the
8322 * one used by rewriteAppendOnlyFileBackground() function. */
8323 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
8324 fp
= fopen(tmpfile
,"w");
8326 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
8329 for (j
= 0; j
< server
.dbnum
; j
++) {
8330 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
8331 redisDb
*db
= server
.db
+j
;
8333 if (dictSize(d
) == 0) continue;
8334 di
= dictGetIterator(d
);
8340 /* SELECT the new DB */
8341 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
8342 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
8344 /* Iterate this DB writing every entry */
8345 while((de
= dictNext(di
)) != NULL
) {
8350 key
= dictGetEntryKey(de
);
8351 /* If the value for this key is swapped, load a preview in memory.
8352 * We use a "swapped" flag to remember if we need to free the
8353 * value object instead to just increment the ref count anyway
8354 * in order to avoid copy-on-write of pages if we are forked() */
8355 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
8356 key
->storage
== REDIS_VM_SWAPPING
) {
8357 o
= dictGetEntryVal(de
);
8360 o
= vmPreviewObject(key
);
8363 expiretime
= getExpire(db
,key
);
8365 /* Save the key and associated value */
8366 if (o
->type
== REDIS_STRING
) {
8367 /* Emit a SET command */
8368 char cmd
[]="*3\r\n$3\r\nSET\r\n";
8369 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8371 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8372 if (fwriteBulkObject(fp
,o
) == 0) goto werr
;
8373 } else if (o
->type
== REDIS_LIST
) {
8374 /* Emit the RPUSHes needed to rebuild the list */
8375 list
*list
= o
->ptr
;
8379 listRewind(list
,&li
);
8380 while((ln
= listNext(&li
))) {
8381 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
8382 robj
*eleobj
= listNodeValue(ln
);
8384 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8385 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8386 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8388 } else if (o
->type
== REDIS_SET
) {
8389 /* Emit the SADDs needed to rebuild the set */
8391 dictIterator
*di
= dictGetIterator(set
);
8394 while((de
= dictNext(di
)) != NULL
) {
8395 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
8396 robj
*eleobj
= dictGetEntryKey(de
);
8398 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8399 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8400 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8402 dictReleaseIterator(di
);
8403 } else if (o
->type
== REDIS_ZSET
) {
8404 /* Emit the ZADDs needed to rebuild the sorted set */
8406 dictIterator
*di
= dictGetIterator(zs
->dict
);
8409 while((de
= dictNext(di
)) != NULL
) {
8410 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
8411 robj
*eleobj
= dictGetEntryKey(de
);
8412 double *score
= dictGetEntryVal(de
);
8414 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8415 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8416 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
8417 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8419 dictReleaseIterator(di
);
8420 } else if (o
->type
== REDIS_HASH
) {
8421 char cmd
[]="*4\r\n$4\r\nHSET\r\n";
8423 /* Emit the HSETs needed to rebuild the hash */
8424 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
8425 unsigned char *p
= zipmapRewind(o
->ptr
);
8426 unsigned char *field
, *val
;
8427 unsigned int flen
, vlen
;
8429 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
8430 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8431 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8432 if (fwriteBulkString(fp
,(char*)field
,flen
) == -1)
8434 if (fwriteBulkString(fp
,(char*)val
,vlen
) == -1)
8438 dictIterator
*di
= dictGetIterator(o
->ptr
);
8441 while((de
= dictNext(di
)) != NULL
) {
8442 robj
*field
= dictGetEntryKey(de
);
8443 robj
*val
= dictGetEntryVal(de
);
8445 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8446 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8447 if (fwriteBulkObject(fp
,field
) == -1) return -1;
8448 if (fwriteBulkObject(fp
,val
) == -1) return -1;
8450 dictReleaseIterator(di
);
8453 redisPanic("Unknown object type");
8455 /* Save the expire time */
8456 if (expiretime
!= -1) {
8457 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
8458 /* If this key is already expired skip it */
8459 if (expiretime
< now
) continue;
8460 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8461 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8462 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
8464 if (swapped
) decrRefCount(o
);
8466 dictReleaseIterator(di
);
8469 /* Make sure data will not remain on the OS's output buffers */
8474 /* Use RENAME to make sure the DB file is changed atomically only
8475 * if the generate DB file is ok. */
8476 if (rename(tmpfile
,filename
) == -1) {
8477 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
8481 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
8487 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
8488 if (di
) dictReleaseIterator(di
);
8492 /* This is how rewriting of the append only file in background works:
8494 * 1) The user calls BGREWRITEAOF
8495 * 2) Redis calls this function, that forks():
8496 * 2a) the child rewrite the append only file in a temp file.
8497 * 2b) the parent accumulates differences in server.bgrewritebuf.
8498 * 3) When the child finished '2a' exists.
8499 * 4) The parent will trap the exit code, if it's OK, will append the
8500 * data accumulated into server.bgrewritebuf into the temp file, and
8501 * finally will rename(2) the temp file in the actual file name.
8502 * The the new file is reopened as the new append only file. Profit!
8504 static int rewriteAppendOnlyFileBackground(void) {
8507 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
8508 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
8509 if ((childpid
= fork()) == 0) {
8513 if (server
.vm_enabled
) vmReopenSwapFile();
8515 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
8516 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
8523 if (childpid
== -1) {
8524 redisLog(REDIS_WARNING
,
8525 "Can't rewrite append only file in background: fork: %s",
8529 redisLog(REDIS_NOTICE
,
8530 "Background append only file rewriting started by pid %d",childpid
);
8531 server
.bgrewritechildpid
= childpid
;
8532 updateDictResizePolicy();
8533 /* We set appendseldb to -1 in order to force the next call to the
8534 * feedAppendOnlyFile() to issue a SELECT command, so the differences
8535 * accumulated by the parent into server.bgrewritebuf will start
8536 * with a SELECT statement and it will be safe to merge. */
8537 server
.appendseldb
= -1;
8540 return REDIS_OK
; /* unreached */
8543 static void bgrewriteaofCommand(redisClient
*c
) {
8544 if (server
.bgrewritechildpid
!= -1) {
8545 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
8548 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
8549 char *status
= "+Background append only file rewriting started\r\n";
8550 addReplySds(c
,sdsnew(status
));
8552 addReply(c
,shared
.err
);
8556 static void aofRemoveTempFile(pid_t childpid
) {
8559 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
8563 /* Virtual Memory is composed mainly of two subsystems:
8564 * - Blocking Virutal Memory
8565 * - Threaded Virtual Memory I/O
8566 * The two parts are not fully decoupled, but functions are split among two
8567 * different sections of the source code (delimited by comments) in order to
8568 * make more clear what functionality is about the blocking VM and what about
8569 * the threaded (not blocking) VM.
8573 * Redis VM is a blocking VM (one that blocks reading swapped values from
8574 * disk into memory when a value swapped out is needed in memory) that is made
8575 * unblocking by trying to examine the command argument vector in order to
8576 * load in background values that will likely be needed in order to exec
8577 * the command. The command is executed only once all the relevant keys
8578 * are loaded into memory.
8580 * This basically is almost as simple of a blocking VM, but almost as parallel
8581 * as a fully non-blocking VM.
8584 /* =================== Virtual Memory - Blocking Side ====================== */
8586 static void vmInit(void) {
8592 if (server
.vm_max_threads
!= 0)
8593 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
8595 redisLog(REDIS_NOTICE
,"Using '%s' as swap file",server
.vm_swap_file
);
8596 /* Try to open the old swap file, otherwise create it */
8597 if ((server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b")) == NULL
) {
8598 server
.vm_fp
= fopen(server
.vm_swap_file
,"w+b");
8600 if (server
.vm_fp
== NULL
) {
8601 redisLog(REDIS_WARNING
,
8602 "Can't open the swap file: %s. Exiting.",
8606 server
.vm_fd
= fileno(server
.vm_fp
);
8607 /* Lock the swap file for writing, this is useful in order to avoid
8608 * another instance to use the same swap file for a config error. */
8609 fl
.l_type
= F_WRLCK
;
8610 fl
.l_whence
= SEEK_SET
;
8611 fl
.l_start
= fl
.l_len
= 0;
8612 if (fcntl(server
.vm_fd
,F_SETLK
,&fl
) == -1) {
8613 redisLog(REDIS_WARNING
,
8614 "Can't lock the swap file at '%s': %s. Make sure it is not used by another Redis instance.", server
.vm_swap_file
, strerror(errno
));
8618 server
.vm_next_page
= 0;
8619 server
.vm_near_pages
= 0;
8620 server
.vm_stats_used_pages
= 0;
8621 server
.vm_stats_swapped_objects
= 0;
8622 server
.vm_stats_swapouts
= 0;
8623 server
.vm_stats_swapins
= 0;
8624 totsize
= server
.vm_pages
*server
.vm_page_size
;
8625 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
8626 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
8627 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
8631 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
8633 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
8634 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
8635 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
8636 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
8638 /* Initialize threaded I/O (used by Virtual Memory) */
8639 server
.io_newjobs
= listCreate();
8640 server
.io_processing
= listCreate();
8641 server
.io_processed
= listCreate();
8642 server
.io_ready_clients
= listCreate();
8643 pthread_mutex_init(&server
.io_mutex
,NULL
);
8644 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
8645 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
8646 server
.io_active_threads
= 0;
8647 if (pipe(pipefds
) == -1) {
8648 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
8652 server
.io_ready_pipe_read
= pipefds
[0];
8653 server
.io_ready_pipe_write
= pipefds
[1];
8654 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
8655 /* LZF requires a lot of stack */
8656 pthread_attr_init(&server
.io_threads_attr
);
8657 pthread_attr_getstacksize(&server
.io_threads_attr
, &stacksize
);
8658 while (stacksize
< REDIS_THREAD_STACK_SIZE
) stacksize
*= 2;
8659 pthread_attr_setstacksize(&server
.io_threads_attr
, stacksize
);
8660 /* Listen for events in the threaded I/O pipe */
8661 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
8662 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
8663 oom("creating file event");
8666 /* Mark the page as used */
8667 static void vmMarkPageUsed(off_t page
) {
8668 off_t byte
= page
/8;
8670 redisAssert(vmFreePage(page
) == 1);
8671 server
.vm_bitmap
[byte
] |= 1<<bit
;
8674 /* Mark N contiguous pages as used, with 'page' being the first. */
8675 static void vmMarkPagesUsed(off_t page
, off_t count
) {
8678 for (j
= 0; j
< count
; j
++)
8679 vmMarkPageUsed(page
+j
);
8680 server
.vm_stats_used_pages
+= count
;
8681 redisLog(REDIS_DEBUG
,"Mark USED pages: %lld pages at %lld\n",
8682 (long long)count
, (long long)page
);
8685 /* Mark the page as free */
8686 static void vmMarkPageFree(off_t page
) {
8687 off_t byte
= page
/8;
8689 redisAssert(vmFreePage(page
) == 0);
8690 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
8693 /* Mark N contiguous pages as free, with 'page' being the first. */
8694 static void vmMarkPagesFree(off_t page
, off_t count
) {
8697 for (j
= 0; j
< count
; j
++)
8698 vmMarkPageFree(page
+j
);
8699 server
.vm_stats_used_pages
-= count
;
8700 redisLog(REDIS_DEBUG
,"Mark FREE pages: %lld pages at %lld\n",
8701 (long long)count
, (long long)page
);
8704 /* Test if the page is free */
8705 static int vmFreePage(off_t page
) {
8706 off_t byte
= page
/8;
8708 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
8711 /* Find N contiguous free pages storing the first page of the cluster in *first.
8712 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
8713 * REDIS_ERR is returned.
8715 * This function uses a simple algorithm: we try to allocate
8716 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
8717 * again from the start of the swap file searching for free spaces.
8719 * If it looks pretty clear that there are no free pages near our offset
8720 * we try to find less populated places doing a forward jump of
8721 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
8722 * without hurry, and then we jump again and so forth...
8724 * This function can be improved using a free list to avoid to guess
8725 * too much, since we could collect data about freed pages.
8727 * note: I implemented this function just after watching an episode of
8728 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
8730 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
8731 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
8733 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
8734 server
.vm_near_pages
= 0;
8735 server
.vm_next_page
= 0;
8737 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
8738 base
= server
.vm_next_page
;
8740 while(offset
< server
.vm_pages
) {
8741 off_t
this = base
+offset
;
8743 /* If we overflow, restart from page zero */
8744 if (this >= server
.vm_pages
) {
8745 this -= server
.vm_pages
;
8747 /* Just overflowed, what we found on tail is no longer
8748 * interesting, as it's no longer contiguous. */
8752 if (vmFreePage(this)) {
8753 /* This is a free page */
8755 /* Already got N free pages? Return to the caller, with success */
8757 *first
= this-(n
-1);
8758 server
.vm_next_page
= this+1;
8759 redisLog(REDIS_DEBUG
, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n
, (long long) *first
);
8763 /* The current one is not a free page */
8767 /* Fast-forward if the current page is not free and we already
8768 * searched enough near this place. */
8770 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
8771 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
8773 /* Note that even if we rewind after the jump, we are don't need
8774 * to make sure numfree is set to zero as we only jump *if* it
8775 * is set to zero. */
8777 /* Otherwise just check the next page */
8784 /* Write the specified object at the specified page of the swap file */
8785 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
8786 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8787 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8788 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8789 redisLog(REDIS_WARNING
,
8790 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
8794 rdbSaveObject(server
.vm_fp
,o
);
8795 fflush(server
.vm_fp
);
8796 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8800 /* Swap the 'val' object relative to 'key' into disk. Store all the information
8801 * needed to later retrieve the object into the key object.
8802 * If we can't find enough contiguous empty pages to swap the object on disk
8803 * REDIS_ERR is returned. */
8804 static int vmSwapObjectBlocking(robj
*key
, robj
*val
) {
8805 off_t pages
= rdbSavedObjectPages(val
,NULL
);
8808 assert(key
->storage
== REDIS_VM_MEMORY
);
8809 assert(key
->refcount
== 1);
8810 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
8811 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return REDIS_ERR
;
8812 key
->vm
.page
= page
;
8813 key
->vm
.usedpages
= pages
;
8814 key
->storage
= REDIS_VM_SWAPPED
;
8815 key
->vtype
= val
->type
;
8816 decrRefCount(val
); /* Deallocate the object from memory. */
8817 vmMarkPagesUsed(page
,pages
);
8818 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
8819 (unsigned char*) key
->ptr
,
8820 (unsigned long long) page
, (unsigned long long) pages
);
8821 server
.vm_stats_swapped_objects
++;
8822 server
.vm_stats_swapouts
++;
8826 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
8829 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8830 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8831 redisLog(REDIS_WARNING
,
8832 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
8836 o
= rdbLoadObject(type
,server
.vm_fp
);
8838 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno
));
8841 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8845 /* Load the value object relative to the 'key' object from swap to memory.
8846 * The newly allocated object is returned.
8848 * If preview is true the unserialized object is returned to the caller but
8849 * no changes are made to the key object, nor the pages are marked as freed */
8850 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
8853 redisAssert(key
->storage
== REDIS_VM_SWAPPED
|| key
->storage
== REDIS_VM_LOADING
);
8854 val
= vmReadObjectFromSwap(key
->vm
.page
,key
->vtype
);
8856 key
->storage
= REDIS_VM_MEMORY
;
8857 key
->vm
.atime
= server
.unixtime
;
8858 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8859 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
8860 (unsigned char*) key
->ptr
);
8861 server
.vm_stats_swapped_objects
--;
8863 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
8864 (unsigned char*) key
->ptr
);
8866 server
.vm_stats_swapins
++;
8870 /* Plain object loading, from swap to memory */
8871 static robj
*vmLoadObject(robj
*key
) {
8872 /* If we are loading the object in background, stop it, we
8873 * need to load this object synchronously ASAP. */
8874 if (key
->storage
== REDIS_VM_LOADING
)
8875 vmCancelThreadedIOJob(key
);
8876 return vmGenericLoadObject(key
,0);
8879 /* Just load the value on disk, without to modify the key.
8880 * This is useful when we want to perform some operation on the value
8881 * without to really bring it from swap to memory, like while saving the
8882 * dataset or rewriting the append only log. */
8883 static robj
*vmPreviewObject(robj
*key
) {
8884 return vmGenericLoadObject(key
,1);
8887 /* How a good candidate is this object for swapping?
8888 * The better candidate it is, the greater the returned value.
8890 * Currently we try to perform a fast estimation of the object size in
8891 * memory, and combine it with aging informations.
8893 * Basically swappability = idle-time * log(estimated size)
8895 * Bigger objects are preferred over smaller objects, but not
8896 * proportionally, this is why we use the logarithm. This algorithm is
8897 * just a first try and will probably be tuned later. */
8898 static double computeObjectSwappability(robj
*o
) {
8899 time_t age
= server
.unixtime
- o
->vm
.atime
;
8903 struct dictEntry
*de
;
8906 if (age
<= 0) return 0;
8909 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
8912 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
8917 listNode
*ln
= listFirst(l
);
8919 asize
= sizeof(list
);
8921 robj
*ele
= ln
->value
;
8924 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8925 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8927 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
8932 z
= (o
->type
== REDIS_ZSET
);
8933 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
8935 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
8936 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
8941 de
= dictGetRandomKey(d
);
8942 ele
= dictGetEntryKey(de
);
8943 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8944 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8946 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
8947 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
8951 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
8952 unsigned char *p
= zipmapRewind((unsigned char*)o
->ptr
);
8953 unsigned int len
= zipmapLen((unsigned char*)o
->ptr
);
8954 unsigned int klen
, vlen
;
8955 unsigned char *key
, *val
;
8957 if ((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) == NULL
) {
8961 asize
= len
*(klen
+vlen
+3);
8962 } else if (o
->encoding
== REDIS_ENCODING_HT
) {
8964 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
8969 de
= dictGetRandomKey(d
);
8970 ele
= dictGetEntryKey(de
);
8971 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8972 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8974 ele
= dictGetEntryVal(de
);
8975 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8976 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8978 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
8983 return (double)age
*log(1+asize
);
8986 /* Try to swap an object that's a good candidate for swapping.
8987 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
8988 * to swap any object at all.
8990 * If 'usethreaded' is true, Redis will try to swap the object in background
8991 * using I/O threads. */
8992 static int vmSwapOneObject(int usethreads
) {
8994 struct dictEntry
*best
= NULL
;
8995 double best_swappability
= 0;
8996 redisDb
*best_db
= NULL
;
8999 for (j
= 0; j
< server
.dbnum
; j
++) {
9000 redisDb
*db
= server
.db
+j
;
9001 /* Why maxtries is set to 100?
9002 * Because this way (usually) we'll find 1 object even if just 1% - 2%
9003 * are swappable objects */
9006 if (dictSize(db
->dict
) == 0) continue;
9007 for (i
= 0; i
< 5; i
++) {
9009 double swappability
;
9011 if (maxtries
) maxtries
--;
9012 de
= dictGetRandomKey(db
->dict
);
9013 key
= dictGetEntryKey(de
);
9014 val
= dictGetEntryVal(de
);
9015 /* Only swap objects that are currently in memory.
9017 * Also don't swap shared objects if threaded VM is on, as we
9018 * try to ensure that the main thread does not touch the
9019 * object while the I/O thread is using it, but we can't
9020 * control other keys without adding additional mutex. */
9021 if (key
->storage
!= REDIS_VM_MEMORY
||
9022 (server
.vm_max_threads
!= 0 && val
->refcount
!= 1)) {
9023 if (maxtries
) i
--; /* don't count this try */
9026 swappability
= computeObjectSwappability(val
);
9027 if (!best
|| swappability
> best_swappability
) {
9029 best_swappability
= swappability
;
9034 if (best
== NULL
) return REDIS_ERR
;
9035 key
= dictGetEntryKey(best
);
9036 val
= dictGetEntryVal(best
);
9038 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
9039 key
->ptr
, best_swappability
);
9041 /* Unshare the key if needed */
9042 if (key
->refcount
> 1) {
9043 robj
*newkey
= dupStringObject(key
);
9045 key
= dictGetEntryKey(best
) = newkey
;
9049 vmSwapObjectThreaded(key
,val
,best_db
);
9052 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
9053 dictGetEntryVal(best
) = NULL
;
9061 static int vmSwapOneObjectBlocking() {
9062 return vmSwapOneObject(0);
9065 static int vmSwapOneObjectThreaded() {
9066 return vmSwapOneObject(1);
9069 /* Return true if it's safe to swap out objects in a given moment.
9070 * Basically we don't want to swap objects out while there is a BGSAVE
9071 * or a BGAEOREWRITE running in backgroud. */
9072 static int vmCanSwapOut(void) {
9073 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
9076 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
9077 * and was deleted. Otherwise 0 is returned. */
9078 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
9082 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
9083 foundkey
= dictGetEntryKey(de
);
9084 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
9089 /* =================== Virtual Memory - Threaded I/O ======================= */
9091 static void freeIOJob(iojob
*j
) {
9092 if ((j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
9093 j
->type
== REDIS_IOJOB_DO_SWAP
||
9094 j
->type
== REDIS_IOJOB_LOAD
) && j
->val
!= NULL
)
9095 decrRefCount(j
->val
);
9096 /* We don't decrRefCount the j->key field as we did't incremented
9097 * the count creating IO Jobs. This is because the key field here is
9098 * just used as an indentifier and if a key is removed the Job should
9099 * never be touched again. */
9103 /* Every time a thread finished a Job, it writes a byte into the write side
9104 * of an unix pipe in order to "awake" the main thread, and this function
9106 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
9110 int retval
, processed
= 0, toprocess
= -1, trytoswap
= 1;
9112 REDIS_NOTUSED(mask
);
9113 REDIS_NOTUSED(privdata
);
9115 /* For every byte we read in the read side of the pipe, there is one
9116 * I/O job completed to process. */
9117 while((retval
= read(fd
,buf
,1)) == 1) {
9121 struct dictEntry
*de
;
9123 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
9125 /* Get the processed element (the oldest one) */
9127 assert(listLength(server
.io_processed
) != 0);
9128 if (toprocess
== -1) {
9129 toprocess
= (listLength(server
.io_processed
)*REDIS_MAX_COMPLETED_JOBS_PROCESSED
)/100;
9130 if (toprocess
<= 0) toprocess
= 1;
9132 ln
= listFirst(server
.io_processed
);
9134 listDelNode(server
.io_processed
,ln
);
9136 /* If this job is marked as canceled, just ignore it */
9141 /* Post process it in the main thread, as there are things we
9142 * can do just here to avoid race conditions and/or invasive locks */
9143 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
);
9144 de
= dictFind(j
->db
->dict
,j
->key
);
9146 key
= dictGetEntryKey(de
);
9147 if (j
->type
== REDIS_IOJOB_LOAD
) {
9150 /* Key loaded, bring it at home */
9151 key
->storage
= REDIS_VM_MEMORY
;
9152 key
->vm
.atime
= server
.unixtime
;
9153 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
9154 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
9155 (unsigned char*) key
->ptr
);
9156 server
.vm_stats_swapped_objects
--;
9157 server
.vm_stats_swapins
++;
9158 dictGetEntryVal(de
) = j
->val
;
9159 incrRefCount(j
->val
);
9162 /* Handle clients waiting for this key to be loaded. */
9163 handleClientsBlockedOnSwappedKey(db
,key
);
9164 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
9165 /* Now we know the amount of pages required to swap this object.
9166 * Let's find some space for it, and queue this task again
9167 * rebranded as REDIS_IOJOB_DO_SWAP. */
9168 if (!vmCanSwapOut() ||
9169 vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
)
9171 /* Ooops... no space or we can't swap as there is
9172 * a fork()ed Redis trying to save stuff on disk. */
9174 key
->storage
= REDIS_VM_MEMORY
; /* undo operation */
9176 /* Note that we need to mark this pages as used now,
9177 * if the job will be canceled, we'll mark them as freed
9179 vmMarkPagesUsed(j
->page
,j
->pages
);
9180 j
->type
= REDIS_IOJOB_DO_SWAP
;
9185 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
9188 /* Key swapped. We can finally free some memory. */
9189 if (key
->storage
!= REDIS_VM_SWAPPING
) {
9190 printf("key->storage: %d\n",key
->storage
);
9191 printf("key->name: %s\n",(char*)key
->ptr
);
9192 printf("key->refcount: %d\n",key
->refcount
);
9193 printf("val: %p\n",(void*)j
->val
);
9194 printf("val->type: %d\n",j
->val
->type
);
9195 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
9197 redisAssert(key
->storage
== REDIS_VM_SWAPPING
);
9198 val
= dictGetEntryVal(de
);
9199 key
->vm
.page
= j
->page
;
9200 key
->vm
.usedpages
= j
->pages
;
9201 key
->storage
= REDIS_VM_SWAPPED
;
9202 key
->vtype
= j
->val
->type
;
9203 decrRefCount(val
); /* Deallocate the object from memory. */
9204 dictGetEntryVal(de
) = NULL
;
9205 redisLog(REDIS_DEBUG
,
9206 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
9207 (unsigned char*) key
->ptr
,
9208 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
9209 server
.vm_stats_swapped_objects
++;
9210 server
.vm_stats_swapouts
++;
9212 /* Put a few more swap requests in queue if we are still
9214 if (trytoswap
&& vmCanSwapOut() &&
9215 zmalloc_used_memory() > server
.vm_max_memory
)
9220 more
= listLength(server
.io_newjobs
) <
9221 (unsigned) server
.vm_max_threads
;
9223 /* Don't waste CPU time if swappable objects are rare. */
9224 if (vmSwapOneObjectThreaded() == REDIS_ERR
) {
9232 if (processed
== toprocess
) return;
9234 if (retval
< 0 && errno
!= EAGAIN
) {
9235 redisLog(REDIS_WARNING
,
9236 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
9241 static void lockThreadedIO(void) {
9242 pthread_mutex_lock(&server
.io_mutex
);
9245 static void unlockThreadedIO(void) {
9246 pthread_mutex_unlock(&server
.io_mutex
);
9249 /* Remove the specified object from the threaded I/O queue if still not
9250 * processed, otherwise make sure to flag it as canceled. */
9251 static void vmCancelThreadedIOJob(robj
*o
) {
9253 server
.io_newjobs
, /* 0 */
9254 server
.io_processing
, /* 1 */
9255 server
.io_processed
/* 2 */
9259 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
9262 /* Search for a matching key in one of the queues */
9263 for (i
= 0; i
< 3; i
++) {
9267 listRewind(lists
[i
],&li
);
9268 while ((ln
= listNext(&li
)) != NULL
) {
9269 iojob
*job
= ln
->value
;
9271 if (job
->canceled
) continue; /* Skip this, already canceled. */
9272 if (job
->key
== o
) {
9273 redisLog(REDIS_DEBUG
,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
9274 (void*)job
, (char*)o
->ptr
, job
->type
, i
);
9275 /* Mark the pages as free since the swap didn't happened
9276 * or happened but is now discarded. */
9277 if (i
!= 1 && job
->type
== REDIS_IOJOB_DO_SWAP
)
9278 vmMarkPagesFree(job
->page
,job
->pages
);
9279 /* Cancel the job. It depends on the list the job is
9282 case 0: /* io_newjobs */
9283 /* If the job was yet not processed the best thing to do
9284 * is to remove it from the queue at all */
9286 listDelNode(lists
[i
],ln
);
9288 case 1: /* io_processing */
9289 /* Oh Shi- the thread is messing with the Job:
9291 * Probably it's accessing the object if this is a
9292 * PREPARE_SWAP or DO_SWAP job.
9293 * If it's a LOAD job it may be reading from disk and
9294 * if we don't wait for the job to terminate before to
9295 * cancel it, maybe in a few microseconds data can be
9296 * corrupted in this pages. So the short story is:
9298 * Better to wait for the job to move into the
9299 * next queue (processed)... */
9301 /* We try again and again until the job is completed. */
9303 /* But let's wait some time for the I/O thread
9304 * to finish with this job. After all this condition
9305 * should be very rare. */
9308 case 2: /* io_processed */
9309 /* The job was already processed, that's easy...
9310 * just mark it as canceled so that we'll ignore it
9311 * when processing completed jobs. */
9315 /* Finally we have to adjust the storage type of the object
9316 * in order to "UNDO" the operaiton. */
9317 if (o
->storage
== REDIS_VM_LOADING
)
9318 o
->storage
= REDIS_VM_SWAPPED
;
9319 else if (o
->storage
== REDIS_VM_SWAPPING
)
9320 o
->storage
= REDIS_VM_MEMORY
;
9327 assert(1 != 1); /* We should never reach this */
9330 static void *IOThreadEntryPoint(void *arg
) {
9335 pthread_detach(pthread_self());
9337 /* Get a new job to process */
9339 if (listLength(server
.io_newjobs
) == 0) {
9340 /* No new jobs in queue, exit. */
9341 redisLog(REDIS_DEBUG
,"Thread %ld exiting, nothing to do",
9342 (long) pthread_self());
9343 server
.io_active_threads
--;
9347 ln
= listFirst(server
.io_newjobs
);
9349 listDelNode(server
.io_newjobs
,ln
);
9350 /* Add the job in the processing queue */
9351 j
->thread
= pthread_self();
9352 listAddNodeTail(server
.io_processing
,j
);
9353 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
9355 redisLog(REDIS_DEBUG
,"Thread %ld got a new job (type %d): %p about key '%s'",
9356 (long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
9358 /* Process the Job */
9359 if (j
->type
== REDIS_IOJOB_LOAD
) {
9360 j
->val
= vmReadObjectFromSwap(j
->page
,j
->key
->vtype
);
9361 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
9362 FILE *fp
= fopen("/dev/null","w+");
9363 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
9365 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
9366 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
9370 /* Done: insert the job into the processed queue */
9371 redisLog(REDIS_DEBUG
,"Thread %ld completed the job: %p (key %s)",
9372 (long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
9374 listDelNode(server
.io_processing
,ln
);
9375 listAddNodeTail(server
.io_processed
,j
);
9378 /* Signal the main thread there is new stuff to process */
9379 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
9381 return NULL
; /* never reached */
9384 static void spawnIOThread(void) {
9386 sigset_t mask
, omask
;
9390 sigaddset(&mask
,SIGCHLD
);
9391 sigaddset(&mask
,SIGHUP
);
9392 sigaddset(&mask
,SIGPIPE
);
9393 pthread_sigmask(SIG_SETMASK
, &mask
, &omask
);
9394 while ((err
= pthread_create(&thread
,&server
.io_threads_attr
,IOThreadEntryPoint
,NULL
)) != 0) {
9395 redisLog(REDIS_WARNING
,"Unable to spawn an I/O thread: %s",
9399 pthread_sigmask(SIG_SETMASK
, &omask
, NULL
);
9400 server
.io_active_threads
++;
9403 /* We need to wait for the last thread to exit before we are able to
9404 * fork() in order to BGSAVE or BGREWRITEAOF. */
9405 static void waitEmptyIOJobsQueue(void) {
9407 int io_processed_len
;
9410 if (listLength(server
.io_newjobs
) == 0 &&
9411 listLength(server
.io_processing
) == 0 &&
9412 server
.io_active_threads
== 0)
9417 /* While waiting for empty jobs queue condition we post-process some
9418 * finshed job, as I/O threads may be hanging trying to write against
9419 * the io_ready_pipe_write FD but there are so much pending jobs that
9421 io_processed_len
= listLength(server
.io_processed
);
9423 if (io_processed_len
) {
9424 vmThreadedIOCompletedJob(NULL
,server
.io_ready_pipe_read
,NULL
,0);
9425 usleep(1000); /* 1 millisecond */
9427 usleep(10000); /* 10 milliseconds */
9432 static void vmReopenSwapFile(void) {
9433 /* Note: we don't close the old one as we are in the child process
9434 * and don't want to mess at all with the original file object. */
9435 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
9436 if (server
.vm_fp
== NULL
) {
9437 redisLog(REDIS_WARNING
,"Can't re-open the VM swap file: %s. Exiting.",
9438 server
.vm_swap_file
);
9441 server
.vm_fd
= fileno(server
.vm_fp
);
9444 /* This function must be called while with threaded IO locked */
9445 static void queueIOJob(iojob
*j
) {
9446 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
9447 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
9448 listAddNodeTail(server
.io_newjobs
,j
);
9449 if (server
.io_active_threads
< server
.vm_max_threads
)
9453 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
9456 assert(key
->storage
== REDIS_VM_MEMORY
);
9457 assert(key
->refcount
== 1);
9459 j
= zmalloc(sizeof(*j
));
9460 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
9466 j
->thread
= (pthread_t
) -1;
9467 key
->storage
= REDIS_VM_SWAPPING
;
9475 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
9477 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
9478 * If there is not already a job loading the key, it is craeted.
9479 * The key is added to the io_keys list in the client structure, and also
9480 * in the hash table mapping swapped keys to waiting clients, that is,
9481 * server.io_waited_keys. */
9482 static int waitForSwappedKey(redisClient
*c
, robj
*key
) {
9483 struct dictEntry
*de
;
9487 /* If the key does not exist or is already in RAM we don't need to
9488 * block the client at all. */
9489 de
= dictFind(c
->db
->dict
,key
);
9490 if (de
== NULL
) return 0;
9491 o
= dictGetEntryKey(de
);
9492 if (o
->storage
== REDIS_VM_MEMORY
) {
9494 } else if (o
->storage
== REDIS_VM_SWAPPING
) {
9495 /* We were swapping the key, undo it! */
9496 vmCancelThreadedIOJob(o
);
9500 /* OK: the key is either swapped, or being loaded just now. */
9502 /* Add the key to the list of keys this client is waiting for.
9503 * This maps clients to keys they are waiting for. */
9504 listAddNodeTail(c
->io_keys
,key
);
9507 /* Add the client to the swapped keys => clients waiting map. */
9508 de
= dictFind(c
->db
->io_keys
,key
);
9512 /* For every key we take a list of clients blocked for it */
9514 retval
= dictAdd(c
->db
->io_keys
,key
,l
);
9516 assert(retval
== DICT_OK
);
9518 l
= dictGetEntryVal(de
);
9520 listAddNodeTail(l
,c
);
9522 /* Are we already loading the key from disk? If not create a job */
9523 if (o
->storage
== REDIS_VM_SWAPPED
) {
9526 o
->storage
= REDIS_VM_LOADING
;
9527 j
= zmalloc(sizeof(*j
));
9528 j
->type
= REDIS_IOJOB_LOAD
;
9531 j
->key
->vtype
= o
->vtype
;
9532 j
->page
= o
->vm
.page
;
9535 j
->thread
= (pthread_t
) -1;
9543 /* Preload keys needed for the ZUNION and ZINTER commands. */
9544 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
) {
9546 num
= atoi(c
->argv
[2]->ptr
);
9547 for (i
= 0; i
< num
; i
++) {
9548 waitForSwappedKey(c
,c
->argv
[3+i
]);
9552 /* Is this client attempting to run a command against swapped keys?
9553 * If so, block it ASAP, load the keys in background, then resume it.
9555 * The important idea about this function is that it can fail! If keys will
9556 * still be swapped when the client is resumed, this key lookups will
9557 * just block loading keys from disk. In practical terms this should only
9558 * happen with SORT BY command or if there is a bug in this function.
9560 * Return 1 if the client is marked as blocked, 0 if the client can
9561 * continue as the keys it is going to access appear to be in memory. */
9562 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
) {
9565 if (cmd
->vm_preload_proc
!= NULL
) {
9566 cmd
->vm_preload_proc(c
);
9568 if (cmd
->vm_firstkey
== 0) return 0;
9569 last
= cmd
->vm_lastkey
;
9570 if (last
< 0) last
= c
->argc
+last
;
9571 for (j
= cmd
->vm_firstkey
; j
<= last
; j
+= cmd
->vm_keystep
)
9572 waitForSwappedKey(c
,c
->argv
[j
]);
9575 /* If the client was blocked for at least one key, mark it as blocked. */
9576 if (listLength(c
->io_keys
)) {
9577 c
->flags
|= REDIS_IO_WAIT
;
9578 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
9579 server
.vm_blocked_clients
++;
9586 /* Remove the 'key' from the list of blocked keys for a given client.
9588 * The function returns 1 when there are no longer blocking keys after
9589 * the current one was removed (and the client can be unblocked). */
9590 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
) {
9594 struct dictEntry
*de
;
9596 /* Remove the key from the list of keys this client is waiting for. */
9597 listRewind(c
->io_keys
,&li
);
9598 while ((ln
= listNext(&li
)) != NULL
) {
9599 if (compareStringObjects(ln
->value
,key
) == 0) {
9600 listDelNode(c
->io_keys
,ln
);
9606 /* Remove the client form the key => waiting clients map. */
9607 de
= dictFind(c
->db
->io_keys
,key
);
9609 l
= dictGetEntryVal(de
);
9610 ln
= listSearchKey(l
,c
);
9613 if (listLength(l
) == 0)
9614 dictDelete(c
->db
->io_keys
,key
);
9616 return listLength(c
->io_keys
) == 0;
9619 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
) {
9620 struct dictEntry
*de
;
9625 de
= dictFind(db
->io_keys
,key
);
9628 l
= dictGetEntryVal(de
);
9629 len
= listLength(l
);
9630 /* Note: we can't use something like while(listLength(l)) as the list
9631 * can be freed by the calling function when we remove the last element. */
9634 redisClient
*c
= ln
->value
;
9636 if (dontWaitForSwappedKey(c
,key
)) {
9637 /* Put the client in the list of clients ready to go as we
9638 * loaded all the keys about it. */
9639 listAddNodeTail(server
.io_ready_clients
,c
);
9644 /* =========================== Remote Configuration ========================= */
9646 static void configSetCommand(redisClient
*c
) {
9647 robj
*o
= getDecodedObject(c
->argv
[3]);
9648 if (!strcasecmp(c
->argv
[2]->ptr
,"dbfilename")) {
9649 zfree(server
.dbfilename
);
9650 server
.dbfilename
= zstrdup(o
->ptr
);
9651 } else if (!strcasecmp(c
->argv
[2]->ptr
,"requirepass")) {
9652 zfree(server
.requirepass
);
9653 server
.requirepass
= zstrdup(o
->ptr
);
9654 } else if (!strcasecmp(c
->argv
[2]->ptr
,"masterauth")) {
9655 zfree(server
.masterauth
);
9656 server
.masterauth
= zstrdup(o
->ptr
);
9657 } else if (!strcasecmp(c
->argv
[2]->ptr
,"maxmemory")) {
9658 server
.maxmemory
= strtoll(o
->ptr
, NULL
, 10);
9660 addReplySds(c
,sdscatprintf(sdsempty(),
9661 "-ERR not supported CONFIG parameter %s\r\n",
9662 (char*)c
->argv
[2]->ptr
));
9667 addReply(c
,shared
.ok
);
9670 static void configGetCommand(redisClient
*c
) {
9671 robj
*o
= getDecodedObject(c
->argv
[2]);
9672 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
9673 char *pattern
= o
->ptr
;
9677 decrRefCount(lenobj
);
9679 if (stringmatch(pattern
,"dbfilename",0)) {
9680 addReplyBulkCString(c
,"dbfilename");
9681 addReplyBulkCString(c
,server
.dbfilename
);
9684 if (stringmatch(pattern
,"requirepass",0)) {
9685 addReplyBulkCString(c
,"requirepass");
9686 addReplyBulkCString(c
,server
.requirepass
);
9689 if (stringmatch(pattern
,"masterauth",0)) {
9690 addReplyBulkCString(c
,"masterauth");
9691 addReplyBulkCString(c
,server
.masterauth
);
9694 if (stringmatch(pattern
,"maxmemory",0)) {
9697 snprintf(buf
,128,"%llu\n",server
.maxmemory
);
9698 addReplyBulkCString(c
,"maxmemory");
9699 addReplyBulkCString(c
,buf
);
9703 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%d\r\n",matches
*2);
9706 static void configCommand(redisClient
*c
) {
9707 if (!strcasecmp(c
->argv
[1]->ptr
,"set")) {
9708 if (c
->argc
!= 4) goto badarity
;
9709 configSetCommand(c
);
9710 } else if (!strcasecmp(c
->argv
[1]->ptr
,"get")) {
9711 if (c
->argc
!= 3) goto badarity
;
9712 configGetCommand(c
);
9713 } else if (!strcasecmp(c
->argv
[1]->ptr
,"resetstat")) {
9714 if (c
->argc
!= 2) goto badarity
;
9715 server
.stat_numcommands
= 0;
9716 server
.stat_numconnections
= 0;
9717 server
.stat_expiredkeys
= 0;
9718 server
.stat_starttime
= time(NULL
);
9719 addReply(c
,shared
.ok
);
9721 addReplySds(c
,sdscatprintf(sdsempty(),
9722 "-ERR CONFIG subcommand must be one of GET, SET, RESETSTAT\r\n"));
9727 addReplySds(c
,sdscatprintf(sdsempty(),
9728 "-ERR Wrong number of arguments for CONFIG %s\r\n",
9729 (char*) c
->argv
[1]->ptr
));
9732 /* =========================== Pubsub implementation ======================== */
9734 static void freePubsubPattern(void *p
) {
9735 pubsubPattern
*pat
= p
;
9737 decrRefCount(pat
->pattern
);
9741 static int listMatchPubsubPattern(void *a
, void *b
) {
9742 pubsubPattern
*pa
= a
, *pb
= b
;
9744 return (pa
->client
== pb
->client
) &&
9745 (compareStringObjects(pa
->pattern
,pb
->pattern
) == 0);
9748 /* Subscribe a client to a channel. Returns 1 if the operation succeeded, or
9749 * 0 if the client was already subscribed to that channel. */
9750 static int pubsubSubscribeChannel(redisClient
*c
, robj
*channel
) {
9751 struct dictEntry
*de
;
9752 list
*clients
= NULL
;
9755 /* Add the channel to the client -> channels hash table */
9756 if (dictAdd(c
->pubsub_channels
,channel
,NULL
) == DICT_OK
) {
9758 incrRefCount(channel
);
9759 /* Add the client to the channel -> list of clients hash table */
9760 de
= dictFind(server
.pubsub_channels
,channel
);
9762 clients
= listCreate();
9763 dictAdd(server
.pubsub_channels
,channel
,clients
);
9764 incrRefCount(channel
);
9766 clients
= dictGetEntryVal(de
);
9768 listAddNodeTail(clients
,c
);
9770 /* Notify the client */
9771 addReply(c
,shared
.mbulk3
);
9772 addReply(c
,shared
.subscribebulk
);
9773 addReplyBulk(c
,channel
);
9774 addReplyLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
9778 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9779 * 0 if the client was not subscribed to the specified channel. */
9780 static int pubsubUnsubscribeChannel(redisClient
*c
, robj
*channel
, int notify
) {
9781 struct dictEntry
*de
;
9786 /* Remove the channel from the client -> channels hash table */
9787 incrRefCount(channel
); /* channel may be just a pointer to the same object
9788 we have in the hash tables. Protect it... */
9789 if (dictDelete(c
->pubsub_channels
,channel
) == DICT_OK
) {
9791 /* Remove the client from the channel -> clients list hash table */
9792 de
= dictFind(server
.pubsub_channels
,channel
);
9794 clients
= dictGetEntryVal(de
);
9795 ln
= listSearchKey(clients
,c
);
9797 listDelNode(clients
,ln
);
9798 if (listLength(clients
) == 0) {
9799 /* Free the list and associated hash entry at all if this was
9800 * the latest client, so that it will be possible to abuse
9801 * Redis PUBSUB creating millions of channels. */
9802 dictDelete(server
.pubsub_channels
,channel
);
9805 /* Notify the client */
9807 addReply(c
,shared
.mbulk3
);
9808 addReply(c
,shared
.unsubscribebulk
);
9809 addReplyBulk(c
,channel
);
9810 addReplyLong(c
,dictSize(c
->pubsub_channels
)+
9811 listLength(c
->pubsub_patterns
));
9814 decrRefCount(channel
); /* it is finally safe to release it */
9818 /* Subscribe a client to a pattern. Returns 1 if the operation succeeded, or 0 if the clinet was already subscribed to that pattern. */
9819 static int pubsubSubscribePattern(redisClient
*c
, robj
*pattern
) {
9822 if (listSearchKey(c
->pubsub_patterns
,pattern
) == NULL
) {
9825 listAddNodeTail(c
->pubsub_patterns
,pattern
);
9826 incrRefCount(pattern
);
9827 pat
= zmalloc(sizeof(*pat
));
9828 pat
->pattern
= getDecodedObject(pattern
);
9830 listAddNodeTail(server
.pubsub_patterns
,pat
);
9832 /* Notify the client */
9833 addReply(c
,shared
.mbulk3
);
9834 addReply(c
,shared
.psubscribebulk
);
9835 addReplyBulk(c
,pattern
);
9836 addReplyLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
9840 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9841 * 0 if the client was not subscribed to the specified channel. */
9842 static int pubsubUnsubscribePattern(redisClient
*c
, robj
*pattern
, int notify
) {
9847 incrRefCount(pattern
); /* Protect the object. May be the same we remove */
9848 if ((ln
= listSearchKey(c
->pubsub_patterns
,pattern
)) != NULL
) {
9850 listDelNode(c
->pubsub_patterns
,ln
);
9852 pat
.pattern
= pattern
;
9853 ln
= listSearchKey(server
.pubsub_patterns
,&pat
);
9854 listDelNode(server
.pubsub_patterns
,ln
);
9856 /* Notify the client */
9858 addReply(c
,shared
.mbulk3
);
9859 addReply(c
,shared
.punsubscribebulk
);
9860 addReplyBulk(c
,pattern
);
9861 addReplyLong(c
,dictSize(c
->pubsub_channels
)+
9862 listLength(c
->pubsub_patterns
));
9864 decrRefCount(pattern
);
9868 /* Unsubscribe from all the channels. Return the number of channels the
9869 * client was subscribed from. */
9870 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
) {
9871 dictIterator
*di
= dictGetIterator(c
->pubsub_channels
);
9875 while((de
= dictNext(di
)) != NULL
) {
9876 robj
*channel
= dictGetEntryKey(de
);
9878 count
+= pubsubUnsubscribeChannel(c
,channel
,notify
);
9880 dictReleaseIterator(di
);
9884 /* Unsubscribe from all the patterns. Return the number of patterns the
9885 * client was subscribed from. */
9886 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
) {
9891 listRewind(c
->pubsub_patterns
,&li
);
9892 while ((ln
= listNext(&li
)) != NULL
) {
9893 robj
*pattern
= ln
->value
;
9895 count
+= pubsubUnsubscribePattern(c
,pattern
,notify
);
9900 /* Publish a message */
9901 static int pubsubPublishMessage(robj
*channel
, robj
*message
) {
9903 struct dictEntry
*de
;
9907 /* Send to clients listening for that channel */
9908 de
= dictFind(server
.pubsub_channels
,channel
);
9910 list
*list
= dictGetEntryVal(de
);
9914 listRewind(list
,&li
);
9915 while ((ln
= listNext(&li
)) != NULL
) {
9916 redisClient
*c
= ln
->value
;
9918 addReply(c
,shared
.mbulk3
);
9919 addReply(c
,shared
.messagebulk
);
9920 addReplyBulk(c
,channel
);
9921 addReplyBulk(c
,message
);
9925 /* Send to clients listening to matching channels */
9926 if (listLength(server
.pubsub_patterns
)) {
9927 listRewind(server
.pubsub_patterns
,&li
);
9928 channel
= getDecodedObject(channel
);
9929 while ((ln
= listNext(&li
)) != NULL
) {
9930 pubsubPattern
*pat
= ln
->value
;
9932 if (stringmatchlen((char*)pat
->pattern
->ptr
,
9933 sdslen(pat
->pattern
->ptr
),
9934 (char*)channel
->ptr
,
9935 sdslen(channel
->ptr
),0)) {
9936 addReply(pat
->client
,shared
.mbulk4
);
9937 addReply(pat
->client
,shared
.pmessagebulk
);
9938 addReplyBulk(pat
->client
,pat
->pattern
);
9939 addReplyBulk(pat
->client
,channel
);
9940 addReplyBulk(pat
->client
,message
);
9944 decrRefCount(channel
);
9949 static void subscribeCommand(redisClient
*c
) {
9952 for (j
= 1; j
< c
->argc
; j
++)
9953 pubsubSubscribeChannel(c
,c
->argv
[j
]);
9956 static void unsubscribeCommand(redisClient
*c
) {
9958 pubsubUnsubscribeAllChannels(c
,1);
9963 for (j
= 1; j
< c
->argc
; j
++)
9964 pubsubUnsubscribeChannel(c
,c
->argv
[j
],1);
9968 static void psubscribeCommand(redisClient
*c
) {
9971 for (j
= 1; j
< c
->argc
; j
++)
9972 pubsubSubscribePattern(c
,c
->argv
[j
]);
9975 static void punsubscribeCommand(redisClient
*c
) {
9977 pubsubUnsubscribeAllPatterns(c
,1);
9982 for (j
= 1; j
< c
->argc
; j
++)
9983 pubsubUnsubscribePattern(c
,c
->argv
[j
],1);
9987 static void publishCommand(redisClient
*c
) {
9988 int receivers
= pubsubPublishMessage(c
->argv
[1],c
->argv
[2]);
9989 addReplyLong(c
,receivers
);
9992 /* ================================= Debugging ============================== */
9994 static void debugCommand(redisClient
*c
) {
9995 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
9997 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
9998 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
9999 addReply(c
,shared
.err
);
10003 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
10004 addReply(c
,shared
.err
);
10007 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
10008 addReply(c
,shared
.ok
);
10009 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
10011 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
10012 addReply(c
,shared
.err
);
10015 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
10016 addReply(c
,shared
.ok
);
10017 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
10018 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
10022 addReply(c
,shared
.nokeyerr
);
10025 key
= dictGetEntryKey(de
);
10026 val
= dictGetEntryVal(de
);
10027 if (!server
.vm_enabled
|| (key
->storage
== REDIS_VM_MEMORY
||
10028 key
->storage
== REDIS_VM_SWAPPING
)) {
10032 if (val
->encoding
< (sizeof(strencoding
)/sizeof(char*))) {
10033 strenc
= strencoding
[val
->encoding
];
10035 snprintf(buf
,64,"unknown encoding %d\n", val
->encoding
);
10038 addReplySds(c
,sdscatprintf(sdsempty(),
10039 "+Key at:%p refcount:%d, value at:%p refcount:%d "
10040 "encoding:%s serializedlength:%lld\r\n",
10041 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
10042 strenc
, (long long) rdbSavedObjectLen(val
,NULL
)));
10044 addReplySds(c
,sdscatprintf(sdsempty(),
10045 "+Key at:%p refcount:%d, value swapped at: page %llu "
10046 "using %llu pages\r\n",
10047 (void*)key
, key
->refcount
, (unsigned long long) key
->vm
.page
,
10048 (unsigned long long) key
->vm
.usedpages
));
10050 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapin") && c
->argc
== 3) {
10051 lookupKeyRead(c
->db
,c
->argv
[2]);
10052 addReply(c
,shared
.ok
);
10053 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
10054 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
10057 if (!server
.vm_enabled
) {
10058 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
10062 addReply(c
,shared
.nokeyerr
);
10065 key
= dictGetEntryKey(de
);
10066 val
= dictGetEntryVal(de
);
10067 /* If the key is shared we want to create a copy */
10068 if (key
->refcount
> 1) {
10069 robj
*newkey
= dupStringObject(key
);
10071 key
= dictGetEntryKey(de
) = newkey
;
10074 if (key
->storage
!= REDIS_VM_MEMORY
) {
10075 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
10076 } else if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
10077 dictGetEntryVal(de
) = NULL
;
10078 addReply(c
,shared
.ok
);
10080 addReply(c
,shared
.err
);
10083 addReplySds(c
,sdsnew(
10084 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPIN <key>|SWAPOUT <key>|RELOAD]\r\n"));
10088 static void _redisAssert(char *estr
, char *file
, int line
) {
10089 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
10090 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true\n",file
,line
,estr
);
10091 #ifdef HAVE_BACKTRACE
10092 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
10093 *((char*)-1) = 'x';
10097 static void _redisPanic(char *msg
, char *file
, int line
) {
10098 redisLog(REDIS_WARNING
,"!!! Software Failure. Press left mouse button to continue");
10099 redisLog(REDIS_WARNING
,"Guru Meditation: %s #%s:%d",msg
,file
,line
);
10100 #ifdef HAVE_BACKTRACE
10101 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
10102 *((char*)-1) = 'x';
10106 /* =================================== Main! ================================ */
10109 int linuxOvercommitMemoryValue(void) {
10110 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
10113 if (!fp
) return -1;
10114 if (fgets(buf
,64,fp
) == NULL
) {
10123 void linuxOvercommitMemoryWarning(void) {
10124 if (linuxOvercommitMemoryValue() == 0) {
10125 redisLog(REDIS_WARNING
,"WARNING overcommit_memory is set to 0! Background save may fail under low memory condition. To fix this issue add 'vm.overcommit_memory = 1' to /etc/sysctl.conf and then reboot or run the command 'sysctl vm.overcommit_memory=1' for this to take effect.");
10128 #endif /* __linux__ */
10130 static void daemonize(void) {
10134 if (fork() != 0) exit(0); /* parent exits */
10135 setsid(); /* create a new session */
10137 /* Every output goes to /dev/null. If Redis is daemonized but
10138 * the 'logfile' is set to 'stdout' in the configuration file
10139 * it will not log at all. */
10140 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
10141 dup2(fd
, STDIN_FILENO
);
10142 dup2(fd
, STDOUT_FILENO
);
10143 dup2(fd
, STDERR_FILENO
);
10144 if (fd
> STDERR_FILENO
) close(fd
);
10146 /* Try to write the pid file */
10147 fp
= fopen(server
.pidfile
,"w");
10149 fprintf(fp
,"%d\n",getpid());
10154 static void version() {
10155 printf("Redis server version %s\n", REDIS_VERSION
);
10159 static void usage() {
10160 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
10161 fprintf(stderr
," ./redis-server - (read config from stdin)\n");
10165 int main(int argc
, char **argv
) {
10168 initServerConfig();
10170 if (strcmp(argv
[1], "-v") == 0 ||
10171 strcmp(argv
[1], "--version") == 0) version();
10172 if (strcmp(argv
[1], "--help") == 0) usage();
10173 resetServerSaveParams();
10174 loadServerConfig(argv
[1]);
10175 } else if ((argc
> 2)) {
10178 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'");
10180 if (server
.daemonize
) daemonize();
10182 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
10184 linuxOvercommitMemoryWarning();
10186 start
= time(NULL
);
10187 if (server
.appendonly
) {
10188 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
10189 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %ld seconds",time(NULL
)-start
);
10191 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
10192 redisLog(REDIS_NOTICE
,"DB loaded from disk: %ld seconds",time(NULL
)-start
);
10194 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
10195 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
10197 aeDeleteEventLoop(server
.el
);
10201 /* ============================= Backtrace support ========================= */
10203 #ifdef HAVE_BACKTRACE
10204 static char *findFuncName(void *pointer
, unsigned long *offset
);
10206 static void *getMcontextEip(ucontext_t
*uc
) {
10207 #if defined(__FreeBSD__)
10208 return (void*) uc
->uc_mcontext
.mc_eip
;
10209 #elif defined(__dietlibc__)
10210 return (void*) uc
->uc_mcontext
.eip
;
10211 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
10213 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
10215 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
10217 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
10218 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
10219 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
10221 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
10223 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
10224 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
10225 #elif defined(__ia64__) /* Linux IA64 */
10226 return (void*) uc
->uc_mcontext
.sc_ip
;
10232 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
10234 char **messages
= NULL
;
10235 int i
, trace_size
= 0;
10236 unsigned long offset
=0;
10237 ucontext_t
*uc
= (ucontext_t
*) secret
;
10239 REDIS_NOTUSED(info
);
10241 redisLog(REDIS_WARNING
,
10242 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
10243 infostring
= genRedisInfoString();
10244 redisLog(REDIS_WARNING
, "%s",infostring
);
10245 /* It's not safe to sdsfree() the returned string under memory
10246 * corruption conditions. Let it leak as we are going to abort */
10248 trace_size
= backtrace(trace
, 100);
10249 /* overwrite sigaction with caller's address */
10250 if (getMcontextEip(uc
) != NULL
) {
10251 trace
[1] = getMcontextEip(uc
);
10253 messages
= backtrace_symbols(trace
, trace_size
);
10255 for (i
=1; i
<trace_size
; ++i
) {
10256 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
10258 p
= strchr(messages
[i
],'+');
10259 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
10260 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
10262 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
10265 /* free(messages); Don't call free() with possibly corrupted memory. */
10269 static void setupSigSegvAction(void) {
10270 struct sigaction act
;
10272 sigemptyset (&act
.sa_mask
);
10273 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
10274 * is used. Otherwise, sa_handler is used */
10275 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
10276 act
.sa_sigaction
= segvHandler
;
10277 sigaction (SIGSEGV
, &act
, NULL
);
10278 sigaction (SIGBUS
, &act
, NULL
);
10279 sigaction (SIGFPE
, &act
, NULL
);
10280 sigaction (SIGILL
, &act
, NULL
);
10281 sigaction (SIGBUS
, &act
, NULL
);
10285 #include "staticsymbols.h"
10286 /* This function try to convert a pointer into a function name. It's used in
10287 * oreder to provide a backtrace under segmentation fault that's able to
10288 * display functions declared as static (otherwise the backtrace is useless). */
10289 static char *findFuncName(void *pointer
, unsigned long *offset
){
10291 unsigned long off
, minoff
= 0;
10293 /* Try to match against the Symbol with the smallest offset */
10294 for (i
=0; symsTable
[i
].pointer
; i
++) {
10295 unsigned long lp
= (unsigned long) pointer
;
10297 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
10298 off
=lp
-symsTable
[i
].pointer
;
10299 if (ret
< 0 || off
< minoff
) {
10305 if (ret
== -1) return NULL
;
10307 return symsTable
[ret
].name
;
10309 #else /* HAVE_BACKTRACE */
10310 static void setupSigSegvAction(void) {
10312 #endif /* HAVE_BACKTRACE */