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 typedef void redisVmPreloadProc(redisClient
*c
, struct redisCommand
*cmd
, int argc
, robj
**argv
);
454 struct redisCommand
{
456 redisCommandProc
*proc
;
459 /* Use a function to determine which keys need to be loaded
460 * in the background prior to executing this command. Takes precedence
461 * over vm_firstkey and others, ignored when NULL */
462 redisVmPreloadProc
*vm_preload_proc
;
463 /* What keys should be loaded in background when calling this command? */
464 int vm_firstkey
; /* The first argument that's a key (0 = no keys) */
465 int vm_lastkey
; /* THe last argument that's a key */
466 int vm_keystep
; /* The step between first and last key */
469 struct redisFunctionSym
{
471 unsigned long pointer
;
474 typedef struct _redisSortObject
{
482 typedef struct _redisSortOperation
{
485 } redisSortOperation
;
487 /* ZSETs use a specialized version of Skiplists */
489 typedef struct zskiplistNode
{
490 struct zskiplistNode
**forward
;
491 struct zskiplistNode
*backward
;
497 typedef struct zskiplist
{
498 struct zskiplistNode
*header
, *tail
;
499 unsigned long length
;
503 typedef struct zset
{
508 /* Our shared "common" objects */
510 #define REDIS_SHARED_INTEGERS 10000
511 struct sharedObjectsStruct
{
512 robj
*crlf
, *ok
, *err
, *emptybulk
, *czero
, *cone
, *pong
, *space
,
513 *colon
, *nullbulk
, *nullmultibulk
, *queued
,
514 *emptymultibulk
, *wrongtypeerr
, *nokeyerr
, *syntaxerr
, *sameobjecterr
,
515 *outofrangeerr
, *plus
,
516 *select0
, *select1
, *select2
, *select3
, *select4
,
517 *select5
, *select6
, *select7
, *select8
, *select9
,
518 *messagebulk
, *pmessagebulk
, *subscribebulk
, *unsubscribebulk
, *mbulk3
,
519 *mbulk4
, *psubscribebulk
, *punsubscribebulk
,
520 *integers
[REDIS_SHARED_INTEGERS
];
523 /* Global vars that are actally used as constants. The following double
524 * values are used for double on-disk serialization, and are initialized
525 * at runtime to avoid strange compiler optimizations. */
527 static double R_Zero
, R_PosInf
, R_NegInf
, R_Nan
;
529 /* VM threaded I/O request message */
530 #define REDIS_IOJOB_LOAD 0 /* Load from disk to memory */
531 #define REDIS_IOJOB_PREPARE_SWAP 1 /* Compute needed pages */
532 #define REDIS_IOJOB_DO_SWAP 2 /* Swap from memory to disk */
533 typedef struct iojob
{
534 int type
; /* Request type, REDIS_IOJOB_* */
535 redisDb
*db
;/* Redis database */
536 robj
*key
; /* This I/O request is about swapping this key */
537 robj
*val
; /* the value to swap for REDIS_IOREQ_*_SWAP, otherwise this
538 * field is populated by the I/O thread for REDIS_IOREQ_LOAD. */
539 off_t page
; /* Swap page where to read/write the object */
540 off_t pages
; /* Swap pages needed to save object. PREPARE_SWAP return val */
541 int canceled
; /* True if this command was canceled by blocking side of VM */
542 pthread_t thread
; /* ID of the thread processing this entry */
545 /*================================ Prototypes =============================== */
547 static void freeStringObject(robj
*o
);
548 static void freeListObject(robj
*o
);
549 static void freeSetObject(robj
*o
);
550 static void decrRefCount(void *o
);
551 static robj
*createObject(int type
, void *ptr
);
552 static void freeClient(redisClient
*c
);
553 static int rdbLoad(char *filename
);
554 static void addReply(redisClient
*c
, robj
*obj
);
555 static void addReplySds(redisClient
*c
, sds s
);
556 static void incrRefCount(robj
*o
);
557 static int rdbSaveBackground(char *filename
);
558 static robj
*createStringObject(char *ptr
, size_t len
);
559 static robj
*dupStringObject(robj
*o
);
560 static void replicationFeedSlaves(list
*slaves
, int dictid
, robj
**argv
, int argc
);
561 static void replicationFeedMonitors(list
*monitors
, int dictid
, robj
**argv
, int argc
);
562 static void flushAppendOnlyFile(void);
563 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
564 static int syncWithMaster(void);
565 static robj
*tryObjectEncoding(robj
*o
);
566 static robj
*getDecodedObject(robj
*o
);
567 static int removeExpire(redisDb
*db
, robj
*key
);
568 static int expireIfNeeded(redisDb
*db
, robj
*key
);
569 static int deleteIfVolatile(redisDb
*db
, robj
*key
);
570 static int deleteIfSwapped(redisDb
*db
, robj
*key
);
571 static int deleteKey(redisDb
*db
, robj
*key
);
572 static time_t getExpire(redisDb
*db
, robj
*key
);
573 static int setExpire(redisDb
*db
, robj
*key
, time_t when
);
574 static void updateSlavesWaitingBgsave(int bgsaveerr
);
575 static void freeMemoryIfNeeded(void);
576 static int processCommand(redisClient
*c
);
577 static void setupSigSegvAction(void);
578 static void rdbRemoveTempFile(pid_t childpid
);
579 static void aofRemoveTempFile(pid_t childpid
);
580 static size_t stringObjectLen(robj
*o
);
581 static void processInputBuffer(redisClient
*c
);
582 static zskiplist
*zslCreate(void);
583 static void zslFree(zskiplist
*zsl
);
584 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
);
585 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
586 static void initClientMultiState(redisClient
*c
);
587 static void freeClientMultiState(redisClient
*c
);
588 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
);
589 static void unblockClientWaitingData(redisClient
*c
);
590 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
);
591 static void vmInit(void);
592 static void vmMarkPagesFree(off_t page
, off_t count
);
593 static robj
*vmLoadObject(robj
*key
);
594 static robj
*vmPreviewObject(robj
*key
);
595 static int vmSwapOneObjectBlocking(void);
596 static int vmSwapOneObjectThreaded(void);
597 static int vmCanSwapOut(void);
598 static int tryFreeOneObjectFromFreelist(void);
599 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
600 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
601 static void vmCancelThreadedIOJob(robj
*o
);
602 static void lockThreadedIO(void);
603 static void unlockThreadedIO(void);
604 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
);
605 static void freeIOJob(iojob
*j
);
606 static void queueIOJob(iojob
*j
);
607 static int vmWriteObjectOnSwap(robj
*o
, off_t page
);
608 static robj
*vmReadObjectFromSwap(off_t page
, int type
);
609 static void waitEmptyIOJobsQueue(void);
610 static void vmReopenSwapFile(void);
611 static int vmFreePage(off_t page
);
612 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
, int argc
, robj
**argv
);
613 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
);
614 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
);
615 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
);
616 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
617 static struct redisCommand
*lookupCommand(char *name
);
618 static void call(redisClient
*c
, struct redisCommand
*cmd
);
619 static void resetClient(redisClient
*c
);
620 static void convertToRealHash(robj
*o
);
621 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
);
622 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
);
623 static void freePubsubPattern(void *p
);
624 static int listMatchPubsubPattern(void *a
, void *b
);
625 static int compareStringObjects(robj
*a
, robj
*b
);
627 static int rewriteAppendOnlyFileBackground(void);
629 static void authCommand(redisClient
*c
);
630 static void pingCommand(redisClient
*c
);
631 static void echoCommand(redisClient
*c
);
632 static void setCommand(redisClient
*c
);
633 static void setnxCommand(redisClient
*c
);
634 static void setexCommand(redisClient
*c
);
635 static void getCommand(redisClient
*c
);
636 static void delCommand(redisClient
*c
);
637 static void existsCommand(redisClient
*c
);
638 static void incrCommand(redisClient
*c
);
639 static void decrCommand(redisClient
*c
);
640 static void incrbyCommand(redisClient
*c
);
641 static void decrbyCommand(redisClient
*c
);
642 static void selectCommand(redisClient
*c
);
643 static void randomkeyCommand(redisClient
*c
);
644 static void keysCommand(redisClient
*c
);
645 static void dbsizeCommand(redisClient
*c
);
646 static void lastsaveCommand(redisClient
*c
);
647 static void saveCommand(redisClient
*c
);
648 static void bgsaveCommand(redisClient
*c
);
649 static void bgrewriteaofCommand(redisClient
*c
);
650 static void shutdownCommand(redisClient
*c
);
651 static void moveCommand(redisClient
*c
);
652 static void renameCommand(redisClient
*c
);
653 static void renamenxCommand(redisClient
*c
);
654 static void lpushCommand(redisClient
*c
);
655 static void rpushCommand(redisClient
*c
);
656 static void lpopCommand(redisClient
*c
);
657 static void rpopCommand(redisClient
*c
);
658 static void llenCommand(redisClient
*c
);
659 static void lindexCommand(redisClient
*c
);
660 static void lrangeCommand(redisClient
*c
);
661 static void ltrimCommand(redisClient
*c
);
662 static void typeCommand(redisClient
*c
);
663 static void lsetCommand(redisClient
*c
);
664 static void saddCommand(redisClient
*c
);
665 static void sremCommand(redisClient
*c
);
666 static void smoveCommand(redisClient
*c
);
667 static void sismemberCommand(redisClient
*c
);
668 static void scardCommand(redisClient
*c
);
669 static void spopCommand(redisClient
*c
);
670 static void srandmemberCommand(redisClient
*c
);
671 static void sinterCommand(redisClient
*c
);
672 static void sinterstoreCommand(redisClient
*c
);
673 static void sunionCommand(redisClient
*c
);
674 static void sunionstoreCommand(redisClient
*c
);
675 static void sdiffCommand(redisClient
*c
);
676 static void sdiffstoreCommand(redisClient
*c
);
677 static void syncCommand(redisClient
*c
);
678 static void flushdbCommand(redisClient
*c
);
679 static void flushallCommand(redisClient
*c
);
680 static void sortCommand(redisClient
*c
);
681 static void lremCommand(redisClient
*c
);
682 static void rpoplpushcommand(redisClient
*c
);
683 static void infoCommand(redisClient
*c
);
684 static void mgetCommand(redisClient
*c
);
685 static void monitorCommand(redisClient
*c
);
686 static void expireCommand(redisClient
*c
);
687 static void expireatCommand(redisClient
*c
);
688 static void getsetCommand(redisClient
*c
);
689 static void ttlCommand(redisClient
*c
);
690 static void slaveofCommand(redisClient
*c
);
691 static void debugCommand(redisClient
*c
);
692 static void msetCommand(redisClient
*c
);
693 static void msetnxCommand(redisClient
*c
);
694 static void zaddCommand(redisClient
*c
);
695 static void zincrbyCommand(redisClient
*c
);
696 static void zrangeCommand(redisClient
*c
);
697 static void zrangebyscoreCommand(redisClient
*c
);
698 static void zcountCommand(redisClient
*c
);
699 static void zrevrangeCommand(redisClient
*c
);
700 static void zcardCommand(redisClient
*c
);
701 static void zremCommand(redisClient
*c
);
702 static void zscoreCommand(redisClient
*c
);
703 static void zremrangebyscoreCommand(redisClient
*c
);
704 static void multiCommand(redisClient
*c
);
705 static void execCommand(redisClient
*c
);
706 static void discardCommand(redisClient
*c
);
707 static void blpopCommand(redisClient
*c
);
708 static void brpopCommand(redisClient
*c
);
709 static void appendCommand(redisClient
*c
);
710 static void substrCommand(redisClient
*c
);
711 static void zrankCommand(redisClient
*c
);
712 static void zrevrankCommand(redisClient
*c
);
713 static void hsetCommand(redisClient
*c
);
714 static void hsetnxCommand(redisClient
*c
);
715 static void hgetCommand(redisClient
*c
);
716 static void hmsetCommand(redisClient
*c
);
717 static void hmgetCommand(redisClient
*c
);
718 static void hdelCommand(redisClient
*c
);
719 static void hlenCommand(redisClient
*c
);
720 static void zremrangebyrankCommand(redisClient
*c
);
721 static void zunionCommand(redisClient
*c
);
722 static void zinterCommand(redisClient
*c
);
723 static void hkeysCommand(redisClient
*c
);
724 static void hvalsCommand(redisClient
*c
);
725 static void hgetallCommand(redisClient
*c
);
726 static void hexistsCommand(redisClient
*c
);
727 static void configCommand(redisClient
*c
);
728 static void hincrbyCommand(redisClient
*c
);
729 static void subscribeCommand(redisClient
*c
);
730 static void unsubscribeCommand(redisClient
*c
);
731 static void psubscribeCommand(redisClient
*c
);
732 static void punsubscribeCommand(redisClient
*c
);
733 static void publishCommand(redisClient
*c
);
735 /*================================= Globals ================================= */
738 static struct redisServer server
; /* server global state */
739 static struct redisCommand cmdTable
[] = {
740 {"get",getCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
741 {"set",setCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
742 {"setnx",setnxCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
743 {"setex",setexCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
744 {"append",appendCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
745 {"substr",substrCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
746 {"del",delCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
747 {"exists",existsCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
748 {"incr",incrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
749 {"decr",decrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
750 {"mget",mgetCommand
,-2,REDIS_CMD_INLINE
,NULL
,1,-1,1},
751 {"rpush",rpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
752 {"lpush",lpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
753 {"rpop",rpopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
754 {"lpop",lpopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
755 {"brpop",brpopCommand
,-3,REDIS_CMD_INLINE
,NULL
,1,1,1},
756 {"blpop",blpopCommand
,-3,REDIS_CMD_INLINE
,NULL
,1,1,1},
757 {"llen",llenCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
758 {"lindex",lindexCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
759 {"lset",lsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
760 {"lrange",lrangeCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
761 {"ltrim",ltrimCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
762 {"lrem",lremCommand
,4,REDIS_CMD_BULK
,NULL
,1,1,1},
763 {"rpoplpush",rpoplpushcommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,2,1},
764 {"sadd",saddCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
765 {"srem",sremCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
766 {"smove",smoveCommand
,4,REDIS_CMD_BULK
,NULL
,1,2,1},
767 {"sismember",sismemberCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
768 {"scard",scardCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
769 {"spop",spopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
770 {"srandmember",srandmemberCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
771 {"sinter",sinterCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
772 {"sinterstore",sinterstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
773 {"sunion",sunionCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
774 {"sunionstore",sunionstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
775 {"sdiff",sdiffCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
776 {"sdiffstore",sdiffstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
777 {"smembers",sinterCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
778 {"zadd",zaddCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
779 {"zincrby",zincrbyCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
780 {"zrem",zremCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
781 {"zremrangebyscore",zremrangebyscoreCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
782 {"zremrangebyrank",zremrangebyrankCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
783 {"zunion",zunionCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,zunionInterBlockClientOnSwappedKeys
,0,0,0},
784 {"zinter",zinterCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,zunionInterBlockClientOnSwappedKeys
,0,0,0},
785 {"zrange",zrangeCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
786 {"zrangebyscore",zrangebyscoreCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
787 {"zcount",zcountCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
788 {"zrevrange",zrevrangeCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
789 {"zcard",zcardCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
790 {"zscore",zscoreCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
791 {"zrank",zrankCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
792 {"zrevrank",zrevrankCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
793 {"hset",hsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
794 {"hsetnx",hsetnxCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
795 {"hget",hgetCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
796 {"hmset",hmsetCommand
,-4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
797 {"hmget",hmgetCommand
,-3,REDIS_CMD_BULK
,NULL
,1,1,1},
798 {"hincrby",hincrbyCommand
,4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
799 {"hdel",hdelCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
800 {"hlen",hlenCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
801 {"hkeys",hkeysCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
802 {"hvals",hvalsCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
803 {"hgetall",hgetallCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
804 {"hexists",hexistsCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
805 {"incrby",incrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
806 {"decrby",decrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
807 {"getset",getsetCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
808 {"mset",msetCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,-1,2},
809 {"msetnx",msetnxCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,-1,2},
810 {"randomkey",randomkeyCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
811 {"select",selectCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
812 {"move",moveCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
813 {"rename",renameCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
814 {"renamenx",renamenxCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
815 {"expire",expireCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
816 {"expireat",expireatCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
817 {"keys",keysCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
818 {"dbsize",dbsizeCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
819 {"auth",authCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
820 {"ping",pingCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
821 {"echo",echoCommand
,2,REDIS_CMD_BULK
,NULL
,0,0,0},
822 {"save",saveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
823 {"bgsave",bgsaveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
824 {"bgrewriteaof",bgrewriteaofCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
825 {"shutdown",shutdownCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
826 {"lastsave",lastsaveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
827 {"type",typeCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
828 {"multi",multiCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
829 {"exec",execCommand
,1,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
830 {"discard",discardCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
831 {"sync",syncCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
832 {"flushdb",flushdbCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
833 {"flushall",flushallCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
834 {"sort",sortCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
835 {"info",infoCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
836 {"monitor",monitorCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
837 {"ttl",ttlCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
838 {"slaveof",slaveofCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
839 {"debug",debugCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
840 {"config",configCommand
,-2,REDIS_CMD_BULK
,NULL
,0,0,0},
841 {"subscribe",subscribeCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
842 {"unsubscribe",unsubscribeCommand
,-1,REDIS_CMD_INLINE
,NULL
,0,0,0},
843 {"psubscribe",psubscribeCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
844 {"punsubscribe",punsubscribeCommand
,-1,REDIS_CMD_INLINE
,NULL
,0,0,0},
845 {"publish",publishCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_FORCE_REPLICATION
,NULL
,0,0,0},
846 {NULL
,NULL
,0,0,NULL
,0,0,0}
849 /*============================ Utility functions ============================ */
851 /* Glob-style pattern matching. */
852 static int stringmatchlen(const char *pattern
, int patternLen
,
853 const char *string
, int stringLen
, int nocase
)
858 while (pattern
[1] == '*') {
863 return 1; /* match */
865 if (stringmatchlen(pattern
+1, patternLen
-1,
866 string
, stringLen
, nocase
))
867 return 1; /* match */
871 return 0; /* no match */
875 return 0; /* no match */
885 not = pattern
[0] == '^';
892 if (pattern
[0] == '\\') {
895 if (pattern
[0] == string
[0])
897 } else if (pattern
[0] == ']') {
899 } else if (patternLen
== 0) {
903 } else if (pattern
[1] == '-' && patternLen
>= 3) {
904 int start
= pattern
[0];
905 int end
= pattern
[2];
913 start
= tolower(start
);
919 if (c
>= start
&& c
<= end
)
923 if (pattern
[0] == string
[0])
926 if (tolower((int)pattern
[0]) == tolower((int)string
[0]))
936 return 0; /* no match */
942 if (patternLen
>= 2) {
949 if (pattern
[0] != string
[0])
950 return 0; /* no match */
952 if (tolower((int)pattern
[0]) != tolower((int)string
[0]))
953 return 0; /* no match */
961 if (stringLen
== 0) {
962 while(*pattern
== '*') {
969 if (patternLen
== 0 && stringLen
== 0)
974 static int stringmatch(const char *pattern
, const char *string
, int nocase
) {
975 return stringmatchlen(pattern
,strlen(pattern
),string
,strlen(string
),nocase
);
978 /* Convert a string representing an amount of memory into the number of
979 * bytes, so for instance memtoll("1Gi") will return 1073741824 that is
982 * On parsing error, if *err is not NULL, it's set to 1, otherwise it's
984 static long long memtoll(const char *p
, int *err
) {
987 long mul
; /* unit multiplier */
992 /* Search the first non digit character. */
995 while(*u
&& isdigit(*u
)) u
++;
996 if (*u
== '\0' || !strcasecmp(u
,"b")) {
998 } else if (!strcasecmp(u
,"k")) {
1000 } else if (!strcasecmp(u
,"kb")) {
1002 } else if (!strcasecmp(u
,"m")) {
1004 } else if (!strcasecmp(u
,"mb")) {
1006 } else if (!strcasecmp(u
,"g")) {
1007 mul
= 1000L*1000*1000;
1008 } else if (!strcasecmp(u
,"gb")) {
1009 mul
= 1024L*1024*1024;
1015 if (digits
>= sizeof(buf
)) {
1019 memcpy(buf
,p
,digits
);
1021 val
= strtoll(buf
,NULL
,10);
1025 static void redisLog(int level
, const char *fmt
, ...) {
1029 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
1033 if (level
>= server
.verbosity
) {
1039 strftime(buf
,64,"%d %b %H:%M:%S",localtime(&now
));
1040 fprintf(fp
,"[%d] %s %c ",(int)getpid(),buf
,c
[level
]);
1041 vfprintf(fp
, fmt
, ap
);
1047 if (server
.logfile
) fclose(fp
);
1050 /*====================== Hash table type implementation ==================== */
1052 /* This is an hash table type that uses the SDS dynamic strings libary as
1053 * keys and radis objects as values (objects can hold SDS strings,
1056 static void dictVanillaFree(void *privdata
, void *val
)
1058 DICT_NOTUSED(privdata
);
1062 static void dictListDestructor(void *privdata
, void *val
)
1064 DICT_NOTUSED(privdata
);
1065 listRelease((list
*)val
);
1068 static int sdsDictKeyCompare(void *privdata
, const void *key1
,
1072 DICT_NOTUSED(privdata
);
1074 l1
= sdslen((sds
)key1
);
1075 l2
= sdslen((sds
)key2
);
1076 if (l1
!= l2
) return 0;
1077 return memcmp(key1
, key2
, l1
) == 0;
1080 static void dictRedisObjectDestructor(void *privdata
, void *val
)
1082 DICT_NOTUSED(privdata
);
1084 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
1088 static int dictObjKeyCompare(void *privdata
, const void *key1
,
1091 const robj
*o1
= key1
, *o2
= key2
;
1092 return sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1095 static unsigned int dictObjHash(const void *key
) {
1096 const robj
*o
= key
;
1097 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1100 static int dictEncObjKeyCompare(void *privdata
, const void *key1
,
1103 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
1106 if (o1
->encoding
== REDIS_ENCODING_INT
&&
1107 o2
->encoding
== REDIS_ENCODING_INT
&&
1108 o1
->ptr
== o2
->ptr
) return 1;
1110 o1
= getDecodedObject(o1
);
1111 o2
= getDecodedObject(o2
);
1112 cmp
= sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1118 static unsigned int dictEncObjHash(const void *key
) {
1119 robj
*o
= (robj
*) key
;
1121 if (o
->encoding
== REDIS_ENCODING_RAW
) {
1122 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1124 if (o
->encoding
== REDIS_ENCODING_INT
) {
1128 len
= snprintf(buf
,32,"%ld",(long)o
->ptr
);
1129 return dictGenHashFunction((unsigned char*)buf
, len
);
1133 o
= getDecodedObject(o
);
1134 hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1141 /* Sets type and expires */
1142 static dictType setDictType
= {
1143 dictEncObjHash
, /* hash function */
1146 dictEncObjKeyCompare
, /* key compare */
1147 dictRedisObjectDestructor
, /* key destructor */
1148 NULL
/* val destructor */
1151 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
1152 static dictType zsetDictType
= {
1153 dictEncObjHash
, /* hash function */
1156 dictEncObjKeyCompare
, /* key compare */
1157 dictRedisObjectDestructor
, /* key destructor */
1158 dictVanillaFree
/* val destructor of malloc(sizeof(double)) */
1162 static dictType dbDictType
= {
1163 dictObjHash
, /* hash function */
1166 dictObjKeyCompare
, /* key compare */
1167 dictRedisObjectDestructor
, /* key destructor */
1168 dictRedisObjectDestructor
/* val destructor */
1172 static dictType keyptrDictType
= {
1173 dictObjHash
, /* hash function */
1176 dictObjKeyCompare
, /* key compare */
1177 dictRedisObjectDestructor
, /* key destructor */
1178 NULL
/* val destructor */
1181 /* Hash type hash table (note that small hashes are represented with zimpaps) */
1182 static dictType hashDictType
= {
1183 dictEncObjHash
, /* hash function */
1186 dictEncObjKeyCompare
, /* key compare */
1187 dictRedisObjectDestructor
, /* key destructor */
1188 dictRedisObjectDestructor
/* val destructor */
1191 /* Keylist hash table type has unencoded redis objects as keys and
1192 * lists as values. It's used for blocking operations (BLPOP) and to
1193 * map swapped keys to a list of clients waiting for this keys to be loaded. */
1194 static dictType keylistDictType
= {
1195 dictObjHash
, /* hash function */
1198 dictObjKeyCompare
, /* key compare */
1199 dictRedisObjectDestructor
, /* key destructor */
1200 dictListDestructor
/* val destructor */
1203 static void version();
1205 /* ========================= Random utility functions ======================= */
1207 /* Redis generally does not try to recover from out of memory conditions
1208 * when allocating objects or strings, it is not clear if it will be possible
1209 * to report this condition to the client since the networking layer itself
1210 * is based on heap allocation for send buffers, so we simply abort.
1211 * At least the code will be simpler to read... */
1212 static void oom(const char *msg
) {
1213 redisLog(REDIS_WARNING
, "%s: Out of memory\n",msg
);
1218 /* ====================== Redis server networking stuff ===================== */
1219 static void closeTimedoutClients(void) {
1222 time_t now
= time(NULL
);
1225 listRewind(server
.clients
,&li
);
1226 while ((ln
= listNext(&li
)) != NULL
) {
1227 c
= listNodeValue(ln
);
1228 if (server
.maxidletime
&&
1229 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
1230 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
1231 dictSize(c
->pubsub_channels
) == 0 && /* no timeout for pubsub */
1232 listLength(c
->pubsub_patterns
) == 0 &&
1233 (now
- c
->lastinteraction
> server
.maxidletime
))
1235 redisLog(REDIS_VERBOSE
,"Closing idle client");
1237 } else if (c
->flags
& REDIS_BLOCKED
) {
1238 if (c
->blockingto
!= 0 && c
->blockingto
< now
) {
1239 addReply(c
,shared
.nullmultibulk
);
1240 unblockClientWaitingData(c
);
1246 static int htNeedsResize(dict
*dict
) {
1247 long long size
, used
;
1249 size
= dictSlots(dict
);
1250 used
= dictSize(dict
);
1251 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
1252 (used
*100/size
< REDIS_HT_MINFILL
));
1255 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1256 * we resize the hash table to save memory */
1257 static void tryResizeHashTables(void) {
1260 for (j
= 0; j
< server
.dbnum
; j
++) {
1261 if (htNeedsResize(server
.db
[j
].dict
))
1262 dictResize(server
.db
[j
].dict
);
1263 if (htNeedsResize(server
.db
[j
].expires
))
1264 dictResize(server
.db
[j
].expires
);
1268 /* Our hash table implementation performs rehashing incrementally while
1269 * we write/read from the hash table. Still if the server is idle, the hash
1270 * table will use two tables for a long time. So we try to use 1 millisecond
1271 * of CPU time at every serverCron() loop in order to rehash some key. */
1272 static void incrementallyRehash(void) {
1275 for (j
= 0; j
< server
.dbnum
; j
++) {
1276 if (dictIsRehashing(server
.db
[j
].dict
)) {
1277 dictRehashMilliseconds(server
.db
[j
].dict
,1);
1278 break; /* already used our millisecond for this loop... */
1283 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1284 void backgroundSaveDoneHandler(int statloc
) {
1285 int exitcode
= WEXITSTATUS(statloc
);
1286 int bysignal
= WIFSIGNALED(statloc
);
1288 if (!bysignal
&& exitcode
== 0) {
1289 redisLog(REDIS_NOTICE
,
1290 "Background saving terminated with success");
1292 server
.lastsave
= time(NULL
);
1293 } else if (!bysignal
&& exitcode
!= 0) {
1294 redisLog(REDIS_WARNING
, "Background saving error");
1296 redisLog(REDIS_WARNING
,
1297 "Background saving terminated by signal %d", WTERMSIG(statloc
));
1298 rdbRemoveTempFile(server
.bgsavechildpid
);
1300 server
.bgsavechildpid
= -1;
1301 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1302 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1303 updateSlavesWaitingBgsave(exitcode
== 0 ? REDIS_OK
: REDIS_ERR
);
1306 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1308 void backgroundRewriteDoneHandler(int statloc
) {
1309 int exitcode
= WEXITSTATUS(statloc
);
1310 int bysignal
= WIFSIGNALED(statloc
);
1312 if (!bysignal
&& exitcode
== 0) {
1316 redisLog(REDIS_NOTICE
,
1317 "Background append only file rewriting terminated with success");
1318 /* Now it's time to flush the differences accumulated by the parent */
1319 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) server
.bgrewritechildpid
);
1320 fd
= open(tmpfile
,O_WRONLY
|O_APPEND
);
1322 redisLog(REDIS_WARNING
, "Not able to open the temp append only file produced by the child: %s", strerror(errno
));
1325 /* Flush our data... */
1326 if (write(fd
,server
.bgrewritebuf
,sdslen(server
.bgrewritebuf
)) !=
1327 (signed) sdslen(server
.bgrewritebuf
)) {
1328 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
));
1332 redisLog(REDIS_NOTICE
,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server
.bgrewritebuf
));
1333 /* Now our work is to rename the temp file into the stable file. And
1334 * switch the file descriptor used by the server for append only. */
1335 if (rename(tmpfile
,server
.appendfilename
) == -1) {
1336 redisLog(REDIS_WARNING
,"Can't rename the temp append only file into the stable one: %s", strerror(errno
));
1340 /* Mission completed... almost */
1341 redisLog(REDIS_NOTICE
,"Append only file successfully rewritten.");
1342 if (server
.appendfd
!= -1) {
1343 /* If append only is actually enabled... */
1344 close(server
.appendfd
);
1345 server
.appendfd
= fd
;
1347 server
.appendseldb
= -1; /* Make sure it will issue SELECT */
1348 redisLog(REDIS_NOTICE
,"The new append only file was selected for future appends.");
1350 /* If append only is disabled we just generate a dump in this
1351 * format. Why not? */
1354 } else if (!bysignal
&& exitcode
!= 0) {
1355 redisLog(REDIS_WARNING
, "Background append only file rewriting error");
1357 redisLog(REDIS_WARNING
,
1358 "Background append only file rewriting terminated by signal %d",
1362 sdsfree(server
.bgrewritebuf
);
1363 server
.bgrewritebuf
= sdsempty();
1364 aofRemoveTempFile(server
.bgrewritechildpid
);
1365 server
.bgrewritechildpid
= -1;
1368 /* This function is called once a background process of some kind terminates,
1369 * as we want to avoid resizing the hash tables when there is a child in order
1370 * to play well with copy-on-write (otherwise when a resize happens lots of
1371 * memory pages are copied). The goal of this function is to update the ability
1372 * for dict.c to resize the hash tables accordingly to the fact we have o not
1373 * running childs. */
1374 static void updateDictResizePolicy(void) {
1375 if (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1)
1378 dictDisableResize();
1381 static int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
1382 int j
, loops
= server
.cronloops
++;
1383 REDIS_NOTUSED(eventLoop
);
1385 REDIS_NOTUSED(clientData
);
1387 /* We take a cached value of the unix time in the global state because
1388 * with virtual memory and aging there is to store the current time
1389 * in objects at every object access, and accuracy is not needed.
1390 * To access a global var is faster than calling time(NULL) */
1391 server
.unixtime
= time(NULL
);
1393 /* Show some info about non-empty databases */
1394 for (j
= 0; j
< server
.dbnum
; j
++) {
1395 long long size
, used
, vkeys
;
1397 size
= dictSlots(server
.db
[j
].dict
);
1398 used
= dictSize(server
.db
[j
].dict
);
1399 vkeys
= dictSize(server
.db
[j
].expires
);
1400 if (!(loops
% 50) && (used
|| vkeys
)) {
1401 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
1402 /* dictPrintStats(server.dict); */
1406 /* We don't want to resize the hash tables while a bacground saving
1407 * is in progress: the saving child is created using fork() that is
1408 * implemented with a copy-on-write semantic in most modern systems, so
1409 * if we resize the HT while there is the saving child at work actually
1410 * a lot of memory movements in the parent will cause a lot of pages
1412 if (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1) {
1413 if (!(loops
% 10)) tryResizeHashTables();
1414 if (server
.activerehashing
) incrementallyRehash();
1417 /* Show information about connected clients */
1418 if (!(loops
% 50)) {
1419 redisLog(REDIS_VERBOSE
,"%d clients connected (%d slaves), %zu bytes in use",
1420 listLength(server
.clients
)-listLength(server
.slaves
),
1421 listLength(server
.slaves
),
1422 zmalloc_used_memory());
1425 /* Close connections of timedout clients */
1426 if ((server
.maxidletime
&& !(loops
% 100)) || server
.blpop_blocked_clients
)
1427 closeTimedoutClients();
1429 /* Check if a background saving or AOF rewrite in progress terminated */
1430 if (server
.bgsavechildpid
!= -1 || server
.bgrewritechildpid
!= -1) {
1434 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
1435 if (pid
== server
.bgsavechildpid
) {
1436 backgroundSaveDoneHandler(statloc
);
1438 backgroundRewriteDoneHandler(statloc
);
1440 updateDictResizePolicy();
1443 /* If there is not a background saving in progress check if
1444 * we have to save now */
1445 time_t now
= time(NULL
);
1446 for (j
= 0; j
< server
.saveparamslen
; j
++) {
1447 struct saveparam
*sp
= server
.saveparams
+j
;
1449 if (server
.dirty
>= sp
->changes
&&
1450 now
-server
.lastsave
> sp
->seconds
) {
1451 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
1452 sp
->changes
, sp
->seconds
);
1453 rdbSaveBackground(server
.dbfilename
);
1459 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1460 * will use few CPU cycles if there are few expiring keys, otherwise
1461 * it will get more aggressive to avoid that too much memory is used by
1462 * keys that can be removed from the keyspace. */
1463 for (j
= 0; j
< server
.dbnum
; j
++) {
1465 redisDb
*db
= server
.db
+j
;
1467 /* Continue to expire if at the end of the cycle more than 25%
1468 * of the keys were expired. */
1470 long num
= dictSize(db
->expires
);
1471 time_t now
= time(NULL
);
1474 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
1475 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
1480 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
1481 t
= (time_t) dictGetEntryVal(de
);
1483 deleteKey(db
,dictGetEntryKey(de
));
1485 server
.stat_expiredkeys
++;
1488 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
1491 /* Swap a few keys on disk if we are over the memory limit and VM
1492 * is enbled. Try to free objects from the free list first. */
1493 if (vmCanSwapOut()) {
1494 while (server
.vm_enabled
&& zmalloc_used_memory() >
1495 server
.vm_max_memory
)
1499 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
1500 retval
= (server
.vm_max_threads
== 0) ?
1501 vmSwapOneObjectBlocking() :
1502 vmSwapOneObjectThreaded();
1503 if (retval
== REDIS_ERR
&& !(loops
% 300) &&
1504 zmalloc_used_memory() >
1505 (server
.vm_max_memory
+server
.vm_max_memory
/10))
1507 redisLog(REDIS_WARNING
,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1509 /* Note that when using threade I/O we free just one object,
1510 * because anyway when the I/O thread in charge to swap this
1511 * object out will finish, the handler of completed jobs
1512 * will try to swap more objects if we are still out of memory. */
1513 if (retval
== REDIS_ERR
|| server
.vm_max_threads
> 0) break;
1517 /* Check if we should connect to a MASTER */
1518 if (server
.replstate
== REDIS_REPL_CONNECT
&& !(loops
% 10)) {
1519 redisLog(REDIS_NOTICE
,"Connecting to MASTER...");
1520 if (syncWithMaster() == REDIS_OK
) {
1521 redisLog(REDIS_NOTICE
,"MASTER <-> SLAVE sync succeeded");
1522 if (server
.appendonly
) rewriteAppendOnlyFileBackground();
1528 /* This function gets called every time Redis is entering the
1529 * main loop of the event driven library, that is, before to sleep
1530 * for ready file descriptors. */
1531 static void beforeSleep(struct aeEventLoop
*eventLoop
) {
1532 REDIS_NOTUSED(eventLoop
);
1534 /* Awake clients that got all the swapped keys they requested */
1535 if (server
.vm_enabled
&& listLength(server
.io_ready_clients
)) {
1539 listRewind(server
.io_ready_clients
,&li
);
1540 while((ln
= listNext(&li
))) {
1541 redisClient
*c
= ln
->value
;
1542 struct redisCommand
*cmd
;
1544 /* Resume the client. */
1545 listDelNode(server
.io_ready_clients
,ln
);
1546 c
->flags
&= (~REDIS_IO_WAIT
);
1547 server
.vm_blocked_clients
--;
1548 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
1549 readQueryFromClient
, c
);
1550 cmd
= lookupCommand(c
->argv
[0]->ptr
);
1551 assert(cmd
!= NULL
);
1554 /* There may be more data to process in the input buffer. */
1555 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0)
1556 processInputBuffer(c
);
1559 /* Write the AOF buffer on disk */
1560 flushAppendOnlyFile();
1563 static void createSharedObjects(void) {
1566 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1567 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1568 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1569 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1570 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1571 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1572 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1573 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1574 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1575 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1576 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1577 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1578 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1579 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1580 "-ERR no such key\r\n"));
1581 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1582 "-ERR syntax error\r\n"));
1583 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1584 "-ERR source and destination objects are the same\r\n"));
1585 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1586 "-ERR index out of range\r\n"));
1587 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1588 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1589 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1590 shared
.select0
= createStringObject("select 0\r\n",10);
1591 shared
.select1
= createStringObject("select 1\r\n",10);
1592 shared
.select2
= createStringObject("select 2\r\n",10);
1593 shared
.select3
= createStringObject("select 3\r\n",10);
1594 shared
.select4
= createStringObject("select 4\r\n",10);
1595 shared
.select5
= createStringObject("select 5\r\n",10);
1596 shared
.select6
= createStringObject("select 6\r\n",10);
1597 shared
.select7
= createStringObject("select 7\r\n",10);
1598 shared
.select8
= createStringObject("select 8\r\n",10);
1599 shared
.select9
= createStringObject("select 9\r\n",10);
1600 shared
.messagebulk
= createStringObject("$7\r\nmessage\r\n",13);
1601 shared
.pmessagebulk
= createStringObject("$8\r\npmessage\r\n",14);
1602 shared
.subscribebulk
= createStringObject("$9\r\nsubscribe\r\n",15);
1603 shared
.unsubscribebulk
= createStringObject("$11\r\nunsubscribe\r\n",18);
1604 shared
.psubscribebulk
= createStringObject("$10\r\npsubscribe\r\n",17);
1605 shared
.punsubscribebulk
= createStringObject("$12\r\npunsubscribe\r\n",19);
1606 shared
.mbulk3
= createStringObject("*3\r\n",4);
1607 shared
.mbulk4
= createStringObject("*4\r\n",4);
1608 for (j
= 0; j
< REDIS_SHARED_INTEGERS
; j
++) {
1609 shared
.integers
[j
] = createObject(REDIS_STRING
,(void*)(long)j
);
1610 shared
.integers
[j
]->encoding
= REDIS_ENCODING_INT
;
1614 static void appendServerSaveParams(time_t seconds
, int changes
) {
1615 server
.saveparams
= zrealloc(server
.saveparams
,sizeof(struct saveparam
)*(server
.saveparamslen
+1));
1616 server
.saveparams
[server
.saveparamslen
].seconds
= seconds
;
1617 server
.saveparams
[server
.saveparamslen
].changes
= changes
;
1618 server
.saveparamslen
++;
1621 static void resetServerSaveParams() {
1622 zfree(server
.saveparams
);
1623 server
.saveparams
= NULL
;
1624 server
.saveparamslen
= 0;
1627 static void initServerConfig() {
1628 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1629 server
.port
= REDIS_SERVERPORT
;
1630 server
.verbosity
= REDIS_VERBOSE
;
1631 server
.maxidletime
= REDIS_MAXIDLETIME
;
1632 server
.saveparams
= NULL
;
1633 server
.logfile
= NULL
; /* NULL = log on standard output */
1634 server
.bindaddr
= NULL
;
1635 server
.glueoutputbuf
= 1;
1636 server
.daemonize
= 0;
1637 server
.appendonly
= 0;
1638 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1639 server
.lastfsync
= time(NULL
);
1640 server
.appendfd
= -1;
1641 server
.appendseldb
= -1; /* Make sure the first time will not match */
1642 server
.pidfile
= zstrdup("/var/run/redis.pid");
1643 server
.dbfilename
= zstrdup("dump.rdb");
1644 server
.appendfilename
= zstrdup("appendonly.aof");
1645 server
.requirepass
= NULL
;
1646 server
.rdbcompression
= 1;
1647 server
.activerehashing
= 1;
1648 server
.maxclients
= 0;
1649 server
.blpop_blocked_clients
= 0;
1650 server
.maxmemory
= 0;
1651 server
.vm_enabled
= 0;
1652 server
.vm_swap_file
= zstrdup("/tmp/redis-%p.vm");
1653 server
.vm_page_size
= 256; /* 256 bytes per page */
1654 server
.vm_pages
= 1024*1024*100; /* 104 millions of pages */
1655 server
.vm_max_memory
= 1024LL*1024*1024*1; /* 1 GB of RAM */
1656 server
.vm_max_threads
= 4;
1657 server
.vm_blocked_clients
= 0;
1658 server
.hash_max_zipmap_entries
= REDIS_HASH_MAX_ZIPMAP_ENTRIES
;
1659 server
.hash_max_zipmap_value
= REDIS_HASH_MAX_ZIPMAP_VALUE
;
1661 resetServerSaveParams();
1663 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1664 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1665 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1666 /* Replication related */
1668 server
.masterauth
= NULL
;
1669 server
.masterhost
= NULL
;
1670 server
.masterport
= 6379;
1671 server
.master
= NULL
;
1672 server
.replstate
= REDIS_REPL_NONE
;
1674 /* Double constants initialization */
1676 R_PosInf
= 1.0/R_Zero
;
1677 R_NegInf
= -1.0/R_Zero
;
1678 R_Nan
= R_Zero
/R_Zero
;
1681 static void initServer() {
1684 signal(SIGHUP
, SIG_IGN
);
1685 signal(SIGPIPE
, SIG_IGN
);
1686 setupSigSegvAction();
1688 server
.devnull
= fopen("/dev/null","w");
1689 if (server
.devnull
== NULL
) {
1690 redisLog(REDIS_WARNING
, "Can't open /dev/null: %s", server
.neterr
);
1693 server
.clients
= listCreate();
1694 server
.slaves
= listCreate();
1695 server
.monitors
= listCreate();
1696 server
.objfreelist
= listCreate();
1697 createSharedObjects();
1698 server
.el
= aeCreateEventLoop();
1699 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1700 server
.fd
= anetTcpServer(server
.neterr
, server
.port
, server
.bindaddr
);
1701 if (server
.fd
== -1) {
1702 redisLog(REDIS_WARNING
, "Opening TCP port: %s", server
.neterr
);
1705 for (j
= 0; j
< server
.dbnum
; j
++) {
1706 server
.db
[j
].dict
= dictCreate(&dbDictType
,NULL
);
1707 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1708 server
.db
[j
].blockingkeys
= dictCreate(&keylistDictType
,NULL
);
1709 if (server
.vm_enabled
)
1710 server
.db
[j
].io_keys
= dictCreate(&keylistDictType
,NULL
);
1711 server
.db
[j
].id
= j
;
1713 server
.pubsub_channels
= dictCreate(&keylistDictType
,NULL
);
1714 server
.pubsub_patterns
= listCreate();
1715 listSetFreeMethod(server
.pubsub_patterns
,freePubsubPattern
);
1716 listSetMatchMethod(server
.pubsub_patterns
,listMatchPubsubPattern
);
1717 server
.cronloops
= 0;
1718 server
.bgsavechildpid
= -1;
1719 server
.bgrewritechildpid
= -1;
1720 server
.bgrewritebuf
= sdsempty();
1721 server
.aofbuf
= sdsempty();
1722 server
.lastsave
= time(NULL
);
1724 server
.stat_numcommands
= 0;
1725 server
.stat_numconnections
= 0;
1726 server
.stat_expiredkeys
= 0;
1727 server
.stat_starttime
= time(NULL
);
1728 server
.unixtime
= time(NULL
);
1729 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1730 if (aeCreateFileEvent(server
.el
, server
.fd
, AE_READABLE
,
1731 acceptHandler
, NULL
) == AE_ERR
) oom("creating file event");
1733 if (server
.appendonly
) {
1734 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1735 if (server
.appendfd
== -1) {
1736 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1742 if (server
.vm_enabled
) vmInit();
1745 /* Empty the whole database */
1746 static long long emptyDb() {
1748 long long removed
= 0;
1750 for (j
= 0; j
< server
.dbnum
; j
++) {
1751 removed
+= dictSize(server
.db
[j
].dict
);
1752 dictEmpty(server
.db
[j
].dict
);
1753 dictEmpty(server
.db
[j
].expires
);
1758 static int yesnotoi(char *s
) {
1759 if (!strcasecmp(s
,"yes")) return 1;
1760 else if (!strcasecmp(s
,"no")) return 0;
1764 /* I agree, this is a very rudimental way to load a configuration...
1765 will improve later if the config gets more complex */
1766 static void loadServerConfig(char *filename
) {
1768 char buf
[REDIS_CONFIGLINE_MAX
+1], *err
= NULL
;
1772 if (filename
[0] == '-' && filename
[1] == '\0')
1775 if ((fp
= fopen(filename
,"r")) == NULL
) {
1776 redisLog(REDIS_WARNING
, "Fatal error, can't open config file '%s'", filename
);
1781 while(fgets(buf
,REDIS_CONFIGLINE_MAX
+1,fp
) != NULL
) {
1787 line
= sdstrim(line
," \t\r\n");
1789 /* Skip comments and blank lines*/
1790 if (line
[0] == '#' || line
[0] == '\0') {
1795 /* Split into arguments */
1796 argv
= sdssplitlen(line
,sdslen(line
)," ",1,&argc
);
1797 sdstolower(argv
[0]);
1799 /* Execute config directives */
1800 if (!strcasecmp(argv
[0],"timeout") && argc
== 2) {
1801 server
.maxidletime
= atoi(argv
[1]);
1802 if (server
.maxidletime
< 0) {
1803 err
= "Invalid timeout value"; goto loaderr
;
1805 } else if (!strcasecmp(argv
[0],"port") && argc
== 2) {
1806 server
.port
= atoi(argv
[1]);
1807 if (server
.port
< 1 || server
.port
> 65535) {
1808 err
= "Invalid port"; goto loaderr
;
1810 } else if (!strcasecmp(argv
[0],"bind") && argc
== 2) {
1811 server
.bindaddr
= zstrdup(argv
[1]);
1812 } else if (!strcasecmp(argv
[0],"save") && argc
== 3) {
1813 int seconds
= atoi(argv
[1]);
1814 int changes
= atoi(argv
[2]);
1815 if (seconds
< 1 || changes
< 0) {
1816 err
= "Invalid save parameters"; goto loaderr
;
1818 appendServerSaveParams(seconds
,changes
);
1819 } else if (!strcasecmp(argv
[0],"dir") && argc
== 2) {
1820 if (chdir(argv
[1]) == -1) {
1821 redisLog(REDIS_WARNING
,"Can't chdir to '%s': %s",
1822 argv
[1], strerror(errno
));
1825 } else if (!strcasecmp(argv
[0],"loglevel") && argc
== 2) {
1826 if (!strcasecmp(argv
[1],"debug")) server
.verbosity
= REDIS_DEBUG
;
1827 else if (!strcasecmp(argv
[1],"verbose")) server
.verbosity
= REDIS_VERBOSE
;
1828 else if (!strcasecmp(argv
[1],"notice")) server
.verbosity
= REDIS_NOTICE
;
1829 else if (!strcasecmp(argv
[1],"warning")) server
.verbosity
= REDIS_WARNING
;
1831 err
= "Invalid log level. Must be one of debug, notice, warning";
1834 } else if (!strcasecmp(argv
[0],"logfile") && argc
== 2) {
1837 server
.logfile
= zstrdup(argv
[1]);
1838 if (!strcasecmp(server
.logfile
,"stdout")) {
1839 zfree(server
.logfile
);
1840 server
.logfile
= NULL
;
1842 if (server
.logfile
) {
1843 /* Test if we are able to open the file. The server will not
1844 * be able to abort just for this problem later... */
1845 logfp
= fopen(server
.logfile
,"a");
1846 if (logfp
== NULL
) {
1847 err
= sdscatprintf(sdsempty(),
1848 "Can't open the log file: %s", strerror(errno
));
1853 } else if (!strcasecmp(argv
[0],"databases") && argc
== 2) {
1854 server
.dbnum
= atoi(argv
[1]);
1855 if (server
.dbnum
< 1) {
1856 err
= "Invalid number of databases"; goto loaderr
;
1858 } else if (!strcasecmp(argv
[0],"include") && argc
== 2) {
1859 loadServerConfig(argv
[1]);
1860 } else if (!strcasecmp(argv
[0],"maxclients") && argc
== 2) {
1861 server
.maxclients
= atoi(argv
[1]);
1862 } else if (!strcasecmp(argv
[0],"maxmemory") && argc
== 2) {
1863 server
.maxmemory
= memtoll(argv
[1],NULL
);
1864 } else if (!strcasecmp(argv
[0],"slaveof") && argc
== 3) {
1865 server
.masterhost
= sdsnew(argv
[1]);
1866 server
.masterport
= atoi(argv
[2]);
1867 server
.replstate
= REDIS_REPL_CONNECT
;
1868 } else if (!strcasecmp(argv
[0],"masterauth") && argc
== 2) {
1869 server
.masterauth
= zstrdup(argv
[1]);
1870 } else if (!strcasecmp(argv
[0],"glueoutputbuf") && argc
== 2) {
1871 if ((server
.glueoutputbuf
= yesnotoi(argv
[1])) == -1) {
1872 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1874 } else if (!strcasecmp(argv
[0],"rdbcompression") && argc
== 2) {
1875 if ((server
.rdbcompression
= yesnotoi(argv
[1])) == -1) {
1876 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1878 } else if (!strcasecmp(argv
[0],"activerehashing") && argc
== 2) {
1879 if ((server
.activerehashing
= yesnotoi(argv
[1])) == -1) {
1880 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1882 } else if (!strcasecmp(argv
[0],"daemonize") && argc
== 2) {
1883 if ((server
.daemonize
= yesnotoi(argv
[1])) == -1) {
1884 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1886 } else if (!strcasecmp(argv
[0],"appendonly") && argc
== 2) {
1887 if ((server
.appendonly
= yesnotoi(argv
[1])) == -1) {
1888 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1890 } else if (!strcasecmp(argv
[0],"appendfilename") && argc
== 2) {
1891 zfree(server
.appendfilename
);
1892 server
.appendfilename
= zstrdup(argv
[1]);
1893 } else if (!strcasecmp(argv
[0],"appendfsync") && argc
== 2) {
1894 if (!strcasecmp(argv
[1],"no")) {
1895 server
.appendfsync
= APPENDFSYNC_NO
;
1896 } else if (!strcasecmp(argv
[1],"always")) {
1897 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1898 } else if (!strcasecmp(argv
[1],"everysec")) {
1899 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1901 err
= "argument must be 'no', 'always' or 'everysec'";
1904 } else if (!strcasecmp(argv
[0],"requirepass") && argc
== 2) {
1905 server
.requirepass
= zstrdup(argv
[1]);
1906 } else if (!strcasecmp(argv
[0],"pidfile") && argc
== 2) {
1907 zfree(server
.pidfile
);
1908 server
.pidfile
= zstrdup(argv
[1]);
1909 } else if (!strcasecmp(argv
[0],"dbfilename") && argc
== 2) {
1910 zfree(server
.dbfilename
);
1911 server
.dbfilename
= zstrdup(argv
[1]);
1912 } else if (!strcasecmp(argv
[0],"vm-enabled") && argc
== 2) {
1913 if ((server
.vm_enabled
= yesnotoi(argv
[1])) == -1) {
1914 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1916 } else if (!strcasecmp(argv
[0],"vm-swap-file") && argc
== 2) {
1917 zfree(server
.vm_swap_file
);
1918 server
.vm_swap_file
= zstrdup(argv
[1]);
1919 } else if (!strcasecmp(argv
[0],"vm-max-memory") && argc
== 2) {
1920 server
.vm_max_memory
= memtoll(argv
[1],NULL
);
1921 } else if (!strcasecmp(argv
[0],"vm-page-size") && argc
== 2) {
1922 server
.vm_page_size
= memtoll(argv
[1], NULL
);
1923 } else if (!strcasecmp(argv
[0],"vm-pages") && argc
== 2) {
1924 server
.vm_pages
= memtoll(argv
[1], NULL
);
1925 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1926 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1927 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-entries") && argc
== 2){
1928 server
.hash_max_zipmap_entries
= memtoll(argv
[1], NULL
);
1929 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-value") && argc
== 2){
1930 server
.hash_max_zipmap_value
= memtoll(argv
[1], NULL
);
1932 err
= "Bad directive or wrong number of arguments"; goto loaderr
;
1934 for (j
= 0; j
< argc
; j
++)
1939 if (fp
!= stdin
) fclose(fp
);
1943 fprintf(stderr
, "\n*** FATAL CONFIG FILE ERROR ***\n");
1944 fprintf(stderr
, "Reading the configuration file, at line %d\n", linenum
);
1945 fprintf(stderr
, ">>> '%s'\n", line
);
1946 fprintf(stderr
, "%s\n", err
);
1950 static void freeClientArgv(redisClient
*c
) {
1953 for (j
= 0; j
< c
->argc
; j
++)
1954 decrRefCount(c
->argv
[j
]);
1955 for (j
= 0; j
< c
->mbargc
; j
++)
1956 decrRefCount(c
->mbargv
[j
]);
1961 static void freeClient(redisClient
*c
) {
1964 /* Note that if the client we are freeing is blocked into a blocking
1965 * call, we have to set querybuf to NULL *before* to call
1966 * unblockClientWaitingData() to avoid processInputBuffer() will get
1967 * called. Also it is important to remove the file events after
1968 * this, because this call adds the READABLE event. */
1969 sdsfree(c
->querybuf
);
1971 if (c
->flags
& REDIS_BLOCKED
)
1972 unblockClientWaitingData(c
);
1974 /* Unsubscribe from all the pubsub channels */
1975 pubsubUnsubscribeAllChannels(c
,0);
1976 pubsubUnsubscribeAllPatterns(c
,0);
1977 dictRelease(c
->pubsub_channels
);
1978 listRelease(c
->pubsub_patterns
);
1979 /* Obvious cleanup */
1980 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
1981 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1982 listRelease(c
->reply
);
1985 /* Remove from the list of clients */
1986 ln
= listSearchKey(server
.clients
,c
);
1987 redisAssert(ln
!= NULL
);
1988 listDelNode(server
.clients
,ln
);
1989 /* Remove from the list of clients waiting for swapped keys */
1990 if (c
->flags
& REDIS_IO_WAIT
&& listLength(c
->io_keys
) == 0) {
1991 ln
= listSearchKey(server
.io_ready_clients
,c
);
1993 listDelNode(server
.io_ready_clients
,ln
);
1994 server
.vm_blocked_clients
--;
1997 while (server
.vm_enabled
&& listLength(c
->io_keys
)) {
1998 ln
= listFirst(c
->io_keys
);
1999 dontWaitForSwappedKey(c
,ln
->value
);
2001 listRelease(c
->io_keys
);
2002 /* Master/slave cleanup */
2003 if (c
->flags
& REDIS_SLAVE
) {
2004 if (c
->replstate
== REDIS_REPL_SEND_BULK
&& c
->repldbfd
!= -1)
2006 list
*l
= (c
->flags
& REDIS_MONITOR
) ? server
.monitors
: server
.slaves
;
2007 ln
= listSearchKey(l
,c
);
2008 redisAssert(ln
!= NULL
);
2011 if (c
->flags
& REDIS_MASTER
) {
2012 server
.master
= NULL
;
2013 server
.replstate
= REDIS_REPL_CONNECT
;
2015 /* Release memory */
2018 freeClientMultiState(c
);
2022 #define GLUEREPLY_UP_TO (1024)
2023 static void glueReplyBuffersIfNeeded(redisClient
*c
) {
2025 char buf
[GLUEREPLY_UP_TO
];
2030 listRewind(c
->reply
,&li
);
2031 while((ln
= listNext(&li
))) {
2035 objlen
= sdslen(o
->ptr
);
2036 if (copylen
+ objlen
<= GLUEREPLY_UP_TO
) {
2037 memcpy(buf
+copylen
,o
->ptr
,objlen
);
2039 listDelNode(c
->reply
,ln
);
2041 if (copylen
== 0) return;
2045 /* Now the output buffer is empty, add the new single element */
2046 o
= createObject(REDIS_STRING
,sdsnewlen(buf
,copylen
));
2047 listAddNodeHead(c
->reply
,o
);
2050 static void sendReplyToClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2051 redisClient
*c
= privdata
;
2052 int nwritten
= 0, totwritten
= 0, objlen
;
2055 REDIS_NOTUSED(mask
);
2057 /* Use writev() if we have enough buffers to send */
2058 if (!server
.glueoutputbuf
&&
2059 listLength(c
->reply
) > REDIS_WRITEV_THRESHOLD
&&
2060 !(c
->flags
& REDIS_MASTER
))
2062 sendReplyToClientWritev(el
, fd
, privdata
, mask
);
2066 while(listLength(c
->reply
)) {
2067 if (server
.glueoutputbuf
&& listLength(c
->reply
) > 1)
2068 glueReplyBuffersIfNeeded(c
);
2070 o
= listNodeValue(listFirst(c
->reply
));
2071 objlen
= sdslen(o
->ptr
);
2074 listDelNode(c
->reply
,listFirst(c
->reply
));
2078 if (c
->flags
& REDIS_MASTER
) {
2079 /* Don't reply to a master */
2080 nwritten
= objlen
- c
->sentlen
;
2082 nwritten
= write(fd
, ((char*)o
->ptr
)+c
->sentlen
, objlen
- c
->sentlen
);
2083 if (nwritten
<= 0) break;
2085 c
->sentlen
+= nwritten
;
2086 totwritten
+= nwritten
;
2087 /* If we fully sent the object on head go to the next one */
2088 if (c
->sentlen
== objlen
) {
2089 listDelNode(c
->reply
,listFirst(c
->reply
));
2092 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
2093 * bytes, in a single threaded server it's a good idea to serve
2094 * other clients as well, even if a very large request comes from
2095 * super fast link that is always able to accept data (in real world
2096 * scenario think about 'KEYS *' against the loopback interfae) */
2097 if (totwritten
> REDIS_MAX_WRITE_PER_EVENT
) break;
2099 if (nwritten
== -1) {
2100 if (errno
== EAGAIN
) {
2103 redisLog(REDIS_VERBOSE
,
2104 "Error writing to client: %s", strerror(errno
));
2109 if (totwritten
> 0) c
->lastinteraction
= time(NULL
);
2110 if (listLength(c
->reply
) == 0) {
2112 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2116 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
)
2118 redisClient
*c
= privdata
;
2119 int nwritten
= 0, totwritten
= 0, objlen
, willwrite
;
2121 struct iovec iov
[REDIS_WRITEV_IOVEC_COUNT
];
2122 int offset
, ion
= 0;
2124 REDIS_NOTUSED(mask
);
2127 while (listLength(c
->reply
)) {
2128 offset
= c
->sentlen
;
2132 /* fill-in the iov[] array */
2133 for(node
= listFirst(c
->reply
); node
; node
= listNextNode(node
)) {
2134 o
= listNodeValue(node
);
2135 objlen
= sdslen(o
->ptr
);
2137 if (totwritten
+ objlen
- offset
> REDIS_MAX_WRITE_PER_EVENT
)
2140 if(ion
== REDIS_WRITEV_IOVEC_COUNT
)
2141 break; /* no more iovecs */
2143 iov
[ion
].iov_base
= ((char*)o
->ptr
) + offset
;
2144 iov
[ion
].iov_len
= objlen
- offset
;
2145 willwrite
+= objlen
- offset
;
2146 offset
= 0; /* just for the first item */
2153 /* write all collected blocks at once */
2154 if((nwritten
= writev(fd
, iov
, ion
)) < 0) {
2155 if (errno
!= EAGAIN
) {
2156 redisLog(REDIS_VERBOSE
,
2157 "Error writing to client: %s", strerror(errno
));
2164 totwritten
+= nwritten
;
2165 offset
= c
->sentlen
;
2167 /* remove written robjs from c->reply */
2168 while (nwritten
&& listLength(c
->reply
)) {
2169 o
= listNodeValue(listFirst(c
->reply
));
2170 objlen
= sdslen(o
->ptr
);
2172 if(nwritten
>= objlen
- offset
) {
2173 listDelNode(c
->reply
, listFirst(c
->reply
));
2174 nwritten
-= objlen
- offset
;
2178 c
->sentlen
+= nwritten
;
2186 c
->lastinteraction
= time(NULL
);
2188 if (listLength(c
->reply
) == 0) {
2190 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2194 static struct redisCommand
*lookupCommand(char *name
) {
2196 while(cmdTable
[j
].name
!= NULL
) {
2197 if (!strcasecmp(name
,cmdTable
[j
].name
)) return &cmdTable
[j
];
2203 /* resetClient prepare the client to process the next command */
2204 static void resetClient(redisClient
*c
) {
2210 /* Call() is the core of Redis execution of a command */
2211 static void call(redisClient
*c
, struct redisCommand
*cmd
) {
2214 dirty
= server
.dirty
;
2216 dirty
= server
.dirty
-dirty
;
2218 if (server
.appendonly
&& dirty
)
2219 feedAppendOnlyFile(cmd
,c
->db
->id
,c
->argv
,c
->argc
);
2220 if ((dirty
|| cmd
->flags
& REDIS_CMD_FORCE_REPLICATION
) &&
2221 listLength(server
.slaves
))
2222 replicationFeedSlaves(server
.slaves
,c
->db
->id
,c
->argv
,c
->argc
);
2223 if (listLength(server
.monitors
))
2224 replicationFeedMonitors(server
.monitors
,c
->db
->id
,c
->argv
,c
->argc
);
2225 server
.stat_numcommands
++;
2228 /* If this function gets called we already read a whole
2229 * command, argments are in the client argv/argc fields.
2230 * processCommand() execute the command or prepare the
2231 * server for a bulk read from the client.
2233 * If 1 is returned the client is still alive and valid and
2234 * and other operations can be performed by the caller. Otherwise
2235 * if 0 is returned the client was destroied (i.e. after QUIT). */
2236 static int processCommand(redisClient
*c
) {
2237 struct redisCommand
*cmd
;
2239 /* Free some memory if needed (maxmemory setting) */
2240 if (server
.maxmemory
) freeMemoryIfNeeded();
2242 /* Handle the multi bulk command type. This is an alternative protocol
2243 * supported by Redis in order to receive commands that are composed of
2244 * multiple binary-safe "bulk" arguments. The latency of processing is
2245 * a bit higher but this allows things like multi-sets, so if this
2246 * protocol is used only for MSET and similar commands this is a big win. */
2247 if (c
->multibulk
== 0 && c
->argc
== 1 && ((char*)(c
->argv
[0]->ptr
))[0] == '*') {
2248 c
->multibulk
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2249 if (c
->multibulk
<= 0) {
2253 decrRefCount(c
->argv
[c
->argc
-1]);
2257 } else if (c
->multibulk
) {
2258 if (c
->bulklen
== -1) {
2259 if (((char*)c
->argv
[0]->ptr
)[0] != '$') {
2260 addReplySds(c
,sdsnew("-ERR multi bulk protocol error\r\n"));
2264 int bulklen
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2265 decrRefCount(c
->argv
[0]);
2266 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2268 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2273 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2277 c
->mbargv
= zrealloc(c
->mbargv
,(sizeof(robj
*))*(c
->mbargc
+1));
2278 c
->mbargv
[c
->mbargc
] = c
->argv
[0];
2282 if (c
->multibulk
== 0) {
2286 /* Here we need to swap the multi-bulk argc/argv with the
2287 * normal argc/argv of the client structure. */
2289 c
->argv
= c
->mbargv
;
2290 c
->mbargv
= auxargv
;
2293 c
->argc
= c
->mbargc
;
2294 c
->mbargc
= auxargc
;
2296 /* We need to set bulklen to something different than -1
2297 * in order for the code below to process the command without
2298 * to try to read the last argument of a bulk command as
2299 * a special argument. */
2301 /* continue below and process the command */
2308 /* -- end of multi bulk commands processing -- */
2310 /* The QUIT command is handled as a special case. Normal command
2311 * procs are unable to close the client connection safely */
2312 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
2317 /* Now lookup the command and check ASAP about trivial error conditions
2318 * such wrong arity, bad command name and so forth. */
2319 cmd
= lookupCommand(c
->argv
[0]->ptr
);
2322 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2323 (char*)c
->argv
[0]->ptr
));
2326 } else if ((cmd
->arity
> 0 && cmd
->arity
!= c
->argc
) ||
2327 (c
->argc
< -cmd
->arity
)) {
2329 sdscatprintf(sdsempty(),
2330 "-ERR wrong number of arguments for '%s' command\r\n",
2334 } else if (cmd
->flags
& REDIS_CMD_BULK
&& c
->bulklen
== -1) {
2335 /* This is a bulk command, we have to read the last argument yet. */
2336 int bulklen
= atoi(c
->argv
[c
->argc
-1]->ptr
);
2338 decrRefCount(c
->argv
[c
->argc
-1]);
2339 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2341 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2346 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2347 /* It is possible that the bulk read is already in the
2348 * buffer. Check this condition and handle it accordingly.
2349 * This is just a fast path, alternative to call processInputBuffer().
2350 * It's a good idea since the code is small and this condition
2351 * happens most of the times. */
2352 if ((signed)sdslen(c
->querybuf
) >= c
->bulklen
) {
2353 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2355 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2357 /* Otherwise return... there is to read the last argument
2358 * from the socket. */
2362 /* Let's try to encode the bulk object to save space. */
2363 if (cmd
->flags
& REDIS_CMD_BULK
)
2364 c
->argv
[c
->argc
-1] = tryObjectEncoding(c
->argv
[c
->argc
-1]);
2366 /* Check if the user is authenticated */
2367 if (server
.requirepass
&& !c
->authenticated
&& cmd
->proc
!= authCommand
) {
2368 addReplySds(c
,sdsnew("-ERR operation not permitted\r\n"));
2373 /* Handle the maxmemory directive */
2374 if (server
.maxmemory
&& (cmd
->flags
& REDIS_CMD_DENYOOM
) &&
2375 zmalloc_used_memory() > server
.maxmemory
)
2377 addReplySds(c
,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2382 /* Only allow SUBSCRIBE and UNSUBSCRIBE in the context of Pub/Sub */
2383 if ((dictSize(c
->pubsub_channels
) > 0 || listLength(c
->pubsub_patterns
) > 0)
2385 cmd
->proc
!= subscribeCommand
&& cmd
->proc
!= unsubscribeCommand
&&
2386 cmd
->proc
!= psubscribeCommand
&& cmd
->proc
!= punsubscribeCommand
) {
2387 addReplySds(c
,sdsnew("-ERR only (P)SUBSCRIBE / (P)UNSUBSCRIBE / QUIT allowed in this context\r\n"));
2392 /* Exec the command */
2393 if (c
->flags
& REDIS_MULTI
&& cmd
->proc
!= execCommand
&& cmd
->proc
!= discardCommand
) {
2394 queueMultiCommand(c
,cmd
);
2395 addReply(c
,shared
.queued
);
2397 if (server
.vm_enabled
&& server
.vm_max_threads
> 0 &&
2398 blockClientOnSwappedKeys(cmd
,c
)) return 1;
2402 /* Prepare the client for the next command */
2407 static void replicationFeedSlaves(list
*slaves
, int dictid
, robj
**argv
, int argc
) {
2412 /* We need 1+(ARGS*3) objects since commands are using the new protocol
2413 * and we one 1 object for the first "*<count>\r\n" multibulk count, then
2414 * for every additional object we have "$<count>\r\n" + object + "\r\n". */
2415 robj
*static_outv
[REDIS_STATIC_ARGS
*3+1];
2418 if (argc
<= REDIS_STATIC_ARGS
) {
2421 outv
= zmalloc(sizeof(robj
*)*(argc
*3+1));
2424 lenobj
= createObject(REDIS_STRING
,
2425 sdscatprintf(sdsempty(), "*%d\r\n", argc
));
2426 lenobj
->refcount
= 0;
2427 outv
[outc
++] = lenobj
;
2428 for (j
= 0; j
< argc
; j
++) {
2429 lenobj
= createObject(REDIS_STRING
,
2430 sdscatprintf(sdsempty(),"$%lu\r\n",
2431 (unsigned long) stringObjectLen(argv
[j
])));
2432 lenobj
->refcount
= 0;
2433 outv
[outc
++] = lenobj
;
2434 outv
[outc
++] = argv
[j
];
2435 outv
[outc
++] = shared
.crlf
;
2438 /* Increment all the refcounts at start and decrement at end in order to
2439 * be sure to free objects if there is no slave in a replication state
2440 * able to be feed with commands */
2441 for (j
= 0; j
< outc
; j
++) incrRefCount(outv
[j
]);
2442 listRewind(slaves
,&li
);
2443 while((ln
= listNext(&li
))) {
2444 redisClient
*slave
= ln
->value
;
2446 /* Don't feed slaves that are still waiting for BGSAVE to start */
2447 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) continue;
2449 /* Feed all the other slaves, MONITORs and so on */
2450 if (slave
->slaveseldb
!= dictid
) {
2454 case 0: selectcmd
= shared
.select0
; break;
2455 case 1: selectcmd
= shared
.select1
; break;
2456 case 2: selectcmd
= shared
.select2
; break;
2457 case 3: selectcmd
= shared
.select3
; break;
2458 case 4: selectcmd
= shared
.select4
; break;
2459 case 5: selectcmd
= shared
.select5
; break;
2460 case 6: selectcmd
= shared
.select6
; break;
2461 case 7: selectcmd
= shared
.select7
; break;
2462 case 8: selectcmd
= shared
.select8
; break;
2463 case 9: selectcmd
= shared
.select9
; break;
2465 selectcmd
= createObject(REDIS_STRING
,
2466 sdscatprintf(sdsempty(),"select %d\r\n",dictid
));
2467 selectcmd
->refcount
= 0;
2470 addReply(slave
,selectcmd
);
2471 slave
->slaveseldb
= dictid
;
2473 for (j
= 0; j
< outc
; j
++) addReply(slave
,outv
[j
]);
2475 for (j
= 0; j
< outc
; j
++) decrRefCount(outv
[j
]);
2476 if (outv
!= static_outv
) zfree(outv
);
2479 static sds
sdscatrepr(sds s
, char *p
, size_t len
) {
2480 s
= sdscatlen(s
,"\"",1);
2485 s
= sdscatprintf(s
,"\\%c",*p
);
2487 case '\n': s
= sdscatlen(s
,"\\n",1); break;
2488 case '\r': s
= sdscatlen(s
,"\\r",1); break;
2489 case '\t': s
= sdscatlen(s
,"\\t",1); break;
2490 case '\a': s
= sdscatlen(s
,"\\a",1); break;
2491 case '\b': s
= sdscatlen(s
,"\\b",1); break;
2494 s
= sdscatprintf(s
,"%c",*p
);
2496 s
= sdscatprintf(s
,"\\x%02x",(unsigned char)*p
);
2501 return sdscatlen(s
,"\"",1);
2504 static void replicationFeedMonitors(list
*monitors
, int dictid
, robj
**argv
, int argc
) {
2508 sds cmdrepr
= sdsnew("+");
2512 gettimeofday(&tv
,NULL
);
2513 cmdrepr
= sdscatprintf(cmdrepr
,"%ld.%ld ",(long)tv
.tv_sec
,(long)tv
.tv_usec
);
2514 if (dictid
!= 0) cmdrepr
= sdscatprintf(cmdrepr
,"(db %d) ", dictid
);
2516 for (j
= 0; j
< argc
; j
++) {
2517 if (argv
[j
]->encoding
== REDIS_ENCODING_INT
) {
2518 cmdrepr
= sdscatprintf(cmdrepr
, "%ld", (long)argv
[j
]->ptr
);
2520 cmdrepr
= sdscatrepr(cmdrepr
,(char*)argv
[j
]->ptr
,
2521 sdslen(argv
[j
]->ptr
));
2524 cmdrepr
= sdscatlen(cmdrepr
," ",1);
2526 cmdrepr
= sdscatlen(cmdrepr
,"\r\n",2);
2527 cmdobj
= createObject(REDIS_STRING
,cmdrepr
);
2529 listRewind(monitors
,&li
);
2530 while((ln
= listNext(&li
))) {
2531 redisClient
*monitor
= ln
->value
;
2532 addReply(monitor
,cmdobj
);
2534 decrRefCount(cmdobj
);
2537 static void processInputBuffer(redisClient
*c
) {
2539 /* Before to process the input buffer, make sure the client is not
2540 * waitig for a blocking operation such as BLPOP. Note that the first
2541 * iteration the client is never blocked, otherwise the processInputBuffer
2542 * would not be called at all, but after the execution of the first commands
2543 * in the input buffer the client may be blocked, and the "goto again"
2544 * will try to reiterate. The following line will make it return asap. */
2545 if (c
->flags
& REDIS_BLOCKED
|| c
->flags
& REDIS_IO_WAIT
) return;
2546 if (c
->bulklen
== -1) {
2547 /* Read the first line of the query */
2548 char *p
= strchr(c
->querybuf
,'\n');
2555 query
= c
->querybuf
;
2556 c
->querybuf
= sdsempty();
2557 querylen
= 1+(p
-(query
));
2558 if (sdslen(query
) > querylen
) {
2559 /* leave data after the first line of the query in the buffer */
2560 c
->querybuf
= sdscatlen(c
->querybuf
,query
+querylen
,sdslen(query
)-querylen
);
2562 *p
= '\0'; /* remove "\n" */
2563 if (*(p
-1) == '\r') *(p
-1) = '\0'; /* and "\r" if any */
2564 sdsupdatelen(query
);
2566 /* Now we can split the query in arguments */
2567 argv
= sdssplitlen(query
,sdslen(query
)," ",1,&argc
);
2570 if (c
->argv
) zfree(c
->argv
);
2571 c
->argv
= zmalloc(sizeof(robj
*)*argc
);
2573 for (j
= 0; j
< argc
; j
++) {
2574 if (sdslen(argv
[j
])) {
2575 c
->argv
[c
->argc
] = createObject(REDIS_STRING
,argv
[j
]);
2583 /* Execute the command. If the client is still valid
2584 * after processCommand() return and there is something
2585 * on the query buffer try to process the next command. */
2586 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2588 /* Nothing to process, argc == 0. Just process the query
2589 * buffer if it's not empty or return to the caller */
2590 if (sdslen(c
->querybuf
)) goto again
;
2593 } else if (sdslen(c
->querybuf
) >= REDIS_REQUEST_MAX_SIZE
) {
2594 redisLog(REDIS_VERBOSE
, "Client protocol error");
2599 /* Bulk read handling. Note that if we are at this point
2600 the client already sent a command terminated with a newline,
2601 we are reading the bulk data that is actually the last
2602 argument of the command. */
2603 int qbl
= sdslen(c
->querybuf
);
2605 if (c
->bulklen
<= qbl
) {
2606 /* Copy everything but the final CRLF as final argument */
2607 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2609 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2610 /* Process the command. If the client is still valid after
2611 * the processing and there is more data in the buffer
2612 * try to parse it. */
2613 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2619 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2620 redisClient
*c
= (redisClient
*) privdata
;
2621 char buf
[REDIS_IOBUF_LEN
];
2624 REDIS_NOTUSED(mask
);
2626 nread
= read(fd
, buf
, REDIS_IOBUF_LEN
);
2628 if (errno
== EAGAIN
) {
2631 redisLog(REDIS_VERBOSE
, "Reading from client: %s",strerror(errno
));
2635 } else if (nread
== 0) {
2636 redisLog(REDIS_VERBOSE
, "Client closed connection");
2641 c
->querybuf
= sdscatlen(c
->querybuf
, buf
, nread
);
2642 c
->lastinteraction
= time(NULL
);
2646 processInputBuffer(c
);
2649 static int selectDb(redisClient
*c
, int id
) {
2650 if (id
< 0 || id
>= server
.dbnum
)
2652 c
->db
= &server
.db
[id
];
2656 static void *dupClientReplyValue(void *o
) {
2657 incrRefCount((robj
*)o
);
2661 static int listMatchObjects(void *a
, void *b
) {
2662 return compareStringObjects(a
,b
) == 0;
2665 static redisClient
*createClient(int fd
) {
2666 redisClient
*c
= zmalloc(sizeof(*c
));
2668 anetNonBlock(NULL
,fd
);
2669 anetTcpNoDelay(NULL
,fd
);
2670 if (!c
) return NULL
;
2673 c
->querybuf
= sdsempty();
2682 c
->lastinteraction
= time(NULL
);
2683 c
->authenticated
= 0;
2684 c
->replstate
= REDIS_REPL_NONE
;
2685 c
->reply
= listCreate();
2686 listSetFreeMethod(c
->reply
,decrRefCount
);
2687 listSetDupMethod(c
->reply
,dupClientReplyValue
);
2688 c
->blockingkeys
= NULL
;
2689 c
->blockingkeysnum
= 0;
2690 c
->io_keys
= listCreate();
2691 listSetFreeMethod(c
->io_keys
,decrRefCount
);
2692 c
->pubsub_channels
= dictCreate(&setDictType
,NULL
);
2693 c
->pubsub_patterns
= listCreate();
2694 listSetFreeMethod(c
->pubsub_patterns
,decrRefCount
);
2695 listSetMatchMethod(c
->pubsub_patterns
,listMatchObjects
);
2696 if (aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
2697 readQueryFromClient
, c
) == AE_ERR
) {
2701 listAddNodeTail(server
.clients
,c
);
2702 initClientMultiState(c
);
2706 static void addReply(redisClient
*c
, robj
*obj
) {
2707 if (listLength(c
->reply
) == 0 &&
2708 (c
->replstate
== REDIS_REPL_NONE
||
2709 c
->replstate
== REDIS_REPL_ONLINE
) &&
2710 aeCreateFileEvent(server
.el
, c
->fd
, AE_WRITABLE
,
2711 sendReplyToClient
, c
) == AE_ERR
) return;
2713 if (server
.vm_enabled
&& obj
->storage
!= REDIS_VM_MEMORY
) {
2714 obj
= dupStringObject(obj
);
2715 obj
->refcount
= 0; /* getDecodedObject() will increment the refcount */
2717 listAddNodeTail(c
->reply
,getDecodedObject(obj
));
2720 static void addReplySds(redisClient
*c
, sds s
) {
2721 robj
*o
= createObject(REDIS_STRING
,s
);
2726 static void addReplyDouble(redisClient
*c
, double d
) {
2729 snprintf(buf
,sizeof(buf
),"%.17g",d
);
2730 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2731 (unsigned long) strlen(buf
),buf
));
2734 static void addReplyLong(redisClient
*c
, long l
) {
2739 addReply(c
,shared
.czero
);
2741 } else if (l
== 1) {
2742 addReply(c
,shared
.cone
);
2745 len
= snprintf(buf
,sizeof(buf
),":%ld\r\n",l
);
2746 addReplySds(c
,sdsnewlen(buf
,len
));
2749 static void addReplyLongLong(redisClient
*c
, long long ll
) {
2754 addReply(c
,shared
.czero
);
2756 } else if (ll
== 1) {
2757 addReply(c
,shared
.cone
);
2760 len
= snprintf(buf
,sizeof(buf
),":%lld\r\n",ll
);
2761 addReplySds(c
,sdsnewlen(buf
,len
));
2764 static void addReplyUlong(redisClient
*c
, unsigned long ul
) {
2769 addReply(c
,shared
.czero
);
2771 } else if (ul
== 1) {
2772 addReply(c
,shared
.cone
);
2775 len
= snprintf(buf
,sizeof(buf
),":%lu\r\n",ul
);
2776 addReplySds(c
,sdsnewlen(buf
,len
));
2779 static void addReplyBulkLen(redisClient
*c
, robj
*obj
) {
2782 if (obj
->encoding
== REDIS_ENCODING_RAW
) {
2783 len
= sdslen(obj
->ptr
);
2785 long n
= (long)obj
->ptr
;
2787 /* Compute how many bytes will take this integer as a radix 10 string */
2793 while((n
= n
/10) != 0) {
2797 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",(unsigned long)len
));
2800 static void addReplyBulk(redisClient
*c
, robj
*obj
) {
2801 addReplyBulkLen(c
,obj
);
2803 addReply(c
,shared
.crlf
);
2806 /* In the CONFIG command we need to add vanilla C string as bulk replies */
2807 static void addReplyBulkCString(redisClient
*c
, char *s
) {
2809 addReply(c
,shared
.nullbulk
);
2811 robj
*o
= createStringObject(s
,strlen(s
));
2817 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2822 REDIS_NOTUSED(mask
);
2823 REDIS_NOTUSED(privdata
);
2825 cfd
= anetAccept(server
.neterr
, fd
, cip
, &cport
);
2826 if (cfd
== AE_ERR
) {
2827 redisLog(REDIS_VERBOSE
,"Accepting client connection: %s", server
.neterr
);
2830 redisLog(REDIS_VERBOSE
,"Accepted %s:%d", cip
, cport
);
2831 if ((c
= createClient(cfd
)) == NULL
) {
2832 redisLog(REDIS_WARNING
,"Error allocating resoures for the client");
2833 close(cfd
); /* May be already closed, just ingore errors */
2836 /* If maxclient directive is set and this is one client more... close the
2837 * connection. Note that we create the client instead to check before
2838 * for this condition, since now the socket is already set in nonblocking
2839 * mode and we can send an error for free using the Kernel I/O */
2840 if (server
.maxclients
&& listLength(server
.clients
) > server
.maxclients
) {
2841 char *err
= "-ERR max number of clients reached\r\n";
2843 /* That's a best effort error message, don't check write errors */
2844 if (write(c
->fd
,err
,strlen(err
)) == -1) {
2845 /* Nothing to do, Just to avoid the warning... */
2850 server
.stat_numconnections
++;
2853 /* ======================= Redis objects implementation ===================== */
2855 static robj
*createObject(int type
, void *ptr
) {
2858 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2859 if (listLength(server
.objfreelist
)) {
2860 listNode
*head
= listFirst(server
.objfreelist
);
2861 o
= listNodeValue(head
);
2862 listDelNode(server
.objfreelist
,head
);
2863 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2865 if (server
.vm_enabled
) {
2866 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2867 o
= zmalloc(sizeof(*o
));
2869 o
= zmalloc(sizeof(*o
)-sizeof(struct redisObjectVM
));
2873 o
->encoding
= REDIS_ENCODING_RAW
;
2876 if (server
.vm_enabled
) {
2877 /* Note that this code may run in the context of an I/O thread
2878 * and accessing to server.unixtime in theory is an error
2879 * (no locks). But in practice this is safe, and even if we read
2880 * garbage Redis will not fail, as it's just a statistical info */
2881 o
->vm
.atime
= server
.unixtime
;
2882 o
->storage
= REDIS_VM_MEMORY
;
2887 static robj
*createStringObject(char *ptr
, size_t len
) {
2888 return createObject(REDIS_STRING
,sdsnewlen(ptr
,len
));
2891 static robj
*createStringObjectFromLongLong(long long value
) {
2893 if (value
>= 0 && value
< REDIS_SHARED_INTEGERS
) {
2894 incrRefCount(shared
.integers
[value
]);
2895 o
= shared
.integers
[value
];
2897 o
= createObject(REDIS_STRING
, NULL
);
2898 if (value
>= LONG_MIN
&& value
<= LONG_MAX
) {
2899 o
->encoding
= REDIS_ENCODING_INT
;
2900 o
->ptr
= (void*)((long)value
);
2902 o
->ptr
= sdscatprintf(sdsempty(),"%lld",value
);
2908 static robj
*dupStringObject(robj
*o
) {
2909 assert(o
->encoding
== REDIS_ENCODING_RAW
);
2910 return createStringObject(o
->ptr
,sdslen(o
->ptr
));
2913 static robj
*createListObject(void) {
2914 list
*l
= listCreate();
2916 listSetFreeMethod(l
,decrRefCount
);
2917 return createObject(REDIS_LIST
,l
);
2920 static robj
*createSetObject(void) {
2921 dict
*d
= dictCreate(&setDictType
,NULL
);
2922 return createObject(REDIS_SET
,d
);
2925 static robj
*createHashObject(void) {
2926 /* All the Hashes start as zipmaps. Will be automatically converted
2927 * into hash tables if there are enough elements or big elements
2929 unsigned char *zm
= zipmapNew();
2930 robj
*o
= createObject(REDIS_HASH
,zm
);
2931 o
->encoding
= REDIS_ENCODING_ZIPMAP
;
2935 static robj
*createZsetObject(void) {
2936 zset
*zs
= zmalloc(sizeof(*zs
));
2938 zs
->dict
= dictCreate(&zsetDictType
,NULL
);
2939 zs
->zsl
= zslCreate();
2940 return createObject(REDIS_ZSET
,zs
);
2943 static void freeStringObject(robj
*o
) {
2944 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2949 static void freeListObject(robj
*o
) {
2950 listRelease((list
*) o
->ptr
);
2953 static void freeSetObject(robj
*o
) {
2954 dictRelease((dict
*) o
->ptr
);
2957 static void freeZsetObject(robj
*o
) {
2960 dictRelease(zs
->dict
);
2965 static void freeHashObject(robj
*o
) {
2966 switch (o
->encoding
) {
2967 case REDIS_ENCODING_HT
:
2968 dictRelease((dict
*) o
->ptr
);
2970 case REDIS_ENCODING_ZIPMAP
:
2974 redisPanic("Unknown hash encoding type");
2979 static void incrRefCount(robj
*o
) {
2983 static void decrRefCount(void *obj
) {
2986 if (o
->refcount
<= 0) redisPanic("decrRefCount against refcount <= 0");
2987 /* Object is a key of a swapped out value, or in the process of being
2989 if (server
.vm_enabled
&&
2990 (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
))
2992 if (o
->storage
== REDIS_VM_LOADING
) vmCancelThreadedIOJob(obj
);
2993 redisAssert(o
->type
== REDIS_STRING
);
2994 freeStringObject(o
);
2995 vmMarkPagesFree(o
->vm
.page
,o
->vm
.usedpages
);
2996 pthread_mutex_lock(&server
.obj_freelist_mutex
);
2997 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2998 !listAddNodeHead(server
.objfreelist
,o
))
3000 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
3001 server
.vm_stats_swapped_objects
--;
3004 /* Object is in memory, or in the process of being swapped out. */
3005 if (--(o
->refcount
) == 0) {
3006 if (server
.vm_enabled
&& o
->storage
== REDIS_VM_SWAPPING
)
3007 vmCancelThreadedIOJob(obj
);
3009 case REDIS_STRING
: freeStringObject(o
); break;
3010 case REDIS_LIST
: freeListObject(o
); break;
3011 case REDIS_SET
: freeSetObject(o
); break;
3012 case REDIS_ZSET
: freeZsetObject(o
); break;
3013 case REDIS_HASH
: freeHashObject(o
); break;
3014 default: redisPanic("Unknown object type"); break;
3016 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
3017 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
3018 !listAddNodeHead(server
.objfreelist
,o
))
3020 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
3024 static robj
*lookupKey(redisDb
*db
, robj
*key
) {
3025 dictEntry
*de
= dictFind(db
->dict
,key
);
3027 robj
*key
= dictGetEntryKey(de
);
3028 robj
*val
= dictGetEntryVal(de
);
3030 if (server
.vm_enabled
) {
3031 if (key
->storage
== REDIS_VM_MEMORY
||
3032 key
->storage
== REDIS_VM_SWAPPING
)
3034 /* If we were swapping the object out, stop it, this key
3036 if (key
->storage
== REDIS_VM_SWAPPING
)
3037 vmCancelThreadedIOJob(key
);
3038 /* Update the access time of the key for the aging algorithm. */
3039 key
->vm
.atime
= server
.unixtime
;
3041 int notify
= (key
->storage
== REDIS_VM_LOADING
);
3043 /* Our value was swapped on disk. Bring it at home. */
3044 redisAssert(val
== NULL
);
3045 val
= vmLoadObject(key
);
3046 dictGetEntryVal(de
) = val
;
3048 /* Clients blocked by the VM subsystem may be waiting for
3050 if (notify
) handleClientsBlockedOnSwappedKey(db
,key
);
3059 static robj
*lookupKeyRead(redisDb
*db
, robj
*key
) {
3060 expireIfNeeded(db
,key
);
3061 return lookupKey(db
,key
);
3064 static robj
*lookupKeyWrite(redisDb
*db
, robj
*key
) {
3065 deleteIfVolatile(db
,key
);
3066 return lookupKey(db
,key
);
3069 static robj
*lookupKeyReadOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
3070 robj
*o
= lookupKeyRead(c
->db
, key
);
3071 if (!o
) addReply(c
,reply
);
3075 static robj
*lookupKeyWriteOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
3076 robj
*o
= lookupKeyWrite(c
->db
, key
);
3077 if (!o
) addReply(c
,reply
);
3081 static int checkType(redisClient
*c
, robj
*o
, int type
) {
3082 if (o
->type
!= type
) {
3083 addReply(c
,shared
.wrongtypeerr
);
3089 static int deleteKey(redisDb
*db
, robj
*key
) {
3092 /* We need to protect key from destruction: after the first dictDelete()
3093 * it may happen that 'key' is no longer valid if we don't increment
3094 * it's count. This may happen when we get the object reference directly
3095 * from the hash table with dictRandomKey() or dict iterators */
3097 if (dictSize(db
->expires
)) dictDelete(db
->expires
,key
);
3098 retval
= dictDelete(db
->dict
,key
);
3101 return retval
== DICT_OK
;
3104 /* Check if the nul-terminated string 's' can be represented by a long
3105 * (that is, is a number that fits into long without any other space or
3106 * character before or after the digits).
3108 * If so, the function returns REDIS_OK and *longval is set to the value
3109 * of the number. Otherwise REDIS_ERR is returned */
3110 static int isStringRepresentableAsLong(sds s
, long *longval
) {
3111 char buf
[32], *endptr
;
3115 value
= strtol(s
, &endptr
, 10);
3116 if (endptr
[0] != '\0') return REDIS_ERR
;
3117 slen
= snprintf(buf
,32,"%ld",value
);
3119 /* If the number converted back into a string is not identical
3120 * then it's not possible to encode the string as integer */
3121 if (sdslen(s
) != (unsigned)slen
|| memcmp(buf
,s
,slen
)) return REDIS_ERR
;
3122 if (longval
) *longval
= value
;
3126 /* Try to encode a string object in order to save space */
3127 static robj
*tryObjectEncoding(robj
*o
) {
3131 if (o
->encoding
!= REDIS_ENCODING_RAW
)
3132 return o
; /* Already encoded */
3134 /* It's not safe to encode shared objects: shared objects can be shared
3135 * everywhere in the "object space" of Redis. Encoded objects can only
3136 * appear as "values" (and not, for instance, as keys) */
3137 if (o
->refcount
> 1) return o
;
3139 /* Currently we try to encode only strings */
3140 redisAssert(o
->type
== REDIS_STRING
);
3142 /* Check if we can represent this string as a long integer */
3143 if (isStringRepresentableAsLong(s
,&value
) == REDIS_ERR
) return o
;
3145 /* Ok, this object can be encoded */
3146 if (value
>= 0 && value
< REDIS_SHARED_INTEGERS
) {
3148 incrRefCount(shared
.integers
[value
]);
3149 return shared
.integers
[value
];
3151 o
->encoding
= REDIS_ENCODING_INT
;
3153 o
->ptr
= (void*) value
;
3158 /* Get a decoded version of an encoded object (returned as a new object).
3159 * If the object is already raw-encoded just increment the ref count. */
3160 static robj
*getDecodedObject(robj
*o
) {
3163 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3167 if (o
->type
== REDIS_STRING
&& o
->encoding
== REDIS_ENCODING_INT
) {
3170 snprintf(buf
,32,"%ld",(long)o
->ptr
);
3171 dec
= createStringObject(buf
,strlen(buf
));
3174 redisPanic("Unknown encoding type");
3178 /* Compare two string objects via strcmp() or alike.
3179 * Note that the objects may be integer-encoded. In such a case we
3180 * use snprintf() to get a string representation of the numbers on the stack
3181 * and compare the strings, it's much faster than calling getDecodedObject().
3183 * Important note: if objects are not integer encoded, but binary-safe strings,
3184 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
3186 static int compareStringObjects(robj
*a
, robj
*b
) {
3187 redisAssert(a
->type
== REDIS_STRING
&& b
->type
== REDIS_STRING
);
3188 char bufa
[128], bufb
[128], *astr
, *bstr
;
3191 if (a
== b
) return 0;
3192 if (a
->encoding
!= REDIS_ENCODING_RAW
) {
3193 snprintf(bufa
,sizeof(bufa
),"%ld",(long) a
->ptr
);
3199 if (b
->encoding
!= REDIS_ENCODING_RAW
) {
3200 snprintf(bufb
,sizeof(bufb
),"%ld",(long) b
->ptr
);
3206 return bothsds
? sdscmp(astr
,bstr
) : strcmp(astr
,bstr
);
3209 static size_t stringObjectLen(robj
*o
) {
3210 redisAssert(o
->type
== REDIS_STRING
);
3211 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3212 return sdslen(o
->ptr
);
3216 return snprintf(buf
,32,"%ld",(long)o
->ptr
);
3220 static int getDoubleFromObject(robj
*o
, double *target
) {
3227 redisAssert(o
->type
== REDIS_STRING
);
3228 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3229 value
= strtod(o
->ptr
, &eptr
);
3230 if (eptr
[0] != '\0') return REDIS_ERR
;
3231 } else if (o
->encoding
== REDIS_ENCODING_INT
) {
3232 value
= (long)o
->ptr
;
3234 redisPanic("Unknown string encoding");
3242 static int getDoubleFromObjectOrReply(redisClient
*c
, robj
*o
, double *target
, const char *msg
) {
3244 if (getDoubleFromObject(o
, &value
) != REDIS_OK
) {
3246 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3248 addReplySds(c
, sdsnew("-ERR value is not a double\r\n"));
3257 static int getLongLongFromObject(robj
*o
, long long *target
) {
3264 redisAssert(o
->type
== REDIS_STRING
);
3265 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3266 value
= strtoll(o
->ptr
, &eptr
, 10);
3267 if (eptr
[0] != '\0') return REDIS_ERR
;
3268 } else if (o
->encoding
== REDIS_ENCODING_INT
) {
3269 value
= (long)o
->ptr
;
3271 redisPanic("Unknown string encoding");
3279 static int getLongLongFromObjectOrReply(redisClient
*c
, robj
*o
, long long *target
, const char *msg
) {
3281 if (getLongLongFromObject(o
, &value
) != REDIS_OK
) {
3283 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3285 addReplySds(c
, sdsnew("-ERR value is not an integer\r\n"));
3294 static int getLongFromObjectOrReply(redisClient
*c
, robj
*o
, long *target
, const char *msg
) {
3297 if (getLongLongFromObjectOrReply(c
, o
, &value
, msg
) != REDIS_OK
) return REDIS_ERR
;
3298 if (value
< LONG_MIN
|| value
> LONG_MAX
) {
3300 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3302 addReplySds(c
, sdsnew("-ERR value is out of range\r\n"));
3311 /*============================ RDB saving/loading =========================== */
3313 static int rdbSaveType(FILE *fp
, unsigned char type
) {
3314 if (fwrite(&type
,1,1,fp
) == 0) return -1;
3318 static int rdbSaveTime(FILE *fp
, time_t t
) {
3319 int32_t t32
= (int32_t) t
;
3320 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
3324 /* check rdbLoadLen() comments for more info */
3325 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
3326 unsigned char buf
[2];
3329 /* Save a 6 bit len */
3330 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
3331 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3332 } else if (len
< (1<<14)) {
3333 /* Save a 14 bit len */
3334 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
3336 if (fwrite(buf
,2,1,fp
) == 0) return -1;
3338 /* Save a 32 bit len */
3339 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
3340 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3342 if (fwrite(&len
,4,1,fp
) == 0) return -1;
3347 /* String objects in the form "2391" "-100" without any space and with a
3348 * range of values that can fit in an 8, 16 or 32 bit signed value can be
3349 * encoded as integers to save space */
3350 static int rdbTryIntegerEncoding(char *s
, size_t len
, unsigned char *enc
) {
3352 char *endptr
, buf
[32];
3354 /* Check if it's possible to encode this value as a number */
3355 value
= strtoll(s
, &endptr
, 10);
3356 if (endptr
[0] != '\0') return 0;
3357 snprintf(buf
,32,"%lld",value
);
3359 /* If the number converted back into a string is not identical
3360 * then it's not possible to encode the string as integer */
3361 if (strlen(buf
) != len
|| memcmp(buf
,s
,len
)) return 0;
3363 /* Finally check if it fits in our ranges */
3364 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
3365 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
3366 enc
[1] = value
&0xFF;
3368 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
3369 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
3370 enc
[1] = value
&0xFF;
3371 enc
[2] = (value
>>8)&0xFF;
3373 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
3374 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
3375 enc
[1] = value
&0xFF;
3376 enc
[2] = (value
>>8)&0xFF;
3377 enc
[3] = (value
>>16)&0xFF;
3378 enc
[4] = (value
>>24)&0xFF;
3385 static int rdbSaveLzfStringObject(FILE *fp
, unsigned char *s
, size_t len
) {
3386 size_t comprlen
, outlen
;
3390 /* We require at least four bytes compression for this to be worth it */
3391 if (len
<= 4) return 0;
3393 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
3394 comprlen
= lzf_compress(s
, len
, out
, outlen
);
3395 if (comprlen
== 0) {
3399 /* Data compressed! Let's save it on disk */
3400 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
3401 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
3402 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
3403 if (rdbSaveLen(fp
,len
) == -1) goto writeerr
;
3404 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
3413 /* Save a string objet as [len][data] on disk. If the object is a string
3414 * representation of an integer value we try to safe it in a special form */
3415 static int rdbSaveRawString(FILE *fp
, unsigned char *s
, size_t len
) {
3418 /* Try integer encoding */
3420 unsigned char buf
[5];
3421 if ((enclen
= rdbTryIntegerEncoding((char*)s
,len
,buf
)) > 0) {
3422 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3427 /* Try LZF compression - under 20 bytes it's unable to compress even
3428 * aaaaaaaaaaaaaaaaaa so skip it */
3429 if (server
.rdbcompression
&& len
> 20) {
3432 retval
= rdbSaveLzfStringObject(fp
,s
,len
);
3433 if (retval
== -1) return -1;
3434 if (retval
> 0) return 0;
3435 /* retval == 0 means data can't be compressed, save the old way */
3438 /* Store verbatim */
3439 if (rdbSaveLen(fp
,len
) == -1) return -1;
3440 if (len
&& fwrite(s
,len
,1,fp
) == 0) return -1;
3444 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
3445 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
3448 /* Avoid incr/decr ref count business when possible.
3449 * This plays well with copy-on-write given that we are probably
3450 * in a child process (BGSAVE). Also this makes sure key objects
3451 * of swapped objects are not incRefCount-ed (an assert does not allow
3452 * this in order to avoid bugs) */
3453 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
3454 obj
= getDecodedObject(obj
);
3455 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3458 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3463 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
3464 * 8 bit integer specifing the length of the representation.
3465 * This 8 bit integer has special values in order to specify the following
3471 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
3472 unsigned char buf
[128];
3478 } else if (!isfinite(val
)) {
3480 buf
[0] = (val
< 0) ? 255 : 254;
3482 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
3483 buf
[0] = strlen((char*)buf
+1);
3486 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
3490 /* Save a Redis object. */
3491 static int rdbSaveObject(FILE *fp
, robj
*o
) {
3492 if (o
->type
== REDIS_STRING
) {
3493 /* Save a string value */
3494 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
3495 } else if (o
->type
== REDIS_LIST
) {
3496 /* Save a list value */
3497 list
*list
= o
->ptr
;
3501 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
3502 listRewind(list
,&li
);
3503 while((ln
= listNext(&li
))) {
3504 robj
*eleobj
= listNodeValue(ln
);
3506 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3508 } else if (o
->type
== REDIS_SET
) {
3509 /* Save a set value */
3511 dictIterator
*di
= dictGetIterator(set
);
3514 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
3515 while((de
= dictNext(di
)) != NULL
) {
3516 robj
*eleobj
= dictGetEntryKey(de
);
3518 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3520 dictReleaseIterator(di
);
3521 } else if (o
->type
== REDIS_ZSET
) {
3522 /* Save a set value */
3524 dictIterator
*di
= dictGetIterator(zs
->dict
);
3527 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
3528 while((de
= dictNext(di
)) != NULL
) {
3529 robj
*eleobj
= dictGetEntryKey(de
);
3530 double *score
= dictGetEntryVal(de
);
3532 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3533 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
3535 dictReleaseIterator(di
);
3536 } else if (o
->type
== REDIS_HASH
) {
3537 /* Save a hash value */
3538 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3539 unsigned char *p
= zipmapRewind(o
->ptr
);
3540 unsigned int count
= zipmapLen(o
->ptr
);
3541 unsigned char *key
, *val
;
3542 unsigned int klen
, vlen
;
3544 if (rdbSaveLen(fp
,count
) == -1) return -1;
3545 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
3546 if (rdbSaveRawString(fp
,key
,klen
) == -1) return -1;
3547 if (rdbSaveRawString(fp
,val
,vlen
) == -1) return -1;
3550 dictIterator
*di
= dictGetIterator(o
->ptr
);
3553 if (rdbSaveLen(fp
,dictSize((dict
*)o
->ptr
)) == -1) return -1;
3554 while((de
= dictNext(di
)) != NULL
) {
3555 robj
*key
= dictGetEntryKey(de
);
3556 robj
*val
= dictGetEntryVal(de
);
3558 if (rdbSaveStringObject(fp
,key
) == -1) return -1;
3559 if (rdbSaveStringObject(fp
,val
) == -1) return -1;
3561 dictReleaseIterator(di
);
3564 redisPanic("Unknown object type");
3569 /* Return the length the object will have on disk if saved with
3570 * the rdbSaveObject() function. Currently we use a trick to get
3571 * this length with very little changes to the code. In the future
3572 * we could switch to a faster solution. */
3573 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
3574 if (fp
== NULL
) fp
= server
.devnull
;
3576 assert(rdbSaveObject(fp
,o
) != 1);
3580 /* Return the number of pages required to save this object in the swap file */
3581 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
3582 off_t bytes
= rdbSavedObjectLen(o
,fp
);
3584 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
3587 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3588 static int rdbSave(char *filename
) {
3589 dictIterator
*di
= NULL
;
3594 time_t now
= time(NULL
);
3596 /* Wait for I/O therads to terminate, just in case this is a
3597 * foreground-saving, to avoid seeking the swap file descriptor at the
3599 if (server
.vm_enabled
)
3600 waitEmptyIOJobsQueue();
3602 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3603 fp
= fopen(tmpfile
,"w");
3605 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3608 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3609 for (j
= 0; j
< server
.dbnum
; j
++) {
3610 redisDb
*db
= server
.db
+j
;
3612 if (dictSize(d
) == 0) continue;
3613 di
= dictGetIterator(d
);
3619 /* Write the SELECT DB opcode */
3620 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3621 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3623 /* Iterate this DB writing every entry */
3624 while((de
= dictNext(di
)) != NULL
) {
3625 robj
*key
= dictGetEntryKey(de
);
3626 robj
*o
= dictGetEntryVal(de
);
3627 time_t expiretime
= getExpire(db
,key
);
3629 /* Save the expire time */
3630 if (expiretime
!= -1) {
3631 /* If this key is already expired skip it */
3632 if (expiretime
< now
) continue;
3633 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3634 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3636 /* Save the key and associated value. This requires special
3637 * handling if the value is swapped out. */
3638 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
3639 key
->storage
== REDIS_VM_SWAPPING
) {
3640 /* Save type, key, value */
3641 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3642 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3643 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3645 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3647 /* Get a preview of the object in memory */
3648 po
= vmPreviewObject(key
);
3649 /* Save type, key, value */
3650 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
3651 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3652 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3653 /* Remove the loaded object from memory */
3657 dictReleaseIterator(di
);
3660 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3662 /* Make sure data will not remain on the OS's output buffers */
3667 /* Use RENAME to make sure the DB file is changed atomically only
3668 * if the generate DB file is ok. */
3669 if (rename(tmpfile
,filename
) == -1) {
3670 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3674 redisLog(REDIS_NOTICE
,"DB saved on disk");
3676 server
.lastsave
= time(NULL
);
3682 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3683 if (di
) dictReleaseIterator(di
);
3687 static int rdbSaveBackground(char *filename
) {
3690 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3691 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
3692 if ((childpid
= fork()) == 0) {
3694 if (server
.vm_enabled
) vmReopenSwapFile();
3696 if (rdbSave(filename
) == REDIS_OK
) {
3703 if (childpid
== -1) {
3704 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3708 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3709 server
.bgsavechildpid
= childpid
;
3710 updateDictResizePolicy();
3713 return REDIS_OK
; /* unreached */
3716 static void rdbRemoveTempFile(pid_t childpid
) {
3719 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
3723 static int rdbLoadType(FILE *fp
) {
3725 if (fread(&type
,1,1,fp
) == 0) return -1;
3729 static time_t rdbLoadTime(FILE *fp
) {
3731 if (fread(&t32
,4,1,fp
) == 0) return -1;
3732 return (time_t) t32
;
3735 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3736 * of this file for a description of how this are stored on disk.
3738 * isencoded is set to 1 if the readed length is not actually a length but
3739 * an "encoding type", check the above comments for more info */
3740 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3741 unsigned char buf
[2];
3745 if (isencoded
) *isencoded
= 0;
3746 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3747 type
= (buf
[0]&0xC0)>>6;
3748 if (type
== REDIS_RDB_6BITLEN
) {
3749 /* Read a 6 bit len */
3751 } else if (type
== REDIS_RDB_ENCVAL
) {
3752 /* Read a 6 bit len encoding type */
3753 if (isencoded
) *isencoded
= 1;
3755 } else if (type
== REDIS_RDB_14BITLEN
) {
3756 /* Read a 14 bit len */
3757 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3758 return ((buf
[0]&0x3F)<<8)|buf
[1];
3760 /* Read a 32 bit len */
3761 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3766 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
) {
3767 unsigned char enc
[4];
3770 if (enctype
== REDIS_RDB_ENC_INT8
) {
3771 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3772 val
= (signed char)enc
[0];
3773 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3775 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3776 v
= enc
[0]|(enc
[1]<<8);
3778 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3780 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3781 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3784 val
= 0; /* anti-warning */
3785 redisPanic("Unknown RDB integer encoding type");
3787 return createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",val
));
3790 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3791 unsigned int len
, clen
;
3792 unsigned char *c
= NULL
;
3795 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3796 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3797 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3798 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3799 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3800 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3802 return createObject(REDIS_STRING
,val
);
3809 static robj
*rdbLoadStringObject(FILE*fp
) {
3814 len
= rdbLoadLen(fp
,&isencoded
);
3817 case REDIS_RDB_ENC_INT8
:
3818 case REDIS_RDB_ENC_INT16
:
3819 case REDIS_RDB_ENC_INT32
:
3820 return rdbLoadIntegerObject(fp
,len
);
3821 case REDIS_RDB_ENC_LZF
:
3822 return rdbLoadLzfStringObject(fp
);
3824 redisPanic("Unknown RDB encoding type");
3828 if (len
== REDIS_RDB_LENERR
) return NULL
;
3829 val
= sdsnewlen(NULL
,len
);
3830 if (len
&& fread(val
,len
,1,fp
) == 0) {
3834 return createObject(REDIS_STRING
,val
);
3837 /* For information about double serialization check rdbSaveDoubleValue() */
3838 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
3842 if (fread(&len
,1,1,fp
) == 0) return -1;
3844 case 255: *val
= R_NegInf
; return 0;
3845 case 254: *val
= R_PosInf
; return 0;
3846 case 253: *val
= R_Nan
; return 0;
3848 if (fread(buf
,len
,1,fp
) == 0) return -1;
3850 sscanf(buf
, "%lg", val
);
3855 /* Load a Redis object of the specified type from the specified file.
3856 * On success a newly allocated object is returned, otherwise NULL. */
3857 static robj
*rdbLoadObject(int type
, FILE *fp
) {
3860 redisLog(REDIS_DEBUG
,"LOADING OBJECT %d (at %d)\n",type
,ftell(fp
));
3861 if (type
== REDIS_STRING
) {
3862 /* Read string value */
3863 if ((o
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3864 o
= tryObjectEncoding(o
);
3865 } else if (type
== REDIS_LIST
|| type
== REDIS_SET
) {
3866 /* Read list/set value */
3869 if ((listlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3870 o
= (type
== REDIS_LIST
) ? createListObject() : createSetObject();
3871 /* It's faster to expand the dict to the right size asap in order
3872 * to avoid rehashing */
3873 if (type
== REDIS_SET
&& listlen
> DICT_HT_INITIAL_SIZE
)
3874 dictExpand(o
->ptr
,listlen
);
3875 /* Load every single element of the list/set */
3879 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3880 ele
= tryObjectEncoding(ele
);
3881 if (type
== REDIS_LIST
) {
3882 listAddNodeTail((list
*)o
->ptr
,ele
);
3884 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
3887 } else if (type
== REDIS_ZSET
) {
3888 /* Read list/set value */
3892 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3893 o
= createZsetObject();
3895 /* Load every single element of the list/set */
3898 double *score
= zmalloc(sizeof(double));
3900 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3901 ele
= tryObjectEncoding(ele
);
3902 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
3903 dictAdd(zs
->dict
,ele
,score
);
3904 zslInsert(zs
->zsl
,*score
,ele
);
3905 incrRefCount(ele
); /* added to skiplist */
3907 } else if (type
== REDIS_HASH
) {
3910 if ((hashlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3911 o
= createHashObject();
3912 /* Too many entries? Use an hash table. */
3913 if (hashlen
> server
.hash_max_zipmap_entries
)
3914 convertToRealHash(o
);
3915 /* Load every key/value, then set it into the zipmap or hash
3916 * table, as needed. */
3920 if ((key
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3921 if ((val
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3922 /* If we are using a zipmap and there are too big values
3923 * the object is converted to real hash table encoding. */
3924 if (o
->encoding
!= REDIS_ENCODING_HT
&&
3925 (sdslen(key
->ptr
) > server
.hash_max_zipmap_value
||
3926 sdslen(val
->ptr
) > server
.hash_max_zipmap_value
))
3928 convertToRealHash(o
);
3931 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3932 unsigned char *zm
= o
->ptr
;
3934 zm
= zipmapSet(zm
,key
->ptr
,sdslen(key
->ptr
),
3935 val
->ptr
,sdslen(val
->ptr
),NULL
);
3940 key
= tryObjectEncoding(key
);
3941 val
= tryObjectEncoding(val
);
3942 dictAdd((dict
*)o
->ptr
,key
,val
);
3946 redisPanic("Unknown object type");
3951 static int rdbLoad(char *filename
) {
3953 robj
*keyobj
= NULL
;
3955 int type
, retval
, rdbver
;
3956 dict
*d
= server
.db
[0].dict
;
3957 redisDb
*db
= server
.db
+0;
3959 time_t expiretime
= -1, now
= time(NULL
);
3960 long long loadedkeys
= 0;
3962 fp
= fopen(filename
,"r");
3963 if (!fp
) return REDIS_ERR
;
3964 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
3966 if (memcmp(buf
,"REDIS",5) != 0) {
3968 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
3971 rdbver
= atoi(buf
+5);
3974 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
3981 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3982 if (type
== REDIS_EXPIRETIME
) {
3983 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
3984 /* We read the time so we need to read the object type again */
3985 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3987 if (type
== REDIS_EOF
) break;
3988 /* Handle SELECT DB opcode as a special case */
3989 if (type
== REDIS_SELECTDB
) {
3990 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
3992 if (dbid
>= (unsigned)server
.dbnum
) {
3993 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
3996 db
= server
.db
+dbid
;
4001 if ((keyobj
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
4003 if ((o
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
4004 /* Add the new object in the hash table */
4005 retval
= dictAdd(d
,keyobj
,o
);
4006 if (retval
== DICT_ERR
) {
4007 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", keyobj
->ptr
);
4010 /* Set the expire time if needed */
4011 if (expiretime
!= -1) {
4012 setExpire(db
,keyobj
,expiretime
);
4013 /* Delete this key if already expired */
4014 if (expiretime
< now
) deleteKey(db
,keyobj
);
4018 /* Handle swapping while loading big datasets when VM is on */
4020 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
4021 while (zmalloc_used_memory() > server
.vm_max_memory
) {
4022 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
4029 eoferr
: /* unexpected end of file is handled here with a fatal exit */
4030 if (keyobj
) decrRefCount(keyobj
);
4031 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
4033 return REDIS_ERR
; /* Just to avoid warning */
4036 /*================================== Commands =============================== */
4038 static void authCommand(redisClient
*c
) {
4039 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
4040 c
->authenticated
= 1;
4041 addReply(c
,shared
.ok
);
4043 c
->authenticated
= 0;
4044 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
4048 static void pingCommand(redisClient
*c
) {
4049 addReply(c
,shared
.pong
);
4052 static void echoCommand(redisClient
*c
) {
4053 addReplyBulk(c
,c
->argv
[1]);
4056 /*=================================== Strings =============================== */
4058 static void setGenericCommand(redisClient
*c
, int nx
, robj
*key
, robj
*val
, robj
*expire
) {
4060 long seconds
= 0; /* initialized to avoid an harmness warning */
4063 if (getLongFromObjectOrReply(c
, expire
, &seconds
, NULL
) != REDIS_OK
)
4066 addReplySds(c
,sdsnew("-ERR invalid expire time in SETEX\r\n"));
4071 if (nx
) deleteIfVolatile(c
->db
,key
);
4072 retval
= dictAdd(c
->db
->dict
,key
,val
);
4073 if (retval
== DICT_ERR
) {
4075 /* If the key is about a swapped value, we want a new key object
4076 * to overwrite the old. So we delete the old key in the database.
4077 * This will also make sure that swap pages about the old object
4078 * will be marked as free. */
4079 if (server
.vm_enabled
&& deleteIfSwapped(c
->db
,key
))
4081 dictReplace(c
->db
->dict
,key
,val
);
4084 addReply(c
,shared
.czero
);
4092 removeExpire(c
->db
,key
);
4093 if (expire
) setExpire(c
->db
,key
,time(NULL
)+seconds
);
4094 addReply(c
, nx
? shared
.cone
: shared
.ok
);
4097 static void setCommand(redisClient
*c
) {
4098 setGenericCommand(c
,0,c
->argv
[1],c
->argv
[2],NULL
);
4101 static void setnxCommand(redisClient
*c
) {
4102 setGenericCommand(c
,1,c
->argv
[1],c
->argv
[2],NULL
);
4105 static void setexCommand(redisClient
*c
) {
4106 setGenericCommand(c
,0,c
->argv
[1],c
->argv
[3],c
->argv
[2]);
4109 static int getGenericCommand(redisClient
*c
) {
4112 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
)
4115 if (o
->type
!= REDIS_STRING
) {
4116 addReply(c
,shared
.wrongtypeerr
);
4124 static void getCommand(redisClient
*c
) {
4125 getGenericCommand(c
);
4128 static void getsetCommand(redisClient
*c
) {
4129 if (getGenericCommand(c
) == REDIS_ERR
) return;
4130 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
4131 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4133 incrRefCount(c
->argv
[1]);
4135 incrRefCount(c
->argv
[2]);
4137 removeExpire(c
->db
,c
->argv
[1]);
4140 static void mgetCommand(redisClient
*c
) {
4143 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
4144 for (j
= 1; j
< c
->argc
; j
++) {
4145 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
4147 addReply(c
,shared
.nullbulk
);
4149 if (o
->type
!= REDIS_STRING
) {
4150 addReply(c
,shared
.nullbulk
);
4158 static void msetGenericCommand(redisClient
*c
, int nx
) {
4159 int j
, busykeys
= 0;
4161 if ((c
->argc
% 2) == 0) {
4162 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
4165 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
4166 * set nothing at all if at least one already key exists. */
4168 for (j
= 1; j
< c
->argc
; j
+= 2) {
4169 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
4175 addReply(c
, shared
.czero
);
4179 for (j
= 1; j
< c
->argc
; j
+= 2) {
4182 c
->argv
[j
+1] = tryObjectEncoding(c
->argv
[j
+1]);
4183 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
4184 if (retval
== DICT_ERR
) {
4185 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
4186 incrRefCount(c
->argv
[j
+1]);
4188 incrRefCount(c
->argv
[j
]);
4189 incrRefCount(c
->argv
[j
+1]);
4191 removeExpire(c
->db
,c
->argv
[j
]);
4193 server
.dirty
+= (c
->argc
-1)/2;
4194 addReply(c
, nx
? shared
.cone
: shared
.ok
);
4197 static void msetCommand(redisClient
*c
) {
4198 msetGenericCommand(c
,0);
4201 static void msetnxCommand(redisClient
*c
) {
4202 msetGenericCommand(c
,1);
4205 static void incrDecrCommand(redisClient
*c
, long long incr
) {
4210 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4212 if (getLongLongFromObjectOrReply(c
, o
, &value
, NULL
) != REDIS_OK
) return;
4215 o
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
4216 o
= tryObjectEncoding(o
);
4217 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
4218 if (retval
== DICT_ERR
) {
4219 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4220 removeExpire(c
->db
,c
->argv
[1]);
4222 incrRefCount(c
->argv
[1]);
4225 addReply(c
,shared
.colon
);
4227 addReply(c
,shared
.crlf
);
4230 static void incrCommand(redisClient
*c
) {
4231 incrDecrCommand(c
,1);
4234 static void decrCommand(redisClient
*c
) {
4235 incrDecrCommand(c
,-1);
4238 static void incrbyCommand(redisClient
*c
) {
4241 if (getLongLongFromObjectOrReply(c
, c
->argv
[2], &incr
, NULL
) != REDIS_OK
) return;
4242 incrDecrCommand(c
,incr
);
4245 static void decrbyCommand(redisClient
*c
) {
4248 if (getLongLongFromObjectOrReply(c
, c
->argv
[2], &incr
, NULL
) != REDIS_OK
) return;
4249 incrDecrCommand(c
,-incr
);
4252 static void appendCommand(redisClient
*c
) {
4257 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4259 /* Create the key */
4260 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4261 incrRefCount(c
->argv
[1]);
4262 incrRefCount(c
->argv
[2]);
4263 totlen
= stringObjectLen(c
->argv
[2]);
4267 de
= dictFind(c
->db
->dict
,c
->argv
[1]);
4270 o
= dictGetEntryVal(de
);
4271 if (o
->type
!= REDIS_STRING
) {
4272 addReply(c
,shared
.wrongtypeerr
);
4275 /* If the object is specially encoded or shared we have to make
4277 if (o
->refcount
!= 1 || o
->encoding
!= REDIS_ENCODING_RAW
) {
4278 robj
*decoded
= getDecodedObject(o
);
4280 o
= createStringObject(decoded
->ptr
, sdslen(decoded
->ptr
));
4281 decrRefCount(decoded
);
4282 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4285 if (c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
) {
4286 o
->ptr
= sdscatlen(o
->ptr
,
4287 c
->argv
[2]->ptr
, sdslen(c
->argv
[2]->ptr
));
4289 o
->ptr
= sdscatprintf(o
->ptr
, "%ld",
4290 (unsigned long) c
->argv
[2]->ptr
);
4292 totlen
= sdslen(o
->ptr
);
4295 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen
));
4298 static void substrCommand(redisClient
*c
) {
4300 long start
= atoi(c
->argv
[2]->ptr
);
4301 long end
= atoi(c
->argv
[3]->ptr
);
4302 size_t rangelen
, strlen
;
4305 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4306 checkType(c
,o
,REDIS_STRING
)) return;
4308 o
= getDecodedObject(o
);
4309 strlen
= sdslen(o
->ptr
);
4311 /* convert negative indexes */
4312 if (start
< 0) start
= strlen
+start
;
4313 if (end
< 0) end
= strlen
+end
;
4314 if (start
< 0) start
= 0;
4315 if (end
< 0) end
= 0;
4317 /* indexes sanity checks */
4318 if (start
> end
|| (size_t)start
>= strlen
) {
4319 /* Out of range start or start > end result in null reply */
4320 addReply(c
,shared
.nullbulk
);
4324 if ((size_t)end
>= strlen
) end
= strlen
-1;
4325 rangelen
= (end
-start
)+1;
4327 /* Return the result */
4328 addReplySds(c
,sdscatprintf(sdsempty(),"$%zu\r\n",rangelen
));
4329 range
= sdsnewlen((char*)o
->ptr
+start
,rangelen
);
4330 addReplySds(c
,range
);
4331 addReply(c
,shared
.crlf
);
4335 /* ========================= Type agnostic commands ========================= */
4337 static void delCommand(redisClient
*c
) {
4340 for (j
= 1; j
< c
->argc
; j
++) {
4341 if (deleteKey(c
->db
,c
->argv
[j
])) {
4346 addReplyLong(c
,deleted
);
4349 static void existsCommand(redisClient
*c
) {
4350 expireIfNeeded(c
->db
,c
->argv
[1]);
4351 if (dictFind(c
->db
->dict
,c
->argv
[1])) {
4352 addReply(c
, shared
.cone
);
4354 addReply(c
, shared
.czero
);
4358 static void selectCommand(redisClient
*c
) {
4359 int id
= atoi(c
->argv
[1]->ptr
);
4361 if (selectDb(c
,id
) == REDIS_ERR
) {
4362 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
4364 addReply(c
,shared
.ok
);
4368 static void randomkeyCommand(redisClient
*c
) {
4373 de
= dictGetRandomKey(c
->db
->dict
);
4374 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
4378 addReply(c
,shared
.nullbulk
);
4382 key
= dictGetEntryKey(de
);
4383 if (server
.vm_enabled
) {
4384 key
= dupStringObject(key
);
4385 addReplyBulk(c
,key
);
4388 addReplyBulk(c
,key
);
4392 static void keysCommand(redisClient
*c
) {
4395 sds pattern
= c
->argv
[1]->ptr
;
4396 int plen
= sdslen(pattern
);
4397 unsigned long numkeys
= 0;
4398 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
4400 di
= dictGetIterator(c
->db
->dict
);
4402 decrRefCount(lenobj
);
4403 while((de
= dictNext(di
)) != NULL
) {
4404 robj
*keyobj
= dictGetEntryKey(de
);
4406 sds key
= keyobj
->ptr
;
4407 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
4408 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
4409 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
4410 addReplyBulk(c
,keyobj
);
4415 dictReleaseIterator(di
);
4416 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",numkeys
);
4419 static void dbsizeCommand(redisClient
*c
) {
4421 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
4424 static void lastsaveCommand(redisClient
*c
) {
4426 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
4429 static void typeCommand(redisClient
*c
) {
4433 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4438 case REDIS_STRING
: type
= "+string"; break;
4439 case REDIS_LIST
: type
= "+list"; break;
4440 case REDIS_SET
: type
= "+set"; break;
4441 case REDIS_ZSET
: type
= "+zset"; break;
4442 case REDIS_HASH
: type
= "+hash"; break;
4443 default: type
= "+unknown"; break;
4446 addReplySds(c
,sdsnew(type
));
4447 addReply(c
,shared
.crlf
);
4450 static void saveCommand(redisClient
*c
) {
4451 if (server
.bgsavechildpid
!= -1) {
4452 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
4455 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4456 addReply(c
,shared
.ok
);
4458 addReply(c
,shared
.err
);
4462 static void bgsaveCommand(redisClient
*c
) {
4463 if (server
.bgsavechildpid
!= -1) {
4464 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
4467 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
4468 char *status
= "+Background saving started\r\n";
4469 addReplySds(c
,sdsnew(status
));
4471 addReply(c
,shared
.err
);
4475 static void shutdownCommand(redisClient
*c
) {
4476 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
4477 /* Kill the saving child if there is a background saving in progress.
4478 We want to avoid race conditions, for instance our saving child may
4479 overwrite the synchronous saving did by SHUTDOWN. */
4480 if (server
.bgsavechildpid
!= -1) {
4481 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
4482 kill(server
.bgsavechildpid
,SIGKILL
);
4483 rdbRemoveTempFile(server
.bgsavechildpid
);
4485 if (server
.appendonly
) {
4486 /* Append only file: fsync() the AOF and exit */
4487 fsync(server
.appendfd
);
4488 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4491 /* Snapshotting. Perform a SYNC SAVE and exit */
4492 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4493 if (server
.daemonize
)
4494 unlink(server
.pidfile
);
4495 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
4496 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
4499 /* Ooops.. error saving! The best we can do is to continue
4500 * operating. Note that if there was a background saving process,
4501 * in the next cron() Redis will be notified that the background
4502 * saving aborted, handling special stuff like slaves pending for
4503 * synchronization... */
4504 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
4506 sdsnew("-ERR can't quit, problems saving the DB\r\n"));
4511 static void renameGenericCommand(redisClient
*c
, int nx
) {
4514 /* To use the same key as src and dst is probably an error */
4515 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
4516 addReply(c
,shared
.sameobjecterr
);
4520 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
)
4524 deleteIfVolatile(c
->db
,c
->argv
[2]);
4525 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
4528 addReply(c
,shared
.czero
);
4531 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
4533 incrRefCount(c
->argv
[2]);
4535 deleteKey(c
->db
,c
->argv
[1]);
4537 addReply(c
,nx
? shared
.cone
: shared
.ok
);
4540 static void renameCommand(redisClient
*c
) {
4541 renameGenericCommand(c
,0);
4544 static void renamenxCommand(redisClient
*c
) {
4545 renameGenericCommand(c
,1);
4548 static void moveCommand(redisClient
*c
) {
4553 /* Obtain source and target DB pointers */
4556 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
4557 addReply(c
,shared
.outofrangeerr
);
4561 selectDb(c
,srcid
); /* Back to the source DB */
4563 /* If the user is moving using as target the same
4564 * DB as the source DB it is probably an error. */
4566 addReply(c
,shared
.sameobjecterr
);
4570 /* Check if the element exists and get a reference */
4571 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4573 addReply(c
,shared
.czero
);
4577 /* Try to add the element to the target DB */
4578 deleteIfVolatile(dst
,c
->argv
[1]);
4579 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
4580 addReply(c
,shared
.czero
);
4583 incrRefCount(c
->argv
[1]);
4586 /* OK! key moved, free the entry in the source DB */
4587 deleteKey(src
,c
->argv
[1]);
4589 addReply(c
,shared
.cone
);
4592 /* =================================== Lists ================================ */
4593 static void pushGenericCommand(redisClient
*c
, int where
) {
4597 lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4599 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4600 addReply(c
,shared
.cone
);
4603 lobj
= createListObject();
4605 if (where
== REDIS_HEAD
) {
4606 listAddNodeHead(list
,c
->argv
[2]);
4608 listAddNodeTail(list
,c
->argv
[2]);
4610 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
4611 incrRefCount(c
->argv
[1]);
4612 incrRefCount(c
->argv
[2]);
4614 if (lobj
->type
!= REDIS_LIST
) {
4615 addReply(c
,shared
.wrongtypeerr
);
4618 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4619 addReply(c
,shared
.cone
);
4623 if (where
== REDIS_HEAD
) {
4624 listAddNodeHead(list
,c
->argv
[2]);
4626 listAddNodeTail(list
,c
->argv
[2]);
4628 incrRefCount(c
->argv
[2]);
4631 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",listLength(list
)));
4634 static void lpushCommand(redisClient
*c
) {
4635 pushGenericCommand(c
,REDIS_HEAD
);
4638 static void rpushCommand(redisClient
*c
) {
4639 pushGenericCommand(c
,REDIS_TAIL
);
4642 static void llenCommand(redisClient
*c
) {
4646 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4647 checkType(c
,o
,REDIS_LIST
)) return;
4650 addReplyUlong(c
,listLength(l
));
4653 static void lindexCommand(redisClient
*c
) {
4655 int index
= atoi(c
->argv
[2]->ptr
);
4659 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4660 checkType(c
,o
,REDIS_LIST
)) return;
4663 ln
= listIndex(list
, index
);
4665 addReply(c
,shared
.nullbulk
);
4667 robj
*ele
= listNodeValue(ln
);
4668 addReplyBulk(c
,ele
);
4672 static void lsetCommand(redisClient
*c
) {
4674 int index
= atoi(c
->argv
[2]->ptr
);
4678 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
||
4679 checkType(c
,o
,REDIS_LIST
)) return;
4682 ln
= listIndex(list
, index
);
4684 addReply(c
,shared
.outofrangeerr
);
4686 robj
*ele
= listNodeValue(ln
);
4689 listNodeValue(ln
) = c
->argv
[3];
4690 incrRefCount(c
->argv
[3]);
4691 addReply(c
,shared
.ok
);
4696 static void popGenericCommand(redisClient
*c
, int where
) {
4701 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4702 checkType(c
,o
,REDIS_LIST
)) return;
4705 if (where
== REDIS_HEAD
)
4706 ln
= listFirst(list
);
4708 ln
= listLast(list
);
4711 addReply(c
,shared
.nullbulk
);
4713 robj
*ele
= listNodeValue(ln
);
4714 addReplyBulk(c
,ele
);
4715 listDelNode(list
,ln
);
4716 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4721 static void lpopCommand(redisClient
*c
) {
4722 popGenericCommand(c
,REDIS_HEAD
);
4725 static void rpopCommand(redisClient
*c
) {
4726 popGenericCommand(c
,REDIS_TAIL
);
4729 static void lrangeCommand(redisClient
*c
) {
4731 int start
= atoi(c
->argv
[2]->ptr
);
4732 int end
= atoi(c
->argv
[3]->ptr
);
4739 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
4740 || checkType(c
,o
,REDIS_LIST
)) return;
4742 llen
= listLength(list
);
4744 /* convert negative indexes */
4745 if (start
< 0) start
= llen
+start
;
4746 if (end
< 0) end
= llen
+end
;
4747 if (start
< 0) start
= 0;
4748 if (end
< 0) end
= 0;
4750 /* indexes sanity checks */
4751 if (start
> end
|| start
>= llen
) {
4752 /* Out of range start or start > end result in empty list */
4753 addReply(c
,shared
.emptymultibulk
);
4756 if (end
>= llen
) end
= llen
-1;
4757 rangelen
= (end
-start
)+1;
4759 /* Return the result in form of a multi-bulk reply */
4760 ln
= listIndex(list
, start
);
4761 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
4762 for (j
= 0; j
< rangelen
; j
++) {
4763 ele
= listNodeValue(ln
);
4764 addReplyBulk(c
,ele
);
4769 static void ltrimCommand(redisClient
*c
) {
4771 int start
= atoi(c
->argv
[2]->ptr
);
4772 int end
= atoi(c
->argv
[3]->ptr
);
4774 int j
, ltrim
, rtrim
;
4778 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.ok
)) == NULL
||
4779 checkType(c
,o
,REDIS_LIST
)) return;
4781 llen
= listLength(list
);
4783 /* convert negative indexes */
4784 if (start
< 0) start
= llen
+start
;
4785 if (end
< 0) end
= llen
+end
;
4786 if (start
< 0) start
= 0;
4787 if (end
< 0) end
= 0;
4789 /* indexes sanity checks */
4790 if (start
> end
|| start
>= llen
) {
4791 /* Out of range start or start > end result in empty list */
4795 if (end
>= llen
) end
= llen
-1;
4800 /* Remove list elements to perform the trim */
4801 for (j
= 0; j
< ltrim
; j
++) {
4802 ln
= listFirst(list
);
4803 listDelNode(list
,ln
);
4805 for (j
= 0; j
< rtrim
; j
++) {
4806 ln
= listLast(list
);
4807 listDelNode(list
,ln
);
4809 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4811 addReply(c
,shared
.ok
);
4814 static void lremCommand(redisClient
*c
) {
4817 listNode
*ln
, *next
;
4818 int toremove
= atoi(c
->argv
[2]->ptr
);
4822 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4823 checkType(c
,o
,REDIS_LIST
)) return;
4827 toremove
= -toremove
;
4830 ln
= fromtail
? list
->tail
: list
->head
;
4832 robj
*ele
= listNodeValue(ln
);
4834 next
= fromtail
? ln
->prev
: ln
->next
;
4835 if (compareStringObjects(ele
,c
->argv
[3]) == 0) {
4836 listDelNode(list
,ln
);
4839 if (toremove
&& removed
== toremove
) break;
4843 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4844 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
4847 /* This is the semantic of this command:
4848 * RPOPLPUSH srclist dstlist:
4849 * IF LLEN(srclist) > 0
4850 * element = RPOP srclist
4851 * LPUSH dstlist element
4858 * The idea is to be able to get an element from a list in a reliable way
4859 * since the element is not just returned but pushed against another list
4860 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4862 static void rpoplpushcommand(redisClient
*c
) {
4867 if ((sobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4868 checkType(c
,sobj
,REDIS_LIST
)) return;
4869 srclist
= sobj
->ptr
;
4870 ln
= listLast(srclist
);
4873 addReply(c
,shared
.nullbulk
);
4875 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4876 robj
*ele
= listNodeValue(ln
);
4879 if (dobj
&& dobj
->type
!= REDIS_LIST
) {
4880 addReply(c
,shared
.wrongtypeerr
);
4884 /* Add the element to the target list (unless it's directly
4885 * passed to some BLPOP-ing client */
4886 if (!handleClientsWaitingListPush(c
,c
->argv
[2],ele
)) {
4888 /* Create the list if the key does not exist */
4889 dobj
= createListObject();
4890 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
4891 incrRefCount(c
->argv
[2]);
4893 dstlist
= dobj
->ptr
;
4894 listAddNodeHead(dstlist
,ele
);
4898 /* Send the element to the client as reply as well */
4899 addReplyBulk(c
,ele
);
4901 /* Finally remove the element from the source list */
4902 listDelNode(srclist
,ln
);
4903 if (listLength(srclist
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4908 /* ==================================== Sets ================================ */
4910 static void saddCommand(redisClient
*c
) {
4913 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4915 set
= createSetObject();
4916 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
4917 incrRefCount(c
->argv
[1]);
4919 if (set
->type
!= REDIS_SET
) {
4920 addReply(c
,shared
.wrongtypeerr
);
4924 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
4925 incrRefCount(c
->argv
[2]);
4927 addReply(c
,shared
.cone
);
4929 addReply(c
,shared
.czero
);
4933 static void sremCommand(redisClient
*c
) {
4936 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4937 checkType(c
,set
,REDIS_SET
)) return;
4939 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
4941 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4942 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4943 addReply(c
,shared
.cone
);
4945 addReply(c
,shared
.czero
);
4949 static void smoveCommand(redisClient
*c
) {
4950 robj
*srcset
, *dstset
;
4952 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4953 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4955 /* If the source key does not exist return 0, if it's of the wrong type
4957 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
4958 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
4961 /* Error if the destination key is not a set as well */
4962 if (dstset
&& dstset
->type
!= REDIS_SET
) {
4963 addReply(c
,shared
.wrongtypeerr
);
4966 /* Remove the element from the source set */
4967 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
4968 /* Key not found in the src set! return zero */
4969 addReply(c
,shared
.czero
);
4972 if (dictSize((dict
*)srcset
->ptr
) == 0 && srcset
!= dstset
)
4973 deleteKey(c
->db
,c
->argv
[1]);
4975 /* Add the element to the destination set */
4977 dstset
= createSetObject();
4978 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
4979 incrRefCount(c
->argv
[2]);
4981 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
4982 incrRefCount(c
->argv
[3]);
4983 addReply(c
,shared
.cone
);
4986 static void sismemberCommand(redisClient
*c
) {
4989 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4990 checkType(c
,set
,REDIS_SET
)) return;
4992 if (dictFind(set
->ptr
,c
->argv
[2]))
4993 addReply(c
,shared
.cone
);
4995 addReply(c
,shared
.czero
);
4998 static void scardCommand(redisClient
*c
) {
5002 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5003 checkType(c
,o
,REDIS_SET
)) return;
5006 addReplyUlong(c
,dictSize(s
));
5009 static void spopCommand(redisClient
*c
) {
5013 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5014 checkType(c
,set
,REDIS_SET
)) return;
5016 de
= dictGetRandomKey(set
->ptr
);
5018 addReply(c
,shared
.nullbulk
);
5020 robj
*ele
= dictGetEntryKey(de
);
5022 addReplyBulk(c
,ele
);
5023 dictDelete(set
->ptr
,ele
);
5024 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
5025 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5030 static void srandmemberCommand(redisClient
*c
) {
5034 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5035 checkType(c
,set
,REDIS_SET
)) return;
5037 de
= dictGetRandomKey(set
->ptr
);
5039 addReply(c
,shared
.nullbulk
);
5041 robj
*ele
= dictGetEntryKey(de
);
5043 addReplyBulk(c
,ele
);
5047 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
5048 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
5050 return dictSize(*d1
)-dictSize(*d2
);
5053 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
5054 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
5057 robj
*lenobj
= NULL
, *dstset
= NULL
;
5058 unsigned long j
, cardinality
= 0;
5060 for (j
= 0; j
< setsnum
; j
++) {
5064 lookupKeyWrite(c
->db
,setskeys
[j
]) :
5065 lookupKeyRead(c
->db
,setskeys
[j
]);
5069 if (deleteKey(c
->db
,dstkey
))
5071 addReply(c
,shared
.czero
);
5073 addReply(c
,shared
.emptymultibulk
);
5077 if (setobj
->type
!= REDIS_SET
) {
5079 addReply(c
,shared
.wrongtypeerr
);
5082 dv
[j
] = setobj
->ptr
;
5084 /* Sort sets from the smallest to largest, this will improve our
5085 * algorithm's performace */
5086 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
5088 /* The first thing we should output is the total number of elements...
5089 * since this is a multi-bulk write, but at this stage we don't know
5090 * the intersection set size, so we use a trick, append an empty object
5091 * to the output list and save the pointer to later modify it with the
5094 lenobj
= createObject(REDIS_STRING
,NULL
);
5096 decrRefCount(lenobj
);
5098 /* If we have a target key where to store the resulting set
5099 * create this key with an empty set inside */
5100 dstset
= createSetObject();
5103 /* Iterate all the elements of the first (smallest) set, and test
5104 * the element against all the other sets, if at least one set does
5105 * not include the element it is discarded */
5106 di
= dictGetIterator(dv
[0]);
5108 while((de
= dictNext(di
)) != NULL
) {
5111 for (j
= 1; j
< setsnum
; j
++)
5112 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
5114 continue; /* at least one set does not contain the member */
5115 ele
= dictGetEntryKey(de
);
5117 addReplyBulk(c
,ele
);
5120 dictAdd(dstset
->ptr
,ele
,NULL
);
5124 dictReleaseIterator(di
);
5127 /* Store the resulting set into the target, if the intersection
5128 * is not an empty set. */
5129 deleteKey(c
->db
,dstkey
);
5130 if (dictSize((dict
*)dstset
->ptr
) > 0) {
5131 dictAdd(c
->db
->dict
,dstkey
,dstset
);
5132 incrRefCount(dstkey
);
5133 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
5135 decrRefCount(dstset
);
5136 addReply(c
,shared
.czero
);
5140 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
5145 static void sinterCommand(redisClient
*c
) {
5146 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
5149 static void sinterstoreCommand(redisClient
*c
) {
5150 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
5153 #define REDIS_OP_UNION 0
5154 #define REDIS_OP_DIFF 1
5155 #define REDIS_OP_INTER 2
5157 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
5158 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
5161 robj
*dstset
= NULL
;
5162 int j
, cardinality
= 0;
5164 for (j
= 0; j
< setsnum
; j
++) {
5168 lookupKeyWrite(c
->db
,setskeys
[j
]) :
5169 lookupKeyRead(c
->db
,setskeys
[j
]);
5174 if (setobj
->type
!= REDIS_SET
) {
5176 addReply(c
,shared
.wrongtypeerr
);
5179 dv
[j
] = setobj
->ptr
;
5182 /* We need a temp set object to store our union. If the dstkey
5183 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
5184 * this set object will be the resulting object to set into the target key*/
5185 dstset
= createSetObject();
5187 /* Iterate all the elements of all the sets, add every element a single
5188 * time to the result set */
5189 for (j
= 0; j
< setsnum
; j
++) {
5190 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
5191 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
5193 di
= dictGetIterator(dv
[j
]);
5195 while((de
= dictNext(di
)) != NULL
) {
5198 /* dictAdd will not add the same element multiple times */
5199 ele
= dictGetEntryKey(de
);
5200 if (op
== REDIS_OP_UNION
|| j
== 0) {
5201 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
5205 } else if (op
== REDIS_OP_DIFF
) {
5206 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
5211 dictReleaseIterator(di
);
5213 /* result set is empty? Exit asap. */
5214 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break;
5217 /* Output the content of the resulting set, if not in STORE mode */
5219 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
5220 di
= dictGetIterator(dstset
->ptr
);
5221 while((de
= dictNext(di
)) != NULL
) {
5224 ele
= dictGetEntryKey(de
);
5225 addReplyBulk(c
,ele
);
5227 dictReleaseIterator(di
);
5228 decrRefCount(dstset
);
5230 /* If we have a target key where to store the resulting set
5231 * create this key with the result set inside */
5232 deleteKey(c
->db
,dstkey
);
5233 if (dictSize((dict
*)dstset
->ptr
) > 0) {
5234 dictAdd(c
->db
->dict
,dstkey
,dstset
);
5235 incrRefCount(dstkey
);
5236 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
5238 decrRefCount(dstset
);
5239 addReply(c
,shared
.czero
);
5246 static void sunionCommand(redisClient
*c
) {
5247 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
5250 static void sunionstoreCommand(redisClient
*c
) {
5251 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
5254 static void sdiffCommand(redisClient
*c
) {
5255 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
5258 static void sdiffstoreCommand(redisClient
*c
) {
5259 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
5262 /* ==================================== ZSets =============================== */
5264 /* ZSETs are ordered sets using two data structures to hold the same elements
5265 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
5268 * The elements are added to an hash table mapping Redis objects to scores.
5269 * At the same time the elements are added to a skip list mapping scores
5270 * to Redis objects (so objects are sorted by scores in this "view"). */
5272 /* This skiplist implementation is almost a C translation of the original
5273 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
5274 * Alternative to Balanced Trees", modified in three ways:
5275 * a) this implementation allows for repeated values.
5276 * b) the comparison is not just by key (our 'score') but by satellite data.
5277 * c) there is a back pointer, so it's a doubly linked list with the back
5278 * pointers being only at "level 1". This allows to traverse the list
5279 * from tail to head, useful for ZREVRANGE. */
5281 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
5282 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
5284 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
5286 zn
->span
= zmalloc(sizeof(unsigned int) * (level
- 1));
5292 static zskiplist
*zslCreate(void) {
5296 zsl
= zmalloc(sizeof(*zsl
));
5299 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
5300 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++) {
5301 zsl
->header
->forward
[j
] = NULL
;
5303 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
5304 if (j
< ZSKIPLIST_MAXLEVEL
-1)
5305 zsl
->header
->span
[j
] = 0;
5307 zsl
->header
->backward
= NULL
;
5312 static void zslFreeNode(zskiplistNode
*node
) {
5313 decrRefCount(node
->obj
);
5314 zfree(node
->forward
);
5319 static void zslFree(zskiplist
*zsl
) {
5320 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
5322 zfree(zsl
->header
->forward
);
5323 zfree(zsl
->header
->span
);
5326 next
= node
->forward
[0];
5333 static int zslRandomLevel(void) {
5335 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
5337 return (level
<ZSKIPLIST_MAXLEVEL
) ? level
: ZSKIPLIST_MAXLEVEL
;
5340 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
5341 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5342 unsigned int rank
[ZSKIPLIST_MAXLEVEL
];
5346 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5347 /* store rank that is crossed to reach the insert position */
5348 rank
[i
] = i
== (zsl
->level
-1) ? 0 : rank
[i
+1];
5350 while (x
->forward
[i
] &&
5351 (x
->forward
[i
]->score
< score
||
5352 (x
->forward
[i
]->score
== score
&&
5353 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0))) {
5354 rank
[i
] += i
> 0 ? x
->span
[i
-1] : 1;
5359 /* we assume the key is not already inside, since we allow duplicated
5360 * scores, and the re-insertion of score and redis object should never
5361 * happpen since the caller of zslInsert() should test in the hash table
5362 * if the element is already inside or not. */
5363 level
= zslRandomLevel();
5364 if (level
> zsl
->level
) {
5365 for (i
= zsl
->level
; i
< level
; i
++) {
5367 update
[i
] = zsl
->header
;
5368 update
[i
]->span
[i
-1] = zsl
->length
;
5372 x
= zslCreateNode(level
,score
,obj
);
5373 for (i
= 0; i
< level
; i
++) {
5374 x
->forward
[i
] = update
[i
]->forward
[i
];
5375 update
[i
]->forward
[i
] = x
;
5377 /* update span covered by update[i] as x is inserted here */
5379 x
->span
[i
-1] = update
[i
]->span
[i
-1] - (rank
[0] - rank
[i
]);
5380 update
[i
]->span
[i
-1] = (rank
[0] - rank
[i
]) + 1;
5384 /* increment span for untouched levels */
5385 for (i
= level
; i
< zsl
->level
; i
++) {
5386 update
[i
]->span
[i
-1]++;
5389 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
5391 x
->forward
[0]->backward
= x
;
5397 /* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank */
5398 void zslDeleteNode(zskiplist
*zsl
, zskiplistNode
*x
, zskiplistNode
**update
) {
5400 for (i
= 0; i
< zsl
->level
; i
++) {
5401 if (update
[i
]->forward
[i
] == x
) {
5403 update
[i
]->span
[i
-1] += x
->span
[i
-1] - 1;
5405 update
[i
]->forward
[i
] = x
->forward
[i
];
5407 /* invariant: i > 0, because update[0]->forward[0]
5408 * is always equal to x */
5409 update
[i
]->span
[i
-1] -= 1;
5412 if (x
->forward
[0]) {
5413 x
->forward
[0]->backward
= x
->backward
;
5415 zsl
->tail
= x
->backward
;
5417 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
5422 /* Delete an element with matching score/object from the skiplist. */
5423 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
5424 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5428 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5429 while (x
->forward
[i
] &&
5430 (x
->forward
[i
]->score
< score
||
5431 (x
->forward
[i
]->score
== score
&&
5432 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
5436 /* We may have multiple elements with the same score, what we need
5437 * is to find the element with both the right score and object. */
5439 if (x
&& score
== x
->score
&& compareStringObjects(x
->obj
,obj
) == 0) {
5440 zslDeleteNode(zsl
, x
, update
);
5444 return 0; /* not found */
5446 return 0; /* not found */
5449 /* Delete all the elements with score between min and max from the skiplist.
5450 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
5451 * Note that this function takes the reference to the hash table view of the
5452 * sorted set, in order to remove the elements from the hash table too. */
5453 static unsigned long zslDeleteRangeByScore(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
5454 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5455 unsigned long removed
= 0;
5459 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5460 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
5464 /* We may have multiple elements with the same score, what we need
5465 * is to find the element with both the right score and object. */
5467 while (x
&& x
->score
<= max
) {
5468 zskiplistNode
*next
= x
->forward
[0];
5469 zslDeleteNode(zsl
, x
, update
);
5470 dictDelete(dict
,x
->obj
);
5475 return removed
; /* not found */
5478 /* Delete all the elements with rank between start and end from the skiplist.
5479 * Start and end are inclusive. Note that start and end need to be 1-based */
5480 static unsigned long zslDeleteRangeByRank(zskiplist
*zsl
, unsigned int start
, unsigned int end
, dict
*dict
) {
5481 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5482 unsigned long traversed
= 0, removed
= 0;
5486 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5487 while (x
->forward
[i
] && (traversed
+ (i
> 0 ? x
->span
[i
-1] : 1)) < start
) {
5488 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5496 while (x
&& traversed
<= end
) {
5497 zskiplistNode
*next
= x
->forward
[0];
5498 zslDeleteNode(zsl
, x
, update
);
5499 dictDelete(dict
,x
->obj
);
5508 /* Find the first node having a score equal or greater than the specified one.
5509 * Returns NULL if there is no match. */
5510 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
5515 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5516 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
5519 /* We may have multiple elements with the same score, what we need
5520 * is to find the element with both the right score and object. */
5521 return x
->forward
[0];
5524 /* Find the rank for an element by both score and key.
5525 * Returns 0 when the element cannot be found, rank otherwise.
5526 * Note that the rank is 1-based due to the span of zsl->header to the
5528 static unsigned long zslGetRank(zskiplist
*zsl
, double score
, robj
*o
) {
5530 unsigned long rank
= 0;
5534 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5535 while (x
->forward
[i
] &&
5536 (x
->forward
[i
]->score
< score
||
5537 (x
->forward
[i
]->score
== score
&&
5538 compareStringObjects(x
->forward
[i
]->obj
,o
) <= 0))) {
5539 rank
+= i
> 0 ? x
->span
[i
-1] : 1;
5543 /* x might be equal to zsl->header, so test if obj is non-NULL */
5544 if (x
->obj
&& compareStringObjects(x
->obj
,o
) == 0) {
5551 /* Finds an element by its rank. The rank argument needs to be 1-based. */
5552 zskiplistNode
* zslGetElementByRank(zskiplist
*zsl
, unsigned long rank
) {
5554 unsigned long traversed
= 0;
5558 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5559 while (x
->forward
[i
] && (traversed
+ (i
>0 ? x
->span
[i
-1] : 1)) <= rank
)
5561 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5564 if (traversed
== rank
) {
5571 /* The actual Z-commands implementations */
5573 /* This generic command implements both ZADD and ZINCRBY.
5574 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
5575 * the increment if the operation is a ZINCRBY (doincrement == 1). */
5576 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
5581 zsetobj
= lookupKeyWrite(c
->db
,key
);
5582 if (zsetobj
== NULL
) {
5583 zsetobj
= createZsetObject();
5584 dictAdd(c
->db
->dict
,key
,zsetobj
);
5587 if (zsetobj
->type
!= REDIS_ZSET
) {
5588 addReply(c
,shared
.wrongtypeerr
);
5594 /* Ok now since we implement both ZADD and ZINCRBY here the code
5595 * needs to handle the two different conditions. It's all about setting
5596 * '*score', that is, the new score to set, to the right value. */
5597 score
= zmalloc(sizeof(double));
5601 /* Read the old score. If the element was not present starts from 0 */
5602 de
= dictFind(zs
->dict
,ele
);
5604 double *oldscore
= dictGetEntryVal(de
);
5605 *score
= *oldscore
+ scoreval
;
5613 /* What follows is a simple remove and re-insert operation that is common
5614 * to both ZADD and ZINCRBY... */
5615 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
5616 /* case 1: New element */
5617 incrRefCount(ele
); /* added to hash */
5618 zslInsert(zs
->zsl
,*score
,ele
);
5619 incrRefCount(ele
); /* added to skiplist */
5622 addReplyDouble(c
,*score
);
5624 addReply(c
,shared
.cone
);
5629 /* case 2: Score update operation */
5630 de
= dictFind(zs
->dict
,ele
);
5631 redisAssert(de
!= NULL
);
5632 oldscore
= dictGetEntryVal(de
);
5633 if (*score
!= *oldscore
) {
5636 /* Remove and insert the element in the skip list with new score */
5637 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
5638 redisAssert(deleted
!= 0);
5639 zslInsert(zs
->zsl
,*score
,ele
);
5641 /* Update the score in the hash table */
5642 dictReplace(zs
->dict
,ele
,score
);
5648 addReplyDouble(c
,*score
);
5650 addReply(c
,shared
.czero
);
5654 static void zaddCommand(redisClient
*c
) {
5657 if (getDoubleFromObjectOrReply(c
, c
->argv
[2], &scoreval
, NULL
) != REDIS_OK
) return;
5658 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
5661 static void zincrbyCommand(redisClient
*c
) {
5664 if (getDoubleFromObjectOrReply(c
, c
->argv
[2], &scoreval
, NULL
) != REDIS_OK
) return;
5665 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
5668 static void zremCommand(redisClient
*c
) {
5675 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5676 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5679 de
= dictFind(zs
->dict
,c
->argv
[2]);
5681 addReply(c
,shared
.czero
);
5684 /* Delete from the skiplist */
5685 oldscore
= dictGetEntryVal(de
);
5686 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
5687 redisAssert(deleted
!= 0);
5689 /* Delete from the hash table */
5690 dictDelete(zs
->dict
,c
->argv
[2]);
5691 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5692 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5694 addReply(c
,shared
.cone
);
5697 static void zremrangebyscoreCommand(redisClient
*c
) {
5704 if ((getDoubleFromObjectOrReply(c
, c
->argv
[2], &min
, NULL
) != REDIS_OK
) ||
5705 (getDoubleFromObjectOrReply(c
, c
->argv
[3], &max
, NULL
) != REDIS_OK
)) return;
5707 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5708 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5711 deleted
= zslDeleteRangeByScore(zs
->zsl
,min
,max
,zs
->dict
);
5712 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5713 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5714 server
.dirty
+= deleted
;
5715 addReplyLong(c
,deleted
);
5718 static void zremrangebyrankCommand(redisClient
*c
) {
5726 if ((getLongFromObjectOrReply(c
, c
->argv
[2], &start
, NULL
) != REDIS_OK
) ||
5727 (getLongFromObjectOrReply(c
, c
->argv
[3], &end
, NULL
) != REDIS_OK
)) return;
5729 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5730 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5732 llen
= zs
->zsl
->length
;
5734 /* convert negative indexes */
5735 if (start
< 0) start
= llen
+start
;
5736 if (end
< 0) end
= llen
+end
;
5737 if (start
< 0) start
= 0;
5738 if (end
< 0) end
= 0;
5740 /* indexes sanity checks */
5741 if (start
> end
|| start
>= llen
) {
5742 addReply(c
,shared
.czero
);
5745 if (end
>= llen
) end
= llen
-1;
5747 /* increment start and end because zsl*Rank functions
5748 * use 1-based rank */
5749 deleted
= zslDeleteRangeByRank(zs
->zsl
,start
+1,end
+1,zs
->dict
);
5750 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5751 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5752 server
.dirty
+= deleted
;
5753 addReplyLong(c
, deleted
);
5761 static int qsortCompareZsetopsrcByCardinality(const void *s1
, const void *s2
) {
5762 zsetopsrc
*d1
= (void*) s1
, *d2
= (void*) s2
;
5763 unsigned long size1
, size2
;
5764 size1
= d1
->dict
? dictSize(d1
->dict
) : 0;
5765 size2
= d2
->dict
? dictSize(d2
->dict
) : 0;
5766 return size1
- size2
;
5769 #define REDIS_AGGR_SUM 1
5770 #define REDIS_AGGR_MIN 2
5771 #define REDIS_AGGR_MAX 3
5773 inline static void zunionInterAggregate(double *target
, double val
, int aggregate
) {
5774 if (aggregate
== REDIS_AGGR_SUM
) {
5775 *target
= *target
+ val
;
5776 } else if (aggregate
== REDIS_AGGR_MIN
) {
5777 *target
= val
< *target
? val
: *target
;
5778 } else if (aggregate
== REDIS_AGGR_MAX
) {
5779 *target
= val
> *target
? val
: *target
;
5782 redisPanic("Unknown ZUNION/INTER aggregate type");
5786 static void zunionInterGenericCommand(redisClient
*c
, robj
*dstkey
, int op
) {
5788 int aggregate
= REDIS_AGGR_SUM
;
5795 /* expect zsetnum input keys to be given */
5796 zsetnum
= atoi(c
->argv
[2]->ptr
);
5798 addReplySds(c
,sdsnew("-ERR at least 1 input key is needed for ZUNION/ZINTER\r\n"));
5802 /* test if the expected number of keys would overflow */
5803 if (3+zsetnum
> c
->argc
) {
5804 addReply(c
,shared
.syntaxerr
);
5808 /* read keys to be used for input */
5809 src
= zmalloc(sizeof(zsetopsrc
) * zsetnum
);
5810 for (i
= 0, j
= 3; i
< zsetnum
; i
++, j
++) {
5811 robj
*zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
5815 if (zsetobj
->type
!= REDIS_ZSET
) {
5817 addReply(c
,shared
.wrongtypeerr
);
5820 src
[i
].dict
= ((zset
*)zsetobj
->ptr
)->dict
;
5823 /* default all weights to 1 */
5824 src
[i
].weight
= 1.0;
5827 /* parse optional extra arguments */
5829 int remaining
= c
->argc
- j
;
5832 if (remaining
>= (zsetnum
+ 1) && !strcasecmp(c
->argv
[j
]->ptr
,"weights")) {
5834 for (i
= 0; i
< zsetnum
; i
++, j
++, remaining
--) {
5835 if (getDoubleFromObjectOrReply(c
, c
->argv
[j
], &src
[i
].weight
, NULL
) != REDIS_OK
)
5838 } else if (remaining
>= 2 && !strcasecmp(c
->argv
[j
]->ptr
,"aggregate")) {
5840 if (!strcasecmp(c
->argv
[j
]->ptr
,"sum")) {
5841 aggregate
= REDIS_AGGR_SUM
;
5842 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"min")) {
5843 aggregate
= REDIS_AGGR_MIN
;
5844 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"max")) {
5845 aggregate
= REDIS_AGGR_MAX
;
5848 addReply(c
,shared
.syntaxerr
);
5854 addReply(c
,shared
.syntaxerr
);
5860 /* sort sets from the smallest to largest, this will improve our
5861 * algorithm's performance */
5862 qsort(src
,zsetnum
,sizeof(zsetopsrc
), qsortCompareZsetopsrcByCardinality
);
5864 dstobj
= createZsetObject();
5865 dstzset
= dstobj
->ptr
;
5867 if (op
== REDIS_OP_INTER
) {
5868 /* skip going over all entries if the smallest zset is NULL or empty */
5869 if (src
[0].dict
&& dictSize(src
[0].dict
) > 0) {
5870 /* precondition: as src[0].dict is non-empty and the zsets are ordered
5871 * from small to large, all src[i > 0].dict are non-empty too */
5872 di
= dictGetIterator(src
[0].dict
);
5873 while((de
= dictNext(di
)) != NULL
) {
5874 double *score
= zmalloc(sizeof(double)), value
;
5875 *score
= src
[0].weight
* (*(double*)dictGetEntryVal(de
));
5877 for (j
= 1; j
< zsetnum
; j
++) {
5878 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5880 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5881 zunionInterAggregate(score
, value
, aggregate
);
5887 /* skip entry when not present in every source dict */
5891 robj
*o
= dictGetEntryKey(de
);
5892 dictAdd(dstzset
->dict
,o
,score
);
5893 incrRefCount(o
); /* added to dictionary */
5894 zslInsert(dstzset
->zsl
,*score
,o
);
5895 incrRefCount(o
); /* added to skiplist */
5898 dictReleaseIterator(di
);
5900 } else if (op
== REDIS_OP_UNION
) {
5901 for (i
= 0; i
< zsetnum
; i
++) {
5902 if (!src
[i
].dict
) continue;
5904 di
= dictGetIterator(src
[i
].dict
);
5905 while((de
= dictNext(di
)) != NULL
) {
5906 /* skip key when already processed */
5907 if (dictFind(dstzset
->dict
,dictGetEntryKey(de
)) != NULL
) continue;
5909 double *score
= zmalloc(sizeof(double)), value
;
5910 *score
= src
[i
].weight
* (*(double*)dictGetEntryVal(de
));
5912 /* because the zsets are sorted by size, its only possible
5913 * for sets at larger indices to hold this entry */
5914 for (j
= (i
+1); j
< zsetnum
; j
++) {
5915 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5917 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5918 zunionInterAggregate(score
, value
, aggregate
);
5922 robj
*o
= dictGetEntryKey(de
);
5923 dictAdd(dstzset
->dict
,o
,score
);
5924 incrRefCount(o
); /* added to dictionary */
5925 zslInsert(dstzset
->zsl
,*score
,o
);
5926 incrRefCount(o
); /* added to skiplist */
5928 dictReleaseIterator(di
);
5931 /* unknown operator */
5932 redisAssert(op
== REDIS_OP_INTER
|| op
== REDIS_OP_UNION
);
5935 deleteKey(c
->db
,dstkey
);
5936 if (dstzset
->zsl
->length
) {
5937 dictAdd(c
->db
->dict
,dstkey
,dstobj
);
5938 incrRefCount(dstkey
);
5939 addReplyLong(c
, dstzset
->zsl
->length
);
5942 decrRefCount(dstobj
);
5943 addReply(c
, shared
.czero
);
5948 static void zunionCommand(redisClient
*c
) {
5949 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_UNION
);
5952 static void zinterCommand(redisClient
*c
) {
5953 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_INTER
);
5956 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
5968 if ((getLongFromObjectOrReply(c
, c
->argv
[2], &start
, NULL
) != REDIS_OK
) ||
5969 (getLongFromObjectOrReply(c
, c
->argv
[3], &end
, NULL
) != REDIS_OK
)) return;
5971 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
5973 } else if (c
->argc
>= 5) {
5974 addReply(c
,shared
.syntaxerr
);
5978 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
5979 || checkType(c
,o
,REDIS_ZSET
)) return;
5984 /* convert negative indexes */
5985 if (start
< 0) start
= llen
+start
;
5986 if (end
< 0) end
= llen
+end
;
5987 if (start
< 0) start
= 0;
5988 if (end
< 0) end
= 0;
5990 /* indexes sanity checks */
5991 if (start
> end
|| start
>= llen
) {
5992 /* Out of range start or start > end result in empty list */
5993 addReply(c
,shared
.emptymultibulk
);
5996 if (end
>= llen
) end
= llen
-1;
5997 rangelen
= (end
-start
)+1;
5999 /* check if starting point is trivial, before searching
6000 * the element in log(N) time */
6002 ln
= start
== 0 ? zsl
->tail
: zslGetElementByRank(zsl
, llen
-start
);
6005 zsl
->header
->forward
[0] : zslGetElementByRank(zsl
, start
+1);
6008 /* Return the result in form of a multi-bulk reply */
6009 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
6010 withscores
? (rangelen
*2) : rangelen
));
6011 for (j
= 0; j
< rangelen
; j
++) {
6013 addReplyBulk(c
,ele
);
6015 addReplyDouble(c
,ln
->score
);
6016 ln
= reverse
? ln
->backward
: ln
->forward
[0];
6020 static void zrangeCommand(redisClient
*c
) {
6021 zrangeGenericCommand(c
,0);
6024 static void zrevrangeCommand(redisClient
*c
) {
6025 zrangeGenericCommand(c
,1);
6028 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
6029 * If justcount is non-zero, just the count is returned. */
6030 static void genericZrangebyscoreCommand(redisClient
*c
, int justcount
) {
6033 int minex
= 0, maxex
= 0; /* are min or max exclusive? */
6034 int offset
= 0, limit
= -1;
6038 /* Parse the min-max interval. If one of the values is prefixed
6039 * by the "(" character, it's considered "open". For instance
6040 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
6041 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
6042 if (((char*)c
->argv
[2]->ptr
)[0] == '(') {
6043 min
= strtod((char*)c
->argv
[2]->ptr
+1,NULL
);
6046 min
= strtod(c
->argv
[2]->ptr
,NULL
);
6048 if (((char*)c
->argv
[3]->ptr
)[0] == '(') {
6049 max
= strtod((char*)c
->argv
[3]->ptr
+1,NULL
);
6052 max
= strtod(c
->argv
[3]->ptr
,NULL
);
6055 /* Parse "WITHSCORES": note that if the command was called with
6056 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
6057 * enter the following paths to parse WITHSCORES and LIMIT. */
6058 if (c
->argc
== 5 || c
->argc
== 8) {
6059 if (strcasecmp(c
->argv
[c
->argc
-1]->ptr
,"withscores") == 0)
6064 if (c
->argc
!= (4 + withscores
) && c
->argc
!= (7 + withscores
))
6068 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
6073 if (c
->argc
== (7 + withscores
) && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
6074 addReply(c
,shared
.syntaxerr
);
6076 } else if (c
->argc
== (7 + withscores
)) {
6077 offset
= atoi(c
->argv
[5]->ptr
);
6078 limit
= atoi(c
->argv
[6]->ptr
);
6079 if (offset
< 0) offset
= 0;
6082 /* Ok, lookup the key and get the range */
6083 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
6085 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
6087 if (o
->type
!= REDIS_ZSET
) {
6088 addReply(c
,shared
.wrongtypeerr
);
6090 zset
*zsetobj
= o
->ptr
;
6091 zskiplist
*zsl
= zsetobj
->zsl
;
6093 robj
*ele
, *lenobj
= NULL
;
6094 unsigned long rangelen
= 0;
6096 /* Get the first node with the score >= min, or with
6097 * score > min if 'minex' is true. */
6098 ln
= zslFirstWithScore(zsl
,min
);
6099 while (minex
&& ln
&& ln
->score
== min
) ln
= ln
->forward
[0];
6102 /* No element matching the speciifed interval */
6103 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
6107 /* We don't know in advance how many matching elements there
6108 * are in the list, so we push this object that will represent
6109 * the multi-bulk length in the output buffer, and will "fix"
6112 lenobj
= createObject(REDIS_STRING
,NULL
);
6114 decrRefCount(lenobj
);
6117 while(ln
&& (maxex
? (ln
->score
< max
) : (ln
->score
<= max
))) {
6120 ln
= ln
->forward
[0];
6123 if (limit
== 0) break;
6126 addReplyBulk(c
,ele
);
6128 addReplyDouble(c
,ln
->score
);
6130 ln
= ln
->forward
[0];
6132 if (limit
> 0) limit
--;
6135 addReplyLong(c
,(long)rangelen
);
6137 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",
6138 withscores
? (rangelen
*2) : rangelen
);
6144 static void zrangebyscoreCommand(redisClient
*c
) {
6145 genericZrangebyscoreCommand(c
,0);
6148 static void zcountCommand(redisClient
*c
) {
6149 genericZrangebyscoreCommand(c
,1);
6152 static void zcardCommand(redisClient
*c
) {
6156 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6157 checkType(c
,o
,REDIS_ZSET
)) return;
6160 addReplyUlong(c
,zs
->zsl
->length
);
6163 static void zscoreCommand(redisClient
*c
) {
6168 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6169 checkType(c
,o
,REDIS_ZSET
)) return;
6172 de
= dictFind(zs
->dict
,c
->argv
[2]);
6174 addReply(c
,shared
.nullbulk
);
6176 double *score
= dictGetEntryVal(de
);
6178 addReplyDouble(c
,*score
);
6182 static void zrankGenericCommand(redisClient
*c
, int reverse
) {
6190 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6191 checkType(c
,o
,REDIS_ZSET
)) return;
6195 de
= dictFind(zs
->dict
,c
->argv
[2]);
6197 addReply(c
,shared
.nullbulk
);
6201 score
= dictGetEntryVal(de
);
6202 rank
= zslGetRank(zsl
, *score
, c
->argv
[2]);
6205 addReplyLong(c
, zsl
->length
- rank
);
6207 addReplyLong(c
, rank
-1);
6210 addReply(c
,shared
.nullbulk
);
6214 static void zrankCommand(redisClient
*c
) {
6215 zrankGenericCommand(c
, 0);
6218 static void zrevrankCommand(redisClient
*c
) {
6219 zrankGenericCommand(c
, 1);
6222 /* ========================= Hashes utility functions ======================= */
6223 #define REDIS_HASH_KEY 1
6224 #define REDIS_HASH_VALUE 2
6226 /* Check the length of a number of objects to see if we need to convert a
6227 * zipmap to a real hash. Note that we only check string encoded objects
6228 * as their string length can be queried in constant time. */
6229 static void hashTryConversion(robj
*subject
, robj
**argv
, int start
, int end
) {
6231 if (subject
->encoding
!= REDIS_ENCODING_ZIPMAP
) return;
6233 for (i
= start
; i
<= end
; i
++) {
6234 if (argv
[i
]->encoding
== REDIS_ENCODING_RAW
&&
6235 sdslen(argv
[i
]->ptr
) > server
.hash_max_zipmap_value
)
6237 convertToRealHash(subject
);
6243 /* Encode given objects in-place when the hash uses a dict. */
6244 static void hashTryObjectEncoding(robj
*subject
, robj
**o1
, robj
**o2
) {
6245 if (subject
->encoding
== REDIS_ENCODING_HT
) {
6246 if (o1
) *o1
= tryObjectEncoding(*o1
);
6247 if (o2
) *o2
= tryObjectEncoding(*o2
);
6251 /* Get the value from a hash identified by key. Returns either a string
6252 * object or NULL if the value cannot be found. The refcount of the object
6253 * is always increased by 1 when the value was found. */
6254 static robj
*hashGet(robj
*o
, robj
*key
) {
6256 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6259 key
= getDecodedObject(key
);
6260 if (zipmapGet(o
->ptr
,key
->ptr
,sdslen(key
->ptr
),&v
,&vlen
)) {
6261 value
= createStringObject((char*)v
,vlen
);
6265 dictEntry
*de
= dictFind(o
->ptr
,key
);
6267 value
= dictGetEntryVal(de
);
6268 incrRefCount(value
);
6274 /* Test if the key exists in the given hash. Returns 1 if the key
6275 * exists and 0 when it doesn't. */
6276 static int hashExists(robj
*o
, robj
*key
) {
6277 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6278 key
= getDecodedObject(key
);
6279 if (zipmapExists(o
->ptr
,key
->ptr
,sdslen(key
->ptr
))) {
6285 if (dictFind(o
->ptr
,key
) != NULL
) {
6292 /* Add an element, discard the old if the key already exists.
6293 * Return 0 on insert and 1 on update. */
6294 static int hashSet(robj
*o
, robj
*key
, robj
*value
) {
6296 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6297 key
= getDecodedObject(key
);
6298 value
= getDecodedObject(value
);
6299 o
->ptr
= zipmapSet(o
->ptr
,
6300 key
->ptr
,sdslen(key
->ptr
),
6301 value
->ptr
,sdslen(value
->ptr
), &update
);
6303 decrRefCount(value
);
6305 /* Check if the zipmap needs to be upgraded to a real hash table */
6306 if (zipmapLen(o
->ptr
) > server
.hash_max_zipmap_entries
)
6307 convertToRealHash(o
);
6309 if (dictReplace(o
->ptr
,key
,value
)) {
6316 incrRefCount(value
);
6321 /* Delete an element from a hash.
6322 * Return 1 on deleted and 0 on not found. */
6323 static int hashDelete(robj
*o
, robj
*key
) {
6325 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6326 key
= getDecodedObject(key
);
6327 o
->ptr
= zipmapDel(o
->ptr
,key
->ptr
,sdslen(key
->ptr
), &deleted
);
6330 deleted
= dictDelete((dict
*)o
->ptr
,key
) == DICT_OK
;
6331 /* Always check if the dictionary needs a resize after a delete. */
6332 if (deleted
&& htNeedsResize(o
->ptr
)) dictResize(o
->ptr
);
6337 /* Return the number of elements in a hash. */
6338 static unsigned long hashLength(robj
*o
) {
6339 return (o
->encoding
== REDIS_ENCODING_ZIPMAP
) ?
6340 zipmapLen((unsigned char*)o
->ptr
) : dictSize((dict
*)o
->ptr
);
6343 /* Structure to hold hash iteration abstration. Note that iteration over
6344 * hashes involves both fields and values. Because it is possible that
6345 * not both are required, store pointers in the iterator to avoid
6346 * unnecessary memory allocation for fields/values. */
6350 unsigned char *zk
, *zv
;
6351 unsigned int zklen
, zvlen
;
6357 static hashIterator
*hashInitIterator(robj
*subject
) {
6358 hashIterator
*hi
= zmalloc(sizeof(hashIterator
));
6359 hi
->encoding
= subject
->encoding
;
6360 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6361 hi
->zi
= zipmapRewind(subject
->ptr
);
6362 } else if (hi
->encoding
== REDIS_ENCODING_HT
) {
6363 hi
->di
= dictGetIterator(subject
->ptr
);
6370 static void hashReleaseIterator(hashIterator
*hi
) {
6371 if (hi
->encoding
== REDIS_ENCODING_HT
) {
6372 dictReleaseIterator(hi
->di
);
6377 /* Move to the next entry in the hash. Return REDIS_OK when the next entry
6378 * could be found and REDIS_ERR when the iterator reaches the end. */
6379 static int hashNext(hashIterator
*hi
) {
6380 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6381 if ((hi
->zi
= zipmapNext(hi
->zi
, &hi
->zk
, &hi
->zklen
,
6382 &hi
->zv
, &hi
->zvlen
)) == NULL
) return REDIS_ERR
;
6384 if ((hi
->de
= dictNext(hi
->di
)) == NULL
) return REDIS_ERR
;
6389 /* Get key or value object at current iteration position.
6390 * This increases the refcount of the field object by 1. */
6391 static robj
*hashCurrent(hashIterator
*hi
, int what
) {
6393 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6394 if (what
& REDIS_HASH_KEY
) {
6395 o
= createStringObject((char*)hi
->zk
,hi
->zklen
);
6397 o
= createStringObject((char*)hi
->zv
,hi
->zvlen
);
6400 if (what
& REDIS_HASH_KEY
) {
6401 o
= dictGetEntryKey(hi
->de
);
6403 o
= dictGetEntryVal(hi
->de
);
6410 static robj
*hashLookupWriteOrCreate(redisClient
*c
, robj
*key
) {
6411 robj
*o
= lookupKeyWrite(c
->db
,key
);
6413 o
= createHashObject();
6414 dictAdd(c
->db
->dict
,key
,o
);
6417 if (o
->type
!= REDIS_HASH
) {
6418 addReply(c
,shared
.wrongtypeerr
);
6425 /* ============================= Hash commands ============================== */
6426 static void hsetCommand(redisClient
*c
) {
6430 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6431 hashTryConversion(o
,c
->argv
,2,3);
6432 hashTryObjectEncoding(o
,&c
->argv
[2], &c
->argv
[3]);
6433 update
= hashSet(o
,c
->argv
[2],c
->argv
[3]);
6434 addReply(c
, update
? shared
.czero
: shared
.cone
);
6438 static void hsetnxCommand(redisClient
*c
) {
6440 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6441 hashTryConversion(o
,c
->argv
,2,3);
6443 if (hashExists(o
, c
->argv
[2])) {
6444 addReply(c
, shared
.czero
);
6446 hashTryObjectEncoding(o
,&c
->argv
[2], &c
->argv
[3]);
6447 hashSet(o
,c
->argv
[2],c
->argv
[3]);
6448 addReply(c
, shared
.cone
);
6453 static void hmsetCommand(redisClient
*c
) {
6457 if ((c
->argc
% 2) == 1) {
6458 addReplySds(c
,sdsnew("-ERR wrong number of arguments for HMSET\r\n"));
6462 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6463 hashTryConversion(o
,c
->argv
,2,c
->argc
-1);
6464 for (i
= 2; i
< c
->argc
; i
+= 2) {
6465 hashTryObjectEncoding(o
,&c
->argv
[i
], &c
->argv
[i
+1]);
6466 hashSet(o
,c
->argv
[i
],c
->argv
[i
+1]);
6468 addReply(c
, shared
.ok
);
6472 static void hincrbyCommand(redisClient
*c
) {
6473 long long value
, incr
;
6474 robj
*o
, *current
, *new;
6476 if (getLongLongFromObjectOrReply(c
,c
->argv
[3],&incr
,NULL
) != REDIS_OK
) return;
6477 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6478 if ((current
= hashGet(o
,c
->argv
[2])) != NULL
) {
6479 if (getLongLongFromObjectOrReply(c
,current
,&value
,
6480 "hash value is not an integer") != REDIS_OK
) {
6481 decrRefCount(current
);
6484 decrRefCount(current
);
6490 new = createStringObjectFromLongLong(value
);
6491 hashTryObjectEncoding(o
,&c
->argv
[2],NULL
);
6492 hashSet(o
,c
->argv
[2],new);
6494 addReplyLongLong(c
,value
);
6498 static void hgetCommand(redisClient
*c
) {
6500 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6501 checkType(c
,o
,REDIS_HASH
)) return;
6503 if ((value
= hashGet(o
,c
->argv
[2])) != NULL
) {
6504 addReplyBulk(c
,value
);
6505 decrRefCount(value
);
6507 addReply(c
,shared
.nullbulk
);
6511 static void hmgetCommand(redisClient
*c
) {
6514 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
6515 if (o
!= NULL
&& o
->type
!= REDIS_HASH
) {
6516 addReply(c
,shared
.wrongtypeerr
);
6519 /* Note the check for o != NULL happens inside the loop. This is
6520 * done because objects that cannot be found are considered to be
6521 * an empty hash. The reply should then be a series of NULLs. */
6522 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-2));
6523 for (i
= 2; i
< c
->argc
; i
++) {
6524 if (o
!= NULL
&& (value
= hashGet(o
,c
->argv
[i
])) != NULL
) {
6525 addReplyBulk(c
,value
);
6526 decrRefCount(value
);
6528 addReply(c
,shared
.nullbulk
);
6533 static void hdelCommand(redisClient
*c
) {
6535 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6536 checkType(c
,o
,REDIS_HASH
)) return;
6538 if (hashDelete(o
,c
->argv
[2])) {
6539 if (hashLength(o
) == 0) deleteKey(c
->db
,c
->argv
[1]);
6540 addReply(c
,shared
.cone
);
6543 addReply(c
,shared
.czero
);
6547 static void hlenCommand(redisClient
*c
) {
6549 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6550 checkType(c
,o
,REDIS_HASH
)) return;
6552 addReplyUlong(c
,hashLength(o
));
6555 static void genericHgetallCommand(redisClient
*c
, int flags
) {
6556 robj
*o
, *lenobj
, *obj
;
6557 unsigned long count
= 0;
6560 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
6561 || checkType(c
,o
,REDIS_HASH
)) return;
6563 lenobj
= createObject(REDIS_STRING
,NULL
);
6565 decrRefCount(lenobj
);
6567 hi
= hashInitIterator(o
);
6568 while (hashNext(hi
) != REDIS_ERR
) {
6569 if (flags
& REDIS_HASH_KEY
) {
6570 obj
= hashCurrent(hi
,REDIS_HASH_KEY
);
6571 addReplyBulk(c
,obj
);
6575 if (flags
& REDIS_HASH_VALUE
) {
6576 obj
= hashCurrent(hi
,REDIS_HASH_VALUE
);
6577 addReplyBulk(c
,obj
);
6582 hashReleaseIterator(hi
);
6584 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",count
);
6587 static void hkeysCommand(redisClient
*c
) {
6588 genericHgetallCommand(c
,REDIS_HASH_KEY
);
6591 static void hvalsCommand(redisClient
*c
) {
6592 genericHgetallCommand(c
,REDIS_HASH_VALUE
);
6595 static void hgetallCommand(redisClient
*c
) {
6596 genericHgetallCommand(c
,REDIS_HASH_KEY
|REDIS_HASH_VALUE
);
6599 static void hexistsCommand(redisClient
*c
) {
6601 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6602 checkType(c
,o
,REDIS_HASH
)) return;
6604 addReply(c
, hashExists(o
,c
->argv
[2]) ? shared
.cone
: shared
.czero
);
6607 static void convertToRealHash(robj
*o
) {
6608 unsigned char *key
, *val
, *p
, *zm
= o
->ptr
;
6609 unsigned int klen
, vlen
;
6610 dict
*dict
= dictCreate(&hashDictType
,NULL
);
6612 assert(o
->type
== REDIS_HASH
&& o
->encoding
!= REDIS_ENCODING_HT
);
6613 p
= zipmapRewind(zm
);
6614 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
6615 robj
*keyobj
, *valobj
;
6617 keyobj
= createStringObject((char*)key
,klen
);
6618 valobj
= createStringObject((char*)val
,vlen
);
6619 keyobj
= tryObjectEncoding(keyobj
);
6620 valobj
= tryObjectEncoding(valobj
);
6621 dictAdd(dict
,keyobj
,valobj
);
6623 o
->encoding
= REDIS_ENCODING_HT
;
6628 /* ========================= Non type-specific commands ==================== */
6630 static void flushdbCommand(redisClient
*c
) {
6631 server
.dirty
+= dictSize(c
->db
->dict
);
6632 dictEmpty(c
->db
->dict
);
6633 dictEmpty(c
->db
->expires
);
6634 addReply(c
,shared
.ok
);
6637 static void flushallCommand(redisClient
*c
) {
6638 server
.dirty
+= emptyDb();
6639 addReply(c
,shared
.ok
);
6640 if (server
.bgsavechildpid
!= -1) {
6641 kill(server
.bgsavechildpid
,SIGKILL
);
6642 rdbRemoveTempFile(server
.bgsavechildpid
);
6644 rdbSave(server
.dbfilename
);
6648 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
6649 redisSortOperation
*so
= zmalloc(sizeof(*so
));
6651 so
->pattern
= pattern
;
6655 /* Return the value associated to the key with a name obtained
6656 * substituting the first occurence of '*' in 'pattern' with 'subst'.
6657 * The returned object will always have its refcount increased by 1
6658 * when it is non-NULL. */
6659 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
6662 robj keyobj
, fieldobj
, *o
;
6663 int prefixlen
, sublen
, postfixlen
, fieldlen
;
6664 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
6668 char buf
[REDIS_SORTKEY_MAX
+1];
6669 } keyname
, fieldname
;
6671 /* If the pattern is "#" return the substitution object itself in order
6672 * to implement the "SORT ... GET #" feature. */
6673 spat
= pattern
->ptr
;
6674 if (spat
[0] == '#' && spat
[1] == '\0') {
6675 incrRefCount(subst
);
6679 /* The substitution object may be specially encoded. If so we create
6680 * a decoded object on the fly. Otherwise getDecodedObject will just
6681 * increment the ref count, that we'll decrement later. */
6682 subst
= getDecodedObject(subst
);
6685 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
6686 p
= strchr(spat
,'*');
6688 decrRefCount(subst
);
6692 /* Find out if we're dealing with a hash dereference. */
6693 if ((f
= strstr(p
+1, "->")) != NULL
) {
6694 fieldlen
= sdslen(spat
)-(f
-spat
);
6695 /* this also copies \0 character */
6696 memcpy(fieldname
.buf
,f
+2,fieldlen
-1);
6697 fieldname
.len
= fieldlen
-2;
6703 sublen
= sdslen(ssub
);
6704 postfixlen
= sdslen(spat
)-(prefixlen
+1)-fieldlen
;
6705 memcpy(keyname
.buf
,spat
,prefixlen
);
6706 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
6707 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
6708 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
6709 keyname
.len
= prefixlen
+sublen
+postfixlen
;
6710 decrRefCount(subst
);
6712 /* Lookup substituted key */
6713 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2));
6714 o
= lookupKeyRead(db
,&keyobj
);
6715 if (o
== NULL
) return NULL
;
6718 if (o
->type
!= REDIS_HASH
|| fieldname
.len
< 1) return NULL
;
6720 /* Retrieve value from hash by the field name. This operation
6721 * already increases the refcount of the returned object. */
6722 initStaticStringObject(fieldobj
,((char*)&fieldname
)+(sizeof(long)*2));
6723 o
= hashGet(o
, &fieldobj
);
6725 if (o
->type
!= REDIS_STRING
) return NULL
;
6727 /* Every object that this function returns needs to have its refcount
6728 * increased. sortCommand decreases it again. */
6735 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
6736 * the additional parameter is not standard but a BSD-specific we have to
6737 * pass sorting parameters via the global 'server' structure */
6738 static int sortCompare(const void *s1
, const void *s2
) {
6739 const redisSortObject
*so1
= s1
, *so2
= s2
;
6742 if (!server
.sort_alpha
) {
6743 /* Numeric sorting. Here it's trivial as we precomputed scores */
6744 if (so1
->u
.score
> so2
->u
.score
) {
6746 } else if (so1
->u
.score
< so2
->u
.score
) {
6752 /* Alphanumeric sorting */
6753 if (server
.sort_bypattern
) {
6754 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
6755 /* At least one compare object is NULL */
6756 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
6758 else if (so1
->u
.cmpobj
== NULL
)
6763 /* We have both the objects, use strcoll */
6764 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
6767 /* Compare elements directly. */
6768 cmp
= compareStringObjects(so1
->obj
,so2
->obj
);
6771 return server
.sort_desc
? -cmp
: cmp
;
6774 /* The SORT command is the most complex command in Redis. Warning: this code
6775 * is optimized for speed and a bit less for readability */
6776 static void sortCommand(redisClient
*c
) {
6779 int desc
= 0, alpha
= 0;
6780 int limit_start
= 0, limit_count
= -1, start
, end
;
6781 int j
, dontsort
= 0, vectorlen
;
6782 int getop
= 0; /* GET operation counter */
6783 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
6784 redisSortObject
*vector
; /* Resulting vector to sort */
6786 /* Lookup the key to sort. It must be of the right types */
6787 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
6788 if (sortval
== NULL
) {
6789 addReply(c
,shared
.emptymultibulk
);
6792 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
6793 sortval
->type
!= REDIS_ZSET
)
6795 addReply(c
,shared
.wrongtypeerr
);
6799 /* Create a list of operations to perform for every sorted element.
6800 * Operations can be GET/DEL/INCR/DECR */
6801 operations
= listCreate();
6802 listSetFreeMethod(operations
,zfree
);
6805 /* Now we need to protect sortval incrementing its count, in the future
6806 * SORT may have options able to overwrite/delete keys during the sorting
6807 * and the sorted key itself may get destroied */
6808 incrRefCount(sortval
);
6810 /* The SORT command has an SQL-alike syntax, parse it */
6811 while(j
< c
->argc
) {
6812 int leftargs
= c
->argc
-j
-1;
6813 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
6815 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
6817 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
6819 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
6820 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
6821 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
6823 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
6824 storekey
= c
->argv
[j
+1];
6826 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
6827 sortby
= c
->argv
[j
+1];
6828 /* If the BY pattern does not contain '*', i.e. it is constant,
6829 * we don't need to sort nor to lookup the weight keys. */
6830 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
6832 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
6833 listAddNodeTail(operations
,createSortOperation(
6834 REDIS_SORT_GET
,c
->argv
[j
+1]));
6838 decrRefCount(sortval
);
6839 listRelease(operations
);
6840 addReply(c
,shared
.syntaxerr
);
6846 /* Load the sorting vector with all the objects to sort */
6847 switch(sortval
->type
) {
6848 case REDIS_LIST
: vectorlen
= listLength((list
*)sortval
->ptr
); break;
6849 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
6850 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
6851 default: vectorlen
= 0; redisPanic("Bad SORT type"); /* Avoid GCC warning */
6853 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
6856 if (sortval
->type
== REDIS_LIST
) {
6857 list
*list
= sortval
->ptr
;
6861 listRewind(list
,&li
);
6862 while((ln
= listNext(&li
))) {
6863 robj
*ele
= ln
->value
;
6864 vector
[j
].obj
= ele
;
6865 vector
[j
].u
.score
= 0;
6866 vector
[j
].u
.cmpobj
= NULL
;
6874 if (sortval
->type
== REDIS_SET
) {
6877 zset
*zs
= sortval
->ptr
;
6881 di
= dictGetIterator(set
);
6882 while((setele
= dictNext(di
)) != NULL
) {
6883 vector
[j
].obj
= dictGetEntryKey(setele
);
6884 vector
[j
].u
.score
= 0;
6885 vector
[j
].u
.cmpobj
= NULL
;
6888 dictReleaseIterator(di
);
6890 redisAssert(j
== vectorlen
);
6892 /* Now it's time to load the right scores in the sorting vector */
6893 if (dontsort
== 0) {
6894 for (j
= 0; j
< vectorlen
; j
++) {
6897 /* lookup value to sort by */
6898 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
6899 if (!byval
) continue;
6901 /* use object itself to sort by */
6902 byval
= vector
[j
].obj
;
6906 if (sortby
) vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
6908 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
6909 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
6910 } else if (byval
->encoding
== REDIS_ENCODING_INT
) {
6911 /* Don't need to decode the object if it's
6912 * integer-encoded (the only encoding supported) so
6913 * far. We can just cast it */
6914 vector
[j
].u
.score
= (long)byval
->ptr
;
6916 redisAssert(1 != 1);
6920 /* when the object was retrieved using lookupKeyByPattern,
6921 * its refcount needs to be decreased. */
6923 decrRefCount(byval
);
6928 /* We are ready to sort the vector... perform a bit of sanity check
6929 * on the LIMIT option too. We'll use a partial version of quicksort. */
6930 start
= (limit_start
< 0) ? 0 : limit_start
;
6931 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
6932 if (start
>= vectorlen
) {
6933 start
= vectorlen
-1;
6936 if (end
>= vectorlen
) end
= vectorlen
-1;
6938 if (dontsort
== 0) {
6939 server
.sort_desc
= desc
;
6940 server
.sort_alpha
= alpha
;
6941 server
.sort_bypattern
= sortby
? 1 : 0;
6942 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
6943 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
6945 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
6948 /* Send command output to the output buffer, performing the specified
6949 * GET/DEL/INCR/DECR operations if any. */
6950 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
6951 if (storekey
== NULL
) {
6952 /* STORE option not specified, sent the sorting result to client */
6953 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
6954 for (j
= start
; j
<= end
; j
++) {
6958 if (!getop
) addReplyBulk(c
,vector
[j
].obj
);
6959 listRewind(operations
,&li
);
6960 while((ln
= listNext(&li
))) {
6961 redisSortOperation
*sop
= ln
->value
;
6962 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
6965 if (sop
->type
== REDIS_SORT_GET
) {
6967 addReply(c
,shared
.nullbulk
);
6969 addReplyBulk(c
,val
);
6973 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
6978 robj
*listObject
= createListObject();
6979 list
*listPtr
= (list
*) listObject
->ptr
;
6981 /* STORE option specified, set the sorting result as a List object */
6982 for (j
= start
; j
<= end
; j
++) {
6987 listAddNodeTail(listPtr
,vector
[j
].obj
);
6988 incrRefCount(vector
[j
].obj
);
6990 listRewind(operations
,&li
);
6991 while((ln
= listNext(&li
))) {
6992 redisSortOperation
*sop
= ln
->value
;
6993 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
6996 if (sop
->type
== REDIS_SORT_GET
) {
6998 listAddNodeTail(listPtr
,createStringObject("",0));
7000 /* We should do a incrRefCount on val because it is
7001 * added to the list, but also a decrRefCount because
7002 * it is returned by lookupKeyByPattern. This results
7003 * in doing nothing at all. */
7004 listAddNodeTail(listPtr
,val
);
7007 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
7011 if (dictReplace(c
->db
->dict
,storekey
,listObject
)) {
7012 incrRefCount(storekey
);
7014 /* Note: we add 1 because the DB is dirty anyway since even if the
7015 * SORT result is empty a new key is set and maybe the old content
7017 server
.dirty
+= 1+outputlen
;
7018 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
7022 decrRefCount(sortval
);
7023 listRelease(operations
);
7024 for (j
= 0; j
< vectorlen
; j
++) {
7025 if (alpha
&& vector
[j
].u
.cmpobj
)
7026 decrRefCount(vector
[j
].u
.cmpobj
);
7031 /* Convert an amount of bytes into a human readable string in the form
7032 * of 100B, 2G, 100M, 4K, and so forth. */
7033 static void bytesToHuman(char *s
, unsigned long long n
) {
7038 sprintf(s
,"%lluB",n
);
7040 } else if (n
< (1024*1024)) {
7041 d
= (double)n
/(1024);
7042 sprintf(s
,"%.2fK",d
);
7043 } else if (n
< (1024LL*1024*1024)) {
7044 d
= (double)n
/(1024*1024);
7045 sprintf(s
,"%.2fM",d
);
7046 } else if (n
< (1024LL*1024*1024*1024)) {
7047 d
= (double)n
/(1024LL*1024*1024);
7048 sprintf(s
,"%.2fG",d
);
7052 /* Create the string returned by the INFO command. This is decoupled
7053 * by the INFO command itself as we need to report the same information
7054 * on memory corruption problems. */
7055 static sds
genRedisInfoString(void) {
7057 time_t uptime
= time(NULL
)-server
.stat_starttime
;
7061 bytesToHuman(hmem
,zmalloc_used_memory());
7062 info
= sdscatprintf(sdsempty(),
7063 "redis_version:%s\r\n"
7065 "multiplexing_api:%s\r\n"
7066 "process_id:%ld\r\n"
7067 "uptime_in_seconds:%ld\r\n"
7068 "uptime_in_days:%ld\r\n"
7069 "connected_clients:%d\r\n"
7070 "connected_slaves:%d\r\n"
7071 "blocked_clients:%d\r\n"
7072 "used_memory:%zu\r\n"
7073 "used_memory_human:%s\r\n"
7074 "changes_since_last_save:%lld\r\n"
7075 "bgsave_in_progress:%d\r\n"
7076 "last_save_time:%ld\r\n"
7077 "bgrewriteaof_in_progress:%d\r\n"
7078 "total_connections_received:%lld\r\n"
7079 "total_commands_processed:%lld\r\n"
7080 "expired_keys:%lld\r\n"
7081 "hash_max_zipmap_entries:%ld\r\n"
7082 "hash_max_zipmap_value:%ld\r\n"
7083 "pubsub_channels:%ld\r\n"
7084 "pubsub_patterns:%u\r\n"
7088 (sizeof(long) == 8) ? "64" : "32",
7093 listLength(server
.clients
)-listLength(server
.slaves
),
7094 listLength(server
.slaves
),
7095 server
.blpop_blocked_clients
,
7096 zmalloc_used_memory(),
7099 server
.bgsavechildpid
!= -1,
7101 server
.bgrewritechildpid
!= -1,
7102 server
.stat_numconnections
,
7103 server
.stat_numcommands
,
7104 server
.stat_expiredkeys
,
7105 server
.hash_max_zipmap_entries
,
7106 server
.hash_max_zipmap_value
,
7107 dictSize(server
.pubsub_channels
),
7108 listLength(server
.pubsub_patterns
),
7109 server
.vm_enabled
!= 0,
7110 server
.masterhost
== NULL
? "master" : "slave"
7112 if (server
.masterhost
) {
7113 info
= sdscatprintf(info
,
7114 "master_host:%s\r\n"
7115 "master_port:%d\r\n"
7116 "master_link_status:%s\r\n"
7117 "master_last_io_seconds_ago:%d\r\n"
7120 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
7122 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
7125 if (server
.vm_enabled
) {
7127 info
= sdscatprintf(info
,
7128 "vm_conf_max_memory:%llu\r\n"
7129 "vm_conf_page_size:%llu\r\n"
7130 "vm_conf_pages:%llu\r\n"
7131 "vm_stats_used_pages:%llu\r\n"
7132 "vm_stats_swapped_objects:%llu\r\n"
7133 "vm_stats_swappin_count:%llu\r\n"
7134 "vm_stats_swappout_count:%llu\r\n"
7135 "vm_stats_io_newjobs_len:%lu\r\n"
7136 "vm_stats_io_processing_len:%lu\r\n"
7137 "vm_stats_io_processed_len:%lu\r\n"
7138 "vm_stats_io_active_threads:%lu\r\n"
7139 "vm_stats_blocked_clients:%lu\r\n"
7140 ,(unsigned long long) server
.vm_max_memory
,
7141 (unsigned long long) server
.vm_page_size
,
7142 (unsigned long long) server
.vm_pages
,
7143 (unsigned long long) server
.vm_stats_used_pages
,
7144 (unsigned long long) server
.vm_stats_swapped_objects
,
7145 (unsigned long long) server
.vm_stats_swapins
,
7146 (unsigned long long) server
.vm_stats_swapouts
,
7147 (unsigned long) listLength(server
.io_newjobs
),
7148 (unsigned long) listLength(server
.io_processing
),
7149 (unsigned long) listLength(server
.io_processed
),
7150 (unsigned long) server
.io_active_threads
,
7151 (unsigned long) server
.vm_blocked_clients
7155 for (j
= 0; j
< server
.dbnum
; j
++) {
7156 long long keys
, vkeys
;
7158 keys
= dictSize(server
.db
[j
].dict
);
7159 vkeys
= dictSize(server
.db
[j
].expires
);
7160 if (keys
|| vkeys
) {
7161 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
7168 static void infoCommand(redisClient
*c
) {
7169 sds info
= genRedisInfoString();
7170 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
7171 (unsigned long)sdslen(info
)));
7172 addReplySds(c
,info
);
7173 addReply(c
,shared
.crlf
);
7176 static void monitorCommand(redisClient
*c
) {
7177 /* ignore MONITOR if aleady slave or in monitor mode */
7178 if (c
->flags
& REDIS_SLAVE
) return;
7180 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
7182 listAddNodeTail(server
.monitors
,c
);
7183 addReply(c
,shared
.ok
);
7186 /* ================================= Expire ================================= */
7187 static int removeExpire(redisDb
*db
, robj
*key
) {
7188 if (dictDelete(db
->expires
,key
) == DICT_OK
) {
7195 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
7196 if (dictAdd(db
->expires
,key
,(void*)when
) == DICT_ERR
) {
7204 /* Return the expire time of the specified key, or -1 if no expire
7205 * is associated with this key (i.e. the key is non volatile) */
7206 static time_t getExpire(redisDb
*db
, robj
*key
) {
7209 /* No expire? return ASAP */
7210 if (dictSize(db
->expires
) == 0 ||
7211 (de
= dictFind(db
->expires
,key
)) == NULL
) return -1;
7213 return (time_t) dictGetEntryVal(de
);
7216 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
7220 /* No expire? return ASAP */
7221 if (dictSize(db
->expires
) == 0 ||
7222 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
7224 /* Lookup the expire */
7225 when
= (time_t) dictGetEntryVal(de
);
7226 if (time(NULL
) <= when
) return 0;
7228 /* Delete the key */
7229 dictDelete(db
->expires
,key
);
7230 server
.stat_expiredkeys
++;
7231 return dictDelete(db
->dict
,key
) == DICT_OK
;
7234 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
7237 /* No expire? return ASAP */
7238 if (dictSize(db
->expires
) == 0 ||
7239 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
7241 /* Delete the key */
7243 server
.stat_expiredkeys
++;
7244 dictDelete(db
->expires
,key
);
7245 return dictDelete(db
->dict
,key
) == DICT_OK
;
7248 static void expireGenericCommand(redisClient
*c
, robj
*key
, robj
*param
, long offset
) {
7252 if (getLongFromObjectOrReply(c
, param
, &seconds
, NULL
) != REDIS_OK
) return;
7256 de
= dictFind(c
->db
->dict
,key
);
7258 addReply(c
,shared
.czero
);
7262 if (deleteKey(c
->db
,key
)) server
.dirty
++;
7263 addReply(c
, shared
.cone
);
7266 time_t when
= time(NULL
)+seconds
;
7267 if (setExpire(c
->db
,key
,when
)) {
7268 addReply(c
,shared
.cone
);
7271 addReply(c
,shared
.czero
);
7277 static void expireCommand(redisClient
*c
) {
7278 expireGenericCommand(c
,c
->argv
[1],c
->argv
[2],0);
7281 static void expireatCommand(redisClient
*c
) {
7282 expireGenericCommand(c
,c
->argv
[1],c
->argv
[2],time(NULL
));
7285 static void ttlCommand(redisClient
*c
) {
7289 expire
= getExpire(c
->db
,c
->argv
[1]);
7291 ttl
= (int) (expire
-time(NULL
));
7292 if (ttl
< 0) ttl
= -1;
7294 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
7297 /* ================================ MULTI/EXEC ============================== */
7299 /* Client state initialization for MULTI/EXEC */
7300 static void initClientMultiState(redisClient
*c
) {
7301 c
->mstate
.commands
= NULL
;
7302 c
->mstate
.count
= 0;
7305 /* Release all the resources associated with MULTI/EXEC state */
7306 static void freeClientMultiState(redisClient
*c
) {
7309 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7311 multiCmd
*mc
= c
->mstate
.commands
+j
;
7313 for (i
= 0; i
< mc
->argc
; i
++)
7314 decrRefCount(mc
->argv
[i
]);
7317 zfree(c
->mstate
.commands
);
7320 /* Add a new command into the MULTI commands queue */
7321 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
7325 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
7326 sizeof(multiCmd
)*(c
->mstate
.count
+1));
7327 mc
= c
->mstate
.commands
+c
->mstate
.count
;
7330 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
7331 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
7332 for (j
= 0; j
< c
->argc
; j
++)
7333 incrRefCount(mc
->argv
[j
]);
7337 static void multiCommand(redisClient
*c
) {
7338 c
->flags
|= REDIS_MULTI
;
7339 addReply(c
,shared
.ok
);
7342 static void discardCommand(redisClient
*c
) {
7343 if (!(c
->flags
& REDIS_MULTI
)) {
7344 addReplySds(c
,sdsnew("-ERR DISCARD without MULTI\r\n"));
7348 freeClientMultiState(c
);
7349 initClientMultiState(c
);
7350 c
->flags
&= (~REDIS_MULTI
);
7351 addReply(c
,shared
.ok
);
7354 /* Send a MULTI command to all the slaves and AOF file. Check the execCommand
7355 * implememntation for more information. */
7356 static void execCommandReplicateMulti(redisClient
*c
) {
7357 struct redisCommand
*cmd
;
7358 robj
*multistring
= createStringObject("MULTI",5);
7360 cmd
= lookupCommand("multi");
7361 if (server
.appendonly
)
7362 feedAppendOnlyFile(cmd
,c
->db
->id
,&multistring
,1);
7363 if (listLength(server
.slaves
))
7364 replicationFeedSlaves(server
.slaves
,c
->db
->id
,&multistring
,1);
7365 decrRefCount(multistring
);
7368 static void execCommand(redisClient
*c
) {
7373 if (!(c
->flags
& REDIS_MULTI
)) {
7374 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
7378 /* Replicate a MULTI request now that we are sure the block is executed.
7379 * This way we'll deliver the MULTI/..../EXEC block as a whole and
7380 * both the AOF and the replication link will have the same consistency
7381 * and atomicity guarantees. */
7382 execCommandReplicateMulti(c
);
7384 /* Exec all the queued commands */
7385 orig_argv
= c
->argv
;
7386 orig_argc
= c
->argc
;
7387 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
7388 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7389 c
->argc
= c
->mstate
.commands
[j
].argc
;
7390 c
->argv
= c
->mstate
.commands
[j
].argv
;
7391 call(c
,c
->mstate
.commands
[j
].cmd
);
7393 c
->argv
= orig_argv
;
7394 c
->argc
= orig_argc
;
7395 freeClientMultiState(c
);
7396 initClientMultiState(c
);
7397 c
->flags
&= (~REDIS_MULTI
);
7398 /* Make sure the EXEC command is always replicated / AOF, since we
7399 * always send the MULTI command (we can't know beforehand if the
7400 * next operations will contain at least a modification to the DB). */
7404 /* =========================== Blocking Operations ========================= */
7406 /* Currently Redis blocking operations support is limited to list POP ops,
7407 * so the current implementation is not fully generic, but it is also not
7408 * completely specific so it will not require a rewrite to support new
7409 * kind of blocking operations in the future.
7411 * Still it's important to note that list blocking operations can be already
7412 * used as a notification mechanism in order to implement other blocking
7413 * operations at application level, so there must be a very strong evidence
7414 * of usefulness and generality before new blocking operations are implemented.
7416 * This is how the current blocking POP works, we use BLPOP as example:
7417 * - If the user calls BLPOP and the key exists and contains a non empty list
7418 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
7419 * if there is not to block.
7420 * - If instead BLPOP is called and the key does not exists or the list is
7421 * empty we need to block. In order to do so we remove the notification for
7422 * new data to read in the client socket (so that we'll not serve new
7423 * requests if the blocking request is not served). Also we put the client
7424 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
7425 * blocking for this keys.
7426 * - If a PUSH operation against a key with blocked clients waiting is
7427 * performed, we serve the first in the list: basically instead to push
7428 * the new element inside the list we return it to the (first / oldest)
7429 * blocking client, unblock the client, and remove it form the list.
7431 * The above comment and the source code should be enough in order to understand
7432 * the implementation and modify / fix it later.
7435 /* Set a client in blocking mode for the specified key, with the specified
7437 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
7442 c
->blockingkeys
= zmalloc(sizeof(robj
*)*numkeys
);
7443 c
->blockingkeysnum
= numkeys
;
7444 c
->blockingto
= timeout
;
7445 for (j
= 0; j
< numkeys
; j
++) {
7446 /* Add the key in the client structure, to map clients -> keys */
7447 c
->blockingkeys
[j
] = keys
[j
];
7448 incrRefCount(keys
[j
]);
7450 /* And in the other "side", to map keys -> clients */
7451 de
= dictFind(c
->db
->blockingkeys
,keys
[j
]);
7455 /* For every key we take a list of clients blocked for it */
7457 retval
= dictAdd(c
->db
->blockingkeys
,keys
[j
],l
);
7458 incrRefCount(keys
[j
]);
7459 assert(retval
== DICT_OK
);
7461 l
= dictGetEntryVal(de
);
7463 listAddNodeTail(l
,c
);
7465 /* Mark the client as a blocked client */
7466 c
->flags
|= REDIS_BLOCKED
;
7467 server
.blpop_blocked_clients
++;
7470 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
7471 static void unblockClientWaitingData(redisClient
*c
) {
7476 assert(c
->blockingkeys
!= NULL
);
7477 /* The client may wait for multiple keys, so unblock it for every key. */
7478 for (j
= 0; j
< c
->blockingkeysnum
; j
++) {
7479 /* Remove this client from the list of clients waiting for this key. */
7480 de
= dictFind(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
7482 l
= dictGetEntryVal(de
);
7483 listDelNode(l
,listSearchKey(l
,c
));
7484 /* If the list is empty we need to remove it to avoid wasting memory */
7485 if (listLength(l
) == 0)
7486 dictDelete(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
7487 decrRefCount(c
->blockingkeys
[j
]);
7489 /* Cleanup the client structure */
7490 zfree(c
->blockingkeys
);
7491 c
->blockingkeys
= NULL
;
7492 c
->flags
&= (~REDIS_BLOCKED
);
7493 server
.blpop_blocked_clients
--;
7494 /* We want to process data if there is some command waiting
7495 * in the input buffer. Note that this is safe even if
7496 * unblockClientWaitingData() gets called from freeClient() because
7497 * freeClient() will be smart enough to call this function
7498 * *after* c->querybuf was set to NULL. */
7499 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
7502 /* This should be called from any function PUSHing into lists.
7503 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
7504 * 'ele' is the element pushed.
7506 * If the function returns 0 there was no client waiting for a list push
7509 * If the function returns 1 there was a client waiting for a list push
7510 * against this key, the element was passed to this client thus it's not
7511 * needed to actually add it to the list and the caller should return asap. */
7512 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
7513 struct dictEntry
*de
;
7514 redisClient
*receiver
;
7518 de
= dictFind(c
->db
->blockingkeys
,key
);
7519 if (de
== NULL
) return 0;
7520 l
= dictGetEntryVal(de
);
7523 receiver
= ln
->value
;
7525 addReplySds(receiver
,sdsnew("*2\r\n"));
7526 addReplyBulk(receiver
,key
);
7527 addReplyBulk(receiver
,ele
);
7528 unblockClientWaitingData(receiver
);
7532 /* Blocking RPOP/LPOP */
7533 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
7538 for (j
= 1; j
< c
->argc
-1; j
++) {
7539 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
7541 if (o
->type
!= REDIS_LIST
) {
7542 addReply(c
,shared
.wrongtypeerr
);
7545 list
*list
= o
->ptr
;
7546 if (listLength(list
) != 0) {
7547 /* If the list contains elements fall back to the usual
7548 * non-blocking POP operation */
7549 robj
*argv
[2], **orig_argv
;
7552 /* We need to alter the command arguments before to call
7553 * popGenericCommand() as the command takes a single key. */
7554 orig_argv
= c
->argv
;
7555 orig_argc
= c
->argc
;
7556 argv
[1] = c
->argv
[j
];
7560 /* Also the return value is different, we need to output
7561 * the multi bulk reply header and the key name. The
7562 * "real" command will add the last element (the value)
7563 * for us. If this souds like an hack to you it's just
7564 * because it is... */
7565 addReplySds(c
,sdsnew("*2\r\n"));
7566 addReplyBulk(c
,argv
[1]);
7567 popGenericCommand(c
,where
);
7569 /* Fix the client structure with the original stuff */
7570 c
->argv
= orig_argv
;
7571 c
->argc
= orig_argc
;
7577 /* If the list is empty or the key does not exists we must block */
7578 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
7579 if (timeout
> 0) timeout
+= time(NULL
);
7580 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
7583 static void blpopCommand(redisClient
*c
) {
7584 blockingPopGenericCommand(c
,REDIS_HEAD
);
7587 static void brpopCommand(redisClient
*c
) {
7588 blockingPopGenericCommand(c
,REDIS_TAIL
);
7591 /* =============================== Replication ============================= */
7593 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7594 ssize_t nwritten
, ret
= size
;
7595 time_t start
= time(NULL
);
7599 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
7600 nwritten
= write(fd
,ptr
,size
);
7601 if (nwritten
== -1) return -1;
7605 if ((time(NULL
)-start
) > timeout
) {
7613 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7614 ssize_t nread
, totread
= 0;
7615 time_t start
= time(NULL
);
7619 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
7620 nread
= read(fd
,ptr
,size
);
7621 if (nread
== -1) return -1;
7626 if ((time(NULL
)-start
) > timeout
) {
7634 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7641 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
7644 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
7655 static void syncCommand(redisClient
*c
) {
7656 /* ignore SYNC if aleady slave or in monitor mode */
7657 if (c
->flags
& REDIS_SLAVE
) return;
7659 /* SYNC can't be issued when the server has pending data to send to
7660 * the client about already issued commands. We need a fresh reply
7661 * buffer registering the differences between the BGSAVE and the current
7662 * dataset, so that we can copy to other slaves if needed. */
7663 if (listLength(c
->reply
) != 0) {
7664 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
7668 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
7669 /* Here we need to check if there is a background saving operation
7670 * in progress, or if it is required to start one */
7671 if (server
.bgsavechildpid
!= -1) {
7672 /* Ok a background save is in progress. Let's check if it is a good
7673 * one for replication, i.e. if there is another slave that is
7674 * registering differences since the server forked to save */
7679 listRewind(server
.slaves
,&li
);
7680 while((ln
= listNext(&li
))) {
7682 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
7685 /* Perfect, the server is already registering differences for
7686 * another slave. Set the right state, and copy the buffer. */
7687 listRelease(c
->reply
);
7688 c
->reply
= listDup(slave
->reply
);
7689 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7690 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
7692 /* No way, we need to wait for the next BGSAVE in order to
7693 * register differences */
7694 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7695 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
7698 /* Ok we don't have a BGSAVE in progress, let's start one */
7699 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
7700 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7701 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
7702 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
7705 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7708 c
->flags
|= REDIS_SLAVE
;
7710 listAddNodeTail(server
.slaves
,c
);
7714 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
7715 redisClient
*slave
= privdata
;
7717 REDIS_NOTUSED(mask
);
7718 char buf
[REDIS_IOBUF_LEN
];
7719 ssize_t nwritten
, buflen
;
7721 if (slave
->repldboff
== 0) {
7722 /* Write the bulk write count before to transfer the DB. In theory here
7723 * we don't know how much room there is in the output buffer of the
7724 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
7725 * operations) will never be smaller than the few bytes we need. */
7728 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
7730 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
7738 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
7739 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
7741 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
7742 (buflen
== 0) ? "premature EOF" : strerror(errno
));
7746 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
7747 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
7752 slave
->repldboff
+= nwritten
;
7753 if (slave
->repldboff
== slave
->repldbsize
) {
7754 close(slave
->repldbfd
);
7755 slave
->repldbfd
= -1;
7756 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7757 slave
->replstate
= REDIS_REPL_ONLINE
;
7758 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
7759 sendReplyToClient
, slave
) == AE_ERR
) {
7763 addReplySds(slave
,sdsempty());
7764 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
7768 /* This function is called at the end of every backgrond saving.
7769 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
7770 * otherwise REDIS_ERR is passed to the function.
7772 * The goal of this function is to handle slaves waiting for a successful
7773 * background saving in order to perform non-blocking synchronization. */
7774 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
7776 int startbgsave
= 0;
7779 listRewind(server
.slaves
,&li
);
7780 while((ln
= listNext(&li
))) {
7781 redisClient
*slave
= ln
->value
;
7783 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
7785 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7786 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
7787 struct redis_stat buf
;
7789 if (bgsaveerr
!= REDIS_OK
) {
7791 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
7794 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
7795 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
7797 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
7800 slave
->repldboff
= 0;
7801 slave
->repldbsize
= buf
.st_size
;
7802 slave
->replstate
= REDIS_REPL_SEND_BULK
;
7803 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7804 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
7811 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7814 listRewind(server
.slaves
,&li
);
7815 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
7816 while((ln
= listNext(&li
))) {
7817 redisClient
*slave
= ln
->value
;
7819 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
7826 static int syncWithMaster(void) {
7827 char buf
[1024], tmpfile
[256], authcmd
[1024];
7829 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
7830 int dfd
, maxtries
= 5;
7833 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
7838 /* AUTH with the master if required. */
7839 if(server
.masterauth
) {
7840 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
7841 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
7843 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
7847 /* Read the AUTH result. */
7848 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7850 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
7854 if (buf
[0] != '+') {
7856 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
7861 /* Issue the SYNC command */
7862 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
7864 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
7868 /* Read the bulk write count */
7869 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7871 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
7875 if (buf
[0] != '$') {
7877 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
7880 dumpsize
= strtol(buf
+1,NULL
,10);
7881 redisLog(REDIS_NOTICE
,"Receiving %ld bytes data dump from MASTER",dumpsize
);
7882 /* Read the bulk write data on a temp file */
7884 snprintf(tmpfile
,256,
7885 "temp-%d.%ld.rdb",(int)time(NULL
),(long int)getpid());
7886 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
|O_EXCL
,0644);
7887 if (dfd
!= -1) break;
7892 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
7896 int nread
, nwritten
;
7898 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
7900 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
7906 nwritten
= write(dfd
,buf
,nread
);
7907 if (nwritten
== -1) {
7908 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
7916 if (rename(tmpfile
,server
.dbfilename
) == -1) {
7917 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
7923 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
7924 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
7928 server
.master
= createClient(fd
);
7929 server
.master
->flags
|= REDIS_MASTER
;
7930 server
.master
->authenticated
= 1;
7931 server
.replstate
= REDIS_REPL_CONNECTED
;
7935 static void slaveofCommand(redisClient
*c
) {
7936 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
7937 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
7938 if (server
.masterhost
) {
7939 sdsfree(server
.masterhost
);
7940 server
.masterhost
= NULL
;
7941 if (server
.master
) freeClient(server
.master
);
7942 server
.replstate
= REDIS_REPL_NONE
;
7943 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
7946 sdsfree(server
.masterhost
);
7947 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
7948 server
.masterport
= atoi(c
->argv
[2]->ptr
);
7949 if (server
.master
) freeClient(server
.master
);
7950 server
.replstate
= REDIS_REPL_CONNECT
;
7951 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
7952 server
.masterhost
, server
.masterport
);
7954 addReply(c
,shared
.ok
);
7957 /* ============================ Maxmemory directive ======================== */
7959 /* Try to free one object form the pre-allocated objects free list.
7960 * This is useful under low mem conditions as by default we take 1 million
7961 * free objects allocated. On success REDIS_OK is returned, otherwise
7963 static int tryFreeOneObjectFromFreelist(void) {
7966 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
7967 if (listLength(server
.objfreelist
)) {
7968 listNode
*head
= listFirst(server
.objfreelist
);
7969 o
= listNodeValue(head
);
7970 listDelNode(server
.objfreelist
,head
);
7971 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7975 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7980 /* This function gets called when 'maxmemory' is set on the config file to limit
7981 * the max memory used by the server, and we are out of memory.
7982 * This function will try to, in order:
7984 * - Free objects from the free list
7985 * - Try to remove keys with an EXPIRE set
7987 * It is not possible to free enough memory to reach used-memory < maxmemory
7988 * the server will start refusing commands that will enlarge even more the
7991 static void freeMemoryIfNeeded(void) {
7992 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
7993 int j
, k
, freed
= 0;
7995 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
7996 for (j
= 0; j
< server
.dbnum
; j
++) {
7998 robj
*minkey
= NULL
;
7999 struct dictEntry
*de
;
8001 if (dictSize(server
.db
[j
].expires
)) {
8003 /* From a sample of three keys drop the one nearest to
8004 * the natural expire */
8005 for (k
= 0; k
< 3; k
++) {
8008 de
= dictGetRandomKey(server
.db
[j
].expires
);
8009 t
= (time_t) dictGetEntryVal(de
);
8010 if (minttl
== -1 || t
< minttl
) {
8011 minkey
= dictGetEntryKey(de
);
8015 deleteKey(server
.db
+j
,minkey
);
8018 if (!freed
) return; /* nothing to free... */
8022 /* ============================== Append Only file ========================== */
8024 /* Write the append only file buffer on disk.
8026 * Since we are required to write the AOF before replying to the client,
8027 * and the only way the client socket can get a write is entering when the
8028 * the event loop, we accumulate all the AOF writes in a memory
8029 * buffer and write it on disk using this function just before entering
8030 * the event loop again. */
8031 static void flushAppendOnlyFile(void) {
8035 if (sdslen(server
.aofbuf
) == 0) return;
8037 /* We want to perform a single write. This should be guaranteed atomic
8038 * at least if the filesystem we are writing is a real physical one.
8039 * While this will save us against the server being killed I don't think
8040 * there is much to do about the whole server stopping for power problems
8042 nwritten
= write(server
.appendfd
,server
.aofbuf
,sdslen(server
.aofbuf
));
8043 if (nwritten
!= (signed)sdslen(server
.aofbuf
)) {
8044 /* Ooops, we are in troubles. The best thing to do for now is
8045 * aborting instead of giving the illusion that everything is
8046 * working as expected. */
8047 if (nwritten
== -1) {
8048 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
8050 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
8054 sdsfree(server
.aofbuf
);
8055 server
.aofbuf
= sdsempty();
8057 /* Fsync if needed */
8059 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
8060 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
8061 now
-server
.lastfsync
> 1))
8063 /* aof_fsync is defined as fdatasync() for Linux in order to avoid
8064 * flushing metadata. */
8065 aof_fsync(server
.appendfd
); /* Let's try to get this data on the disk */
8066 server
.lastfsync
= now
;
8070 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
8071 sds buf
= sdsempty();
8075 /* The DB this command was targetting is not the same as the last command
8076 * we appendend. To issue a SELECT command is needed. */
8077 if (dictid
!= server
.appendseldb
) {
8080 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
8081 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
8082 (unsigned long)strlen(seldb
),seldb
);
8083 server
.appendseldb
= dictid
;
8086 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
8087 * EXPIREs into EXPIREATs calls */
8088 if (cmd
->proc
== expireCommand
) {
8091 tmpargv
[0] = createStringObject("EXPIREAT",8);
8092 tmpargv
[1] = argv
[1];
8093 incrRefCount(argv
[1]);
8094 when
= time(NULL
)+strtol(argv
[2]->ptr
,NULL
,10);
8095 tmpargv
[2] = createObject(REDIS_STRING
,
8096 sdscatprintf(sdsempty(),"%ld",when
));
8100 /* Append the actual command */
8101 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
8102 for (j
= 0; j
< argc
; j
++) {
8105 o
= getDecodedObject(o
);
8106 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
8107 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
8108 buf
= sdscatlen(buf
,"\r\n",2);
8112 /* Free the objects from the modified argv for EXPIREAT */
8113 if (cmd
->proc
== expireCommand
) {
8114 for (j
= 0; j
< 3; j
++)
8115 decrRefCount(argv
[j
]);
8118 /* Append to the AOF buffer. This will be flushed on disk just before
8119 * of re-entering the event loop, so before the client will get a
8120 * positive reply about the operation performed. */
8121 server
.aofbuf
= sdscatlen(server
.aofbuf
,buf
,sdslen(buf
));
8123 /* If a background append only file rewriting is in progress we want to
8124 * accumulate the differences between the child DB and the current one
8125 * in a buffer, so that when the child process will do its work we
8126 * can append the differences to the new append only file. */
8127 if (server
.bgrewritechildpid
!= -1)
8128 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
8133 /* In Redis commands are always executed in the context of a client, so in
8134 * order to load the append only file we need to create a fake client. */
8135 static struct redisClient
*createFakeClient(void) {
8136 struct redisClient
*c
= zmalloc(sizeof(*c
));
8140 c
->querybuf
= sdsempty();
8144 /* We set the fake client as a slave waiting for the synchronization
8145 * so that Redis will not try to send replies to this client. */
8146 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
8147 c
->reply
= listCreate();
8148 listSetFreeMethod(c
->reply
,decrRefCount
);
8149 listSetDupMethod(c
->reply
,dupClientReplyValue
);
8150 initClientMultiState(c
);
8154 static void freeFakeClient(struct redisClient
*c
) {
8155 sdsfree(c
->querybuf
);
8156 listRelease(c
->reply
);
8157 freeClientMultiState(c
);
8161 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
8162 * error (the append only file is zero-length) REDIS_ERR is returned. On
8163 * fatal error an error message is logged and the program exists. */
8164 int loadAppendOnlyFile(char *filename
) {
8165 struct redisClient
*fakeClient
;
8166 FILE *fp
= fopen(filename
,"r");
8167 struct redis_stat sb
;
8168 unsigned long long loadedkeys
= 0;
8169 int appendonly
= server
.appendonly
;
8171 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
8175 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
8179 /* Temporarily disable AOF, to prevent EXEC from feeding a MULTI
8180 * to the same file we're about to read. */
8181 server
.appendonly
= 0;
8183 fakeClient
= createFakeClient();
8190 struct redisCommand
*cmd
;
8192 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
8198 if (buf
[0] != '*') goto fmterr
;
8200 argv
= zmalloc(sizeof(robj
*)*argc
);
8201 for (j
= 0; j
< argc
; j
++) {
8202 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
8203 if (buf
[0] != '$') goto fmterr
;
8204 len
= strtol(buf
+1,NULL
,10);
8205 argsds
= sdsnewlen(NULL
,len
);
8206 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
8207 argv
[j
] = createObject(REDIS_STRING
,argsds
);
8208 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
8211 /* Command lookup */
8212 cmd
= lookupCommand(argv
[0]->ptr
);
8214 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
8217 /* Try object encoding */
8218 if (cmd
->flags
& REDIS_CMD_BULK
)
8219 argv
[argc
-1] = tryObjectEncoding(argv
[argc
-1]);
8220 /* Run the command in the context of a fake client */
8221 fakeClient
->argc
= argc
;
8222 fakeClient
->argv
= argv
;
8223 cmd
->proc(fakeClient
);
8224 /* Discard the reply objects list from the fake client */
8225 while(listLength(fakeClient
->reply
))
8226 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
8227 /* Clean up, ready for the next command */
8228 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
8230 /* Handle swapping while loading big datasets when VM is on */
8232 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
8233 while (zmalloc_used_memory() > server
.vm_max_memory
) {
8234 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
8239 /* This point can only be reached when EOF is reached without errors.
8240 * If the client is in the middle of a MULTI/EXEC, log error and quit. */
8241 if (fakeClient
->flags
& REDIS_MULTI
) goto readerr
;
8244 freeFakeClient(fakeClient
);
8245 server
.appendonly
= appendonly
;
8250 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
8252 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
8256 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
8260 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
8261 static int fwriteBulkObject(FILE *fp
, robj
*obj
) {
8265 /* Avoid the incr/decr ref count business if possible to help
8266 * copy-on-write (we are often in a child process when this function
8268 * Also makes sure that key objects don't get incrRefCount-ed when VM
8270 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
8271 obj
= getDecodedObject(obj
);
8274 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
8275 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
8276 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
8278 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
8279 if (decrrc
) decrRefCount(obj
);
8282 if (decrrc
) decrRefCount(obj
);
8286 /* Write binary-safe string into a file in the bulkformat
8287 * $<count>\r\n<payload>\r\n */
8288 static int fwriteBulkString(FILE *fp
, char *s
, unsigned long len
) {
8291 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(unsigned long)len
);
8292 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8293 if (len
&& fwrite(s
,len
,1,fp
) == 0) return 0;
8294 if (fwrite("\r\n",2,1,fp
) == 0) return 0;
8298 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
8299 static int fwriteBulkDouble(FILE *fp
, double d
) {
8300 char buf
[128], dbuf
[128];
8302 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
8303 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
8304 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8305 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
8309 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
8310 static int fwriteBulkLong(FILE *fp
, long l
) {
8311 char buf
[128], lbuf
[128];
8313 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
8314 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
8315 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8316 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
8320 /* Write a sequence of commands able to fully rebuild the dataset into
8321 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
8322 static int rewriteAppendOnlyFile(char *filename
) {
8323 dictIterator
*di
= NULL
;
8328 time_t now
= time(NULL
);
8330 /* Note that we have to use a different temp name here compared to the
8331 * one used by rewriteAppendOnlyFileBackground() function. */
8332 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
8333 fp
= fopen(tmpfile
,"w");
8335 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
8338 for (j
= 0; j
< server
.dbnum
; j
++) {
8339 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
8340 redisDb
*db
= server
.db
+j
;
8342 if (dictSize(d
) == 0) continue;
8343 di
= dictGetIterator(d
);
8349 /* SELECT the new DB */
8350 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
8351 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
8353 /* Iterate this DB writing every entry */
8354 while((de
= dictNext(di
)) != NULL
) {
8359 key
= dictGetEntryKey(de
);
8360 /* If the value for this key is swapped, load a preview in memory.
8361 * We use a "swapped" flag to remember if we need to free the
8362 * value object instead to just increment the ref count anyway
8363 * in order to avoid copy-on-write of pages if we are forked() */
8364 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
8365 key
->storage
== REDIS_VM_SWAPPING
) {
8366 o
= dictGetEntryVal(de
);
8369 o
= vmPreviewObject(key
);
8372 expiretime
= getExpire(db
,key
);
8374 /* Save the key and associated value */
8375 if (o
->type
== REDIS_STRING
) {
8376 /* Emit a SET command */
8377 char cmd
[]="*3\r\n$3\r\nSET\r\n";
8378 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8380 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8381 if (fwriteBulkObject(fp
,o
) == 0) goto werr
;
8382 } else if (o
->type
== REDIS_LIST
) {
8383 /* Emit the RPUSHes needed to rebuild the list */
8384 list
*list
= o
->ptr
;
8388 listRewind(list
,&li
);
8389 while((ln
= listNext(&li
))) {
8390 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
8391 robj
*eleobj
= listNodeValue(ln
);
8393 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8394 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8395 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8397 } else if (o
->type
== REDIS_SET
) {
8398 /* Emit the SADDs needed to rebuild the set */
8400 dictIterator
*di
= dictGetIterator(set
);
8403 while((de
= dictNext(di
)) != NULL
) {
8404 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
8405 robj
*eleobj
= dictGetEntryKey(de
);
8407 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8408 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8409 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8411 dictReleaseIterator(di
);
8412 } else if (o
->type
== REDIS_ZSET
) {
8413 /* Emit the ZADDs needed to rebuild the sorted set */
8415 dictIterator
*di
= dictGetIterator(zs
->dict
);
8418 while((de
= dictNext(di
)) != NULL
) {
8419 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
8420 robj
*eleobj
= dictGetEntryKey(de
);
8421 double *score
= dictGetEntryVal(de
);
8423 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8424 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8425 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
8426 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8428 dictReleaseIterator(di
);
8429 } else if (o
->type
== REDIS_HASH
) {
8430 char cmd
[]="*4\r\n$4\r\nHSET\r\n";
8432 /* Emit the HSETs needed to rebuild the hash */
8433 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
8434 unsigned char *p
= zipmapRewind(o
->ptr
);
8435 unsigned char *field
, *val
;
8436 unsigned int flen
, vlen
;
8438 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
8439 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8440 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8441 if (fwriteBulkString(fp
,(char*)field
,flen
) == -1)
8443 if (fwriteBulkString(fp
,(char*)val
,vlen
) == -1)
8447 dictIterator
*di
= dictGetIterator(o
->ptr
);
8450 while((de
= dictNext(di
)) != NULL
) {
8451 robj
*field
= dictGetEntryKey(de
);
8452 robj
*val
= dictGetEntryVal(de
);
8454 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8455 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8456 if (fwriteBulkObject(fp
,field
) == -1) return -1;
8457 if (fwriteBulkObject(fp
,val
) == -1) return -1;
8459 dictReleaseIterator(di
);
8462 redisPanic("Unknown object type");
8464 /* Save the expire time */
8465 if (expiretime
!= -1) {
8466 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
8467 /* If this key is already expired skip it */
8468 if (expiretime
< now
) continue;
8469 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8470 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8471 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
8473 if (swapped
) decrRefCount(o
);
8475 dictReleaseIterator(di
);
8478 /* Make sure data will not remain on the OS's output buffers */
8483 /* Use RENAME to make sure the DB file is changed atomically only
8484 * if the generate DB file is ok. */
8485 if (rename(tmpfile
,filename
) == -1) {
8486 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
8490 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
8496 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
8497 if (di
) dictReleaseIterator(di
);
8501 /* This is how rewriting of the append only file in background works:
8503 * 1) The user calls BGREWRITEAOF
8504 * 2) Redis calls this function, that forks():
8505 * 2a) the child rewrite the append only file in a temp file.
8506 * 2b) the parent accumulates differences in server.bgrewritebuf.
8507 * 3) When the child finished '2a' exists.
8508 * 4) The parent will trap the exit code, if it's OK, will append the
8509 * data accumulated into server.bgrewritebuf into the temp file, and
8510 * finally will rename(2) the temp file in the actual file name.
8511 * The the new file is reopened as the new append only file. Profit!
8513 static int rewriteAppendOnlyFileBackground(void) {
8516 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
8517 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
8518 if ((childpid
= fork()) == 0) {
8522 if (server
.vm_enabled
) vmReopenSwapFile();
8524 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
8525 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
8532 if (childpid
== -1) {
8533 redisLog(REDIS_WARNING
,
8534 "Can't rewrite append only file in background: fork: %s",
8538 redisLog(REDIS_NOTICE
,
8539 "Background append only file rewriting started by pid %d",childpid
);
8540 server
.bgrewritechildpid
= childpid
;
8541 updateDictResizePolicy();
8542 /* We set appendseldb to -1 in order to force the next call to the
8543 * feedAppendOnlyFile() to issue a SELECT command, so the differences
8544 * accumulated by the parent into server.bgrewritebuf will start
8545 * with a SELECT statement and it will be safe to merge. */
8546 server
.appendseldb
= -1;
8549 return REDIS_OK
; /* unreached */
8552 static void bgrewriteaofCommand(redisClient
*c
) {
8553 if (server
.bgrewritechildpid
!= -1) {
8554 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
8557 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
8558 char *status
= "+Background append only file rewriting started\r\n";
8559 addReplySds(c
,sdsnew(status
));
8561 addReply(c
,shared
.err
);
8565 static void aofRemoveTempFile(pid_t childpid
) {
8568 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
8572 /* Virtual Memory is composed mainly of two subsystems:
8573 * - Blocking Virutal Memory
8574 * - Threaded Virtual Memory I/O
8575 * The two parts are not fully decoupled, but functions are split among two
8576 * different sections of the source code (delimited by comments) in order to
8577 * make more clear what functionality is about the blocking VM and what about
8578 * the threaded (not blocking) VM.
8582 * Redis VM is a blocking VM (one that blocks reading swapped values from
8583 * disk into memory when a value swapped out is needed in memory) that is made
8584 * unblocking by trying to examine the command argument vector in order to
8585 * load in background values that will likely be needed in order to exec
8586 * the command. The command is executed only once all the relevant keys
8587 * are loaded into memory.
8589 * This basically is almost as simple of a blocking VM, but almost as parallel
8590 * as a fully non-blocking VM.
8593 /* =================== Virtual Memory - Blocking Side ====================== */
8595 static void vmInit(void) {
8601 if (server
.vm_max_threads
!= 0)
8602 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
8604 redisLog(REDIS_NOTICE
,"Using '%s' as swap file",server
.vm_swap_file
);
8605 /* Try to open the old swap file, otherwise create it */
8606 if ((server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b")) == NULL
) {
8607 server
.vm_fp
= fopen(server
.vm_swap_file
,"w+b");
8609 if (server
.vm_fp
== NULL
) {
8610 redisLog(REDIS_WARNING
,
8611 "Can't open the swap file: %s. Exiting.",
8615 server
.vm_fd
= fileno(server
.vm_fp
);
8616 /* Lock the swap file for writing, this is useful in order to avoid
8617 * another instance to use the same swap file for a config error. */
8618 fl
.l_type
= F_WRLCK
;
8619 fl
.l_whence
= SEEK_SET
;
8620 fl
.l_start
= fl
.l_len
= 0;
8621 if (fcntl(server
.vm_fd
,F_SETLK
,&fl
) == -1) {
8622 redisLog(REDIS_WARNING
,
8623 "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
));
8627 server
.vm_next_page
= 0;
8628 server
.vm_near_pages
= 0;
8629 server
.vm_stats_used_pages
= 0;
8630 server
.vm_stats_swapped_objects
= 0;
8631 server
.vm_stats_swapouts
= 0;
8632 server
.vm_stats_swapins
= 0;
8633 totsize
= server
.vm_pages
*server
.vm_page_size
;
8634 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
8635 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
8636 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
8640 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
8642 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
8643 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
8644 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
8645 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
8647 /* Initialize threaded I/O (used by Virtual Memory) */
8648 server
.io_newjobs
= listCreate();
8649 server
.io_processing
= listCreate();
8650 server
.io_processed
= listCreate();
8651 server
.io_ready_clients
= listCreate();
8652 pthread_mutex_init(&server
.io_mutex
,NULL
);
8653 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
8654 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
8655 server
.io_active_threads
= 0;
8656 if (pipe(pipefds
) == -1) {
8657 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
8661 server
.io_ready_pipe_read
= pipefds
[0];
8662 server
.io_ready_pipe_write
= pipefds
[1];
8663 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
8664 /* LZF requires a lot of stack */
8665 pthread_attr_init(&server
.io_threads_attr
);
8666 pthread_attr_getstacksize(&server
.io_threads_attr
, &stacksize
);
8667 while (stacksize
< REDIS_THREAD_STACK_SIZE
) stacksize
*= 2;
8668 pthread_attr_setstacksize(&server
.io_threads_attr
, stacksize
);
8669 /* Listen for events in the threaded I/O pipe */
8670 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
8671 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
8672 oom("creating file event");
8675 /* Mark the page as used */
8676 static void vmMarkPageUsed(off_t page
) {
8677 off_t byte
= page
/8;
8679 redisAssert(vmFreePage(page
) == 1);
8680 server
.vm_bitmap
[byte
] |= 1<<bit
;
8683 /* Mark N contiguous pages as used, with 'page' being the first. */
8684 static void vmMarkPagesUsed(off_t page
, off_t count
) {
8687 for (j
= 0; j
< count
; j
++)
8688 vmMarkPageUsed(page
+j
);
8689 server
.vm_stats_used_pages
+= count
;
8690 redisLog(REDIS_DEBUG
,"Mark USED pages: %lld pages at %lld\n",
8691 (long long)count
, (long long)page
);
8694 /* Mark the page as free */
8695 static void vmMarkPageFree(off_t page
) {
8696 off_t byte
= page
/8;
8698 redisAssert(vmFreePage(page
) == 0);
8699 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
8702 /* Mark N contiguous pages as free, with 'page' being the first. */
8703 static void vmMarkPagesFree(off_t page
, off_t count
) {
8706 for (j
= 0; j
< count
; j
++)
8707 vmMarkPageFree(page
+j
);
8708 server
.vm_stats_used_pages
-= count
;
8709 redisLog(REDIS_DEBUG
,"Mark FREE pages: %lld pages at %lld\n",
8710 (long long)count
, (long long)page
);
8713 /* Test if the page is free */
8714 static int vmFreePage(off_t page
) {
8715 off_t byte
= page
/8;
8717 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
8720 /* Find N contiguous free pages storing the first page of the cluster in *first.
8721 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
8722 * REDIS_ERR is returned.
8724 * This function uses a simple algorithm: we try to allocate
8725 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
8726 * again from the start of the swap file searching for free spaces.
8728 * If it looks pretty clear that there are no free pages near our offset
8729 * we try to find less populated places doing a forward jump of
8730 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
8731 * without hurry, and then we jump again and so forth...
8733 * This function can be improved using a free list to avoid to guess
8734 * too much, since we could collect data about freed pages.
8736 * note: I implemented this function just after watching an episode of
8737 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
8739 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
8740 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
8742 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
8743 server
.vm_near_pages
= 0;
8744 server
.vm_next_page
= 0;
8746 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
8747 base
= server
.vm_next_page
;
8749 while(offset
< server
.vm_pages
) {
8750 off_t
this = base
+offset
;
8752 /* If we overflow, restart from page zero */
8753 if (this >= server
.vm_pages
) {
8754 this -= server
.vm_pages
;
8756 /* Just overflowed, what we found on tail is no longer
8757 * interesting, as it's no longer contiguous. */
8761 if (vmFreePage(this)) {
8762 /* This is a free page */
8764 /* Already got N free pages? Return to the caller, with success */
8766 *first
= this-(n
-1);
8767 server
.vm_next_page
= this+1;
8768 redisLog(REDIS_DEBUG
, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n
, (long long) *first
);
8772 /* The current one is not a free page */
8776 /* Fast-forward if the current page is not free and we already
8777 * searched enough near this place. */
8779 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
8780 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
8782 /* Note that even if we rewind after the jump, we are don't need
8783 * to make sure numfree is set to zero as we only jump *if* it
8784 * is set to zero. */
8786 /* Otherwise just check the next page */
8793 /* Write the specified object at the specified page of the swap file */
8794 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
8795 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8796 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8797 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8798 redisLog(REDIS_WARNING
,
8799 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
8803 rdbSaveObject(server
.vm_fp
,o
);
8804 fflush(server
.vm_fp
);
8805 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8809 /* Swap the 'val' object relative to 'key' into disk. Store all the information
8810 * needed to later retrieve the object into the key object.
8811 * If we can't find enough contiguous empty pages to swap the object on disk
8812 * REDIS_ERR is returned. */
8813 static int vmSwapObjectBlocking(robj
*key
, robj
*val
) {
8814 off_t pages
= rdbSavedObjectPages(val
,NULL
);
8817 assert(key
->storage
== REDIS_VM_MEMORY
);
8818 assert(key
->refcount
== 1);
8819 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
8820 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return REDIS_ERR
;
8821 key
->vm
.page
= page
;
8822 key
->vm
.usedpages
= pages
;
8823 key
->storage
= REDIS_VM_SWAPPED
;
8824 key
->vtype
= val
->type
;
8825 decrRefCount(val
); /* Deallocate the object from memory. */
8826 vmMarkPagesUsed(page
,pages
);
8827 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
8828 (unsigned char*) key
->ptr
,
8829 (unsigned long long) page
, (unsigned long long) pages
);
8830 server
.vm_stats_swapped_objects
++;
8831 server
.vm_stats_swapouts
++;
8835 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
8838 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8839 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8840 redisLog(REDIS_WARNING
,
8841 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
8845 o
= rdbLoadObject(type
,server
.vm_fp
);
8847 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno
));
8850 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8854 /* Load the value object relative to the 'key' object from swap to memory.
8855 * The newly allocated object is returned.
8857 * If preview is true the unserialized object is returned to the caller but
8858 * no changes are made to the key object, nor the pages are marked as freed */
8859 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
8862 redisAssert(key
->storage
== REDIS_VM_SWAPPED
|| key
->storage
== REDIS_VM_LOADING
);
8863 val
= vmReadObjectFromSwap(key
->vm
.page
,key
->vtype
);
8865 key
->storage
= REDIS_VM_MEMORY
;
8866 key
->vm
.atime
= server
.unixtime
;
8867 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8868 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
8869 (unsigned char*) key
->ptr
);
8870 server
.vm_stats_swapped_objects
--;
8872 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
8873 (unsigned char*) key
->ptr
);
8875 server
.vm_stats_swapins
++;
8879 /* Plain object loading, from swap to memory */
8880 static robj
*vmLoadObject(robj
*key
) {
8881 /* If we are loading the object in background, stop it, we
8882 * need to load this object synchronously ASAP. */
8883 if (key
->storage
== REDIS_VM_LOADING
)
8884 vmCancelThreadedIOJob(key
);
8885 return vmGenericLoadObject(key
,0);
8888 /* Just load the value on disk, without to modify the key.
8889 * This is useful when we want to perform some operation on the value
8890 * without to really bring it from swap to memory, like while saving the
8891 * dataset or rewriting the append only log. */
8892 static robj
*vmPreviewObject(robj
*key
) {
8893 return vmGenericLoadObject(key
,1);
8896 /* How a good candidate is this object for swapping?
8897 * The better candidate it is, the greater the returned value.
8899 * Currently we try to perform a fast estimation of the object size in
8900 * memory, and combine it with aging informations.
8902 * Basically swappability = idle-time * log(estimated size)
8904 * Bigger objects are preferred over smaller objects, but not
8905 * proportionally, this is why we use the logarithm. This algorithm is
8906 * just a first try and will probably be tuned later. */
8907 static double computeObjectSwappability(robj
*o
) {
8908 time_t age
= server
.unixtime
- o
->vm
.atime
;
8912 struct dictEntry
*de
;
8915 if (age
<= 0) return 0;
8918 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
8921 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
8926 listNode
*ln
= listFirst(l
);
8928 asize
= sizeof(list
);
8930 robj
*ele
= ln
->value
;
8933 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8934 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8936 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
8941 z
= (o
->type
== REDIS_ZSET
);
8942 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
8944 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
8945 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
8950 de
= dictGetRandomKey(d
);
8951 ele
= dictGetEntryKey(de
);
8952 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8953 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8955 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
8956 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
8960 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
8961 unsigned char *p
= zipmapRewind((unsigned char*)o
->ptr
);
8962 unsigned int len
= zipmapLen((unsigned char*)o
->ptr
);
8963 unsigned int klen
, vlen
;
8964 unsigned char *key
, *val
;
8966 if ((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) == NULL
) {
8970 asize
= len
*(klen
+vlen
+3);
8971 } else if (o
->encoding
== REDIS_ENCODING_HT
) {
8973 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
8978 de
= dictGetRandomKey(d
);
8979 ele
= dictGetEntryKey(de
);
8980 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8981 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8983 ele
= dictGetEntryVal(de
);
8984 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8985 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8987 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
8992 return (double)age
*log(1+asize
);
8995 /* Try to swap an object that's a good candidate for swapping.
8996 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
8997 * to swap any object at all.
8999 * If 'usethreaded' is true, Redis will try to swap the object in background
9000 * using I/O threads. */
9001 static int vmSwapOneObject(int usethreads
) {
9003 struct dictEntry
*best
= NULL
;
9004 double best_swappability
= 0;
9005 redisDb
*best_db
= NULL
;
9008 for (j
= 0; j
< server
.dbnum
; j
++) {
9009 redisDb
*db
= server
.db
+j
;
9010 /* Why maxtries is set to 100?
9011 * Because this way (usually) we'll find 1 object even if just 1% - 2%
9012 * are swappable objects */
9015 if (dictSize(db
->dict
) == 0) continue;
9016 for (i
= 0; i
< 5; i
++) {
9018 double swappability
;
9020 if (maxtries
) maxtries
--;
9021 de
= dictGetRandomKey(db
->dict
);
9022 key
= dictGetEntryKey(de
);
9023 val
= dictGetEntryVal(de
);
9024 /* Only swap objects that are currently in memory.
9026 * Also don't swap shared objects if threaded VM is on, as we
9027 * try to ensure that the main thread does not touch the
9028 * object while the I/O thread is using it, but we can't
9029 * control other keys without adding additional mutex. */
9030 if (key
->storage
!= REDIS_VM_MEMORY
||
9031 (server
.vm_max_threads
!= 0 && val
->refcount
!= 1)) {
9032 if (maxtries
) i
--; /* don't count this try */
9035 swappability
= computeObjectSwappability(val
);
9036 if (!best
|| swappability
> best_swappability
) {
9038 best_swappability
= swappability
;
9043 if (best
== NULL
) return REDIS_ERR
;
9044 key
= dictGetEntryKey(best
);
9045 val
= dictGetEntryVal(best
);
9047 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
9048 key
->ptr
, best_swappability
);
9050 /* Unshare the key if needed */
9051 if (key
->refcount
> 1) {
9052 robj
*newkey
= dupStringObject(key
);
9054 key
= dictGetEntryKey(best
) = newkey
;
9058 vmSwapObjectThreaded(key
,val
,best_db
);
9061 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
9062 dictGetEntryVal(best
) = NULL
;
9070 static int vmSwapOneObjectBlocking() {
9071 return vmSwapOneObject(0);
9074 static int vmSwapOneObjectThreaded() {
9075 return vmSwapOneObject(1);
9078 /* Return true if it's safe to swap out objects in a given moment.
9079 * Basically we don't want to swap objects out while there is a BGSAVE
9080 * or a BGAEOREWRITE running in backgroud. */
9081 static int vmCanSwapOut(void) {
9082 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
9085 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
9086 * and was deleted. Otherwise 0 is returned. */
9087 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
9091 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
9092 foundkey
= dictGetEntryKey(de
);
9093 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
9098 /* =================== Virtual Memory - Threaded I/O ======================= */
9100 static void freeIOJob(iojob
*j
) {
9101 if ((j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
9102 j
->type
== REDIS_IOJOB_DO_SWAP
||
9103 j
->type
== REDIS_IOJOB_LOAD
) && j
->val
!= NULL
)
9104 decrRefCount(j
->val
);
9105 /* We don't decrRefCount the j->key field as we did't incremented
9106 * the count creating IO Jobs. This is because the key field here is
9107 * just used as an indentifier and if a key is removed the Job should
9108 * never be touched again. */
9112 /* Every time a thread finished a Job, it writes a byte into the write side
9113 * of an unix pipe in order to "awake" the main thread, and this function
9115 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
9119 int retval
, processed
= 0, toprocess
= -1, trytoswap
= 1;
9121 REDIS_NOTUSED(mask
);
9122 REDIS_NOTUSED(privdata
);
9124 /* For every byte we read in the read side of the pipe, there is one
9125 * I/O job completed to process. */
9126 while((retval
= read(fd
,buf
,1)) == 1) {
9130 struct dictEntry
*de
;
9132 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
9134 /* Get the processed element (the oldest one) */
9136 assert(listLength(server
.io_processed
) != 0);
9137 if (toprocess
== -1) {
9138 toprocess
= (listLength(server
.io_processed
)*REDIS_MAX_COMPLETED_JOBS_PROCESSED
)/100;
9139 if (toprocess
<= 0) toprocess
= 1;
9141 ln
= listFirst(server
.io_processed
);
9143 listDelNode(server
.io_processed
,ln
);
9145 /* If this job is marked as canceled, just ignore it */
9150 /* Post process it in the main thread, as there are things we
9151 * can do just here to avoid race conditions and/or invasive locks */
9152 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
);
9153 de
= dictFind(j
->db
->dict
,j
->key
);
9155 key
= dictGetEntryKey(de
);
9156 if (j
->type
== REDIS_IOJOB_LOAD
) {
9159 /* Key loaded, bring it at home */
9160 key
->storage
= REDIS_VM_MEMORY
;
9161 key
->vm
.atime
= server
.unixtime
;
9162 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
9163 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
9164 (unsigned char*) key
->ptr
);
9165 server
.vm_stats_swapped_objects
--;
9166 server
.vm_stats_swapins
++;
9167 dictGetEntryVal(de
) = j
->val
;
9168 incrRefCount(j
->val
);
9171 /* Handle clients waiting for this key to be loaded. */
9172 handleClientsBlockedOnSwappedKey(db
,key
);
9173 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
9174 /* Now we know the amount of pages required to swap this object.
9175 * Let's find some space for it, and queue this task again
9176 * rebranded as REDIS_IOJOB_DO_SWAP. */
9177 if (!vmCanSwapOut() ||
9178 vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
)
9180 /* Ooops... no space or we can't swap as there is
9181 * a fork()ed Redis trying to save stuff on disk. */
9183 key
->storage
= REDIS_VM_MEMORY
; /* undo operation */
9185 /* Note that we need to mark this pages as used now,
9186 * if the job will be canceled, we'll mark them as freed
9188 vmMarkPagesUsed(j
->page
,j
->pages
);
9189 j
->type
= REDIS_IOJOB_DO_SWAP
;
9194 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
9197 /* Key swapped. We can finally free some memory. */
9198 if (key
->storage
!= REDIS_VM_SWAPPING
) {
9199 printf("key->storage: %d\n",key
->storage
);
9200 printf("key->name: %s\n",(char*)key
->ptr
);
9201 printf("key->refcount: %d\n",key
->refcount
);
9202 printf("val: %p\n",(void*)j
->val
);
9203 printf("val->type: %d\n",j
->val
->type
);
9204 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
9206 redisAssert(key
->storage
== REDIS_VM_SWAPPING
);
9207 val
= dictGetEntryVal(de
);
9208 key
->vm
.page
= j
->page
;
9209 key
->vm
.usedpages
= j
->pages
;
9210 key
->storage
= REDIS_VM_SWAPPED
;
9211 key
->vtype
= j
->val
->type
;
9212 decrRefCount(val
); /* Deallocate the object from memory. */
9213 dictGetEntryVal(de
) = NULL
;
9214 redisLog(REDIS_DEBUG
,
9215 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
9216 (unsigned char*) key
->ptr
,
9217 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
9218 server
.vm_stats_swapped_objects
++;
9219 server
.vm_stats_swapouts
++;
9221 /* Put a few more swap requests in queue if we are still
9223 if (trytoswap
&& vmCanSwapOut() &&
9224 zmalloc_used_memory() > server
.vm_max_memory
)
9229 more
= listLength(server
.io_newjobs
) <
9230 (unsigned) server
.vm_max_threads
;
9232 /* Don't waste CPU time if swappable objects are rare. */
9233 if (vmSwapOneObjectThreaded() == REDIS_ERR
) {
9241 if (processed
== toprocess
) return;
9243 if (retval
< 0 && errno
!= EAGAIN
) {
9244 redisLog(REDIS_WARNING
,
9245 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
9250 static void lockThreadedIO(void) {
9251 pthread_mutex_lock(&server
.io_mutex
);
9254 static void unlockThreadedIO(void) {
9255 pthread_mutex_unlock(&server
.io_mutex
);
9258 /* Remove the specified object from the threaded I/O queue if still not
9259 * processed, otherwise make sure to flag it as canceled. */
9260 static void vmCancelThreadedIOJob(robj
*o
) {
9262 server
.io_newjobs
, /* 0 */
9263 server
.io_processing
, /* 1 */
9264 server
.io_processed
/* 2 */
9268 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
9271 /* Search for a matching key in one of the queues */
9272 for (i
= 0; i
< 3; i
++) {
9276 listRewind(lists
[i
],&li
);
9277 while ((ln
= listNext(&li
)) != NULL
) {
9278 iojob
*job
= ln
->value
;
9280 if (job
->canceled
) continue; /* Skip this, already canceled. */
9281 if (job
->key
== o
) {
9282 redisLog(REDIS_DEBUG
,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
9283 (void*)job
, (char*)o
->ptr
, job
->type
, i
);
9284 /* Mark the pages as free since the swap didn't happened
9285 * or happened but is now discarded. */
9286 if (i
!= 1 && job
->type
== REDIS_IOJOB_DO_SWAP
)
9287 vmMarkPagesFree(job
->page
,job
->pages
);
9288 /* Cancel the job. It depends on the list the job is
9291 case 0: /* io_newjobs */
9292 /* If the job was yet not processed the best thing to do
9293 * is to remove it from the queue at all */
9295 listDelNode(lists
[i
],ln
);
9297 case 1: /* io_processing */
9298 /* Oh Shi- the thread is messing with the Job:
9300 * Probably it's accessing the object if this is a
9301 * PREPARE_SWAP or DO_SWAP job.
9302 * If it's a LOAD job it may be reading from disk and
9303 * if we don't wait for the job to terminate before to
9304 * cancel it, maybe in a few microseconds data can be
9305 * corrupted in this pages. So the short story is:
9307 * Better to wait for the job to move into the
9308 * next queue (processed)... */
9310 /* We try again and again until the job is completed. */
9312 /* But let's wait some time for the I/O thread
9313 * to finish with this job. After all this condition
9314 * should be very rare. */
9317 case 2: /* io_processed */
9318 /* The job was already processed, that's easy...
9319 * just mark it as canceled so that we'll ignore it
9320 * when processing completed jobs. */
9324 /* Finally we have to adjust the storage type of the object
9325 * in order to "UNDO" the operaiton. */
9326 if (o
->storage
== REDIS_VM_LOADING
)
9327 o
->storage
= REDIS_VM_SWAPPED
;
9328 else if (o
->storage
== REDIS_VM_SWAPPING
)
9329 o
->storage
= REDIS_VM_MEMORY
;
9336 assert(1 != 1); /* We should never reach this */
9339 static void *IOThreadEntryPoint(void *arg
) {
9344 pthread_detach(pthread_self());
9346 /* Get a new job to process */
9348 if (listLength(server
.io_newjobs
) == 0) {
9349 /* No new jobs in queue, exit. */
9350 redisLog(REDIS_DEBUG
,"Thread %ld exiting, nothing to do",
9351 (long) pthread_self());
9352 server
.io_active_threads
--;
9356 ln
= listFirst(server
.io_newjobs
);
9358 listDelNode(server
.io_newjobs
,ln
);
9359 /* Add the job in the processing queue */
9360 j
->thread
= pthread_self();
9361 listAddNodeTail(server
.io_processing
,j
);
9362 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
9364 redisLog(REDIS_DEBUG
,"Thread %ld got a new job (type %d): %p about key '%s'",
9365 (long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
9367 /* Process the Job */
9368 if (j
->type
== REDIS_IOJOB_LOAD
) {
9369 j
->val
= vmReadObjectFromSwap(j
->page
,j
->key
->vtype
);
9370 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
9371 FILE *fp
= fopen("/dev/null","w+");
9372 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
9374 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
9375 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
9379 /* Done: insert the job into the processed queue */
9380 redisLog(REDIS_DEBUG
,"Thread %ld completed the job: %p (key %s)",
9381 (long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
9383 listDelNode(server
.io_processing
,ln
);
9384 listAddNodeTail(server
.io_processed
,j
);
9387 /* Signal the main thread there is new stuff to process */
9388 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
9390 return NULL
; /* never reached */
9393 static void spawnIOThread(void) {
9395 sigset_t mask
, omask
;
9399 sigaddset(&mask
,SIGCHLD
);
9400 sigaddset(&mask
,SIGHUP
);
9401 sigaddset(&mask
,SIGPIPE
);
9402 pthread_sigmask(SIG_SETMASK
, &mask
, &omask
);
9403 while ((err
= pthread_create(&thread
,&server
.io_threads_attr
,IOThreadEntryPoint
,NULL
)) != 0) {
9404 redisLog(REDIS_WARNING
,"Unable to spawn an I/O thread: %s",
9408 pthread_sigmask(SIG_SETMASK
, &omask
, NULL
);
9409 server
.io_active_threads
++;
9412 /* We need to wait for the last thread to exit before we are able to
9413 * fork() in order to BGSAVE or BGREWRITEAOF. */
9414 static void waitEmptyIOJobsQueue(void) {
9416 int io_processed_len
;
9419 if (listLength(server
.io_newjobs
) == 0 &&
9420 listLength(server
.io_processing
) == 0 &&
9421 server
.io_active_threads
== 0)
9426 /* While waiting for empty jobs queue condition we post-process some
9427 * finshed job, as I/O threads may be hanging trying to write against
9428 * the io_ready_pipe_write FD but there are so much pending jobs that
9430 io_processed_len
= listLength(server
.io_processed
);
9432 if (io_processed_len
) {
9433 vmThreadedIOCompletedJob(NULL
,server
.io_ready_pipe_read
,NULL
,0);
9434 usleep(1000); /* 1 millisecond */
9436 usleep(10000); /* 10 milliseconds */
9441 static void vmReopenSwapFile(void) {
9442 /* Note: we don't close the old one as we are in the child process
9443 * and don't want to mess at all with the original file object. */
9444 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
9445 if (server
.vm_fp
== NULL
) {
9446 redisLog(REDIS_WARNING
,"Can't re-open the VM swap file: %s. Exiting.",
9447 server
.vm_swap_file
);
9450 server
.vm_fd
= fileno(server
.vm_fp
);
9453 /* This function must be called while with threaded IO locked */
9454 static void queueIOJob(iojob
*j
) {
9455 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
9456 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
9457 listAddNodeTail(server
.io_newjobs
,j
);
9458 if (server
.io_active_threads
< server
.vm_max_threads
)
9462 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
9465 assert(key
->storage
== REDIS_VM_MEMORY
);
9466 assert(key
->refcount
== 1);
9468 j
= zmalloc(sizeof(*j
));
9469 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
9475 j
->thread
= (pthread_t
) -1;
9476 key
->storage
= REDIS_VM_SWAPPING
;
9484 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
9486 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
9487 * If there is not already a job loading the key, it is craeted.
9488 * The key is added to the io_keys list in the client structure, and also
9489 * in the hash table mapping swapped keys to waiting clients, that is,
9490 * server.io_waited_keys. */
9491 static int waitForSwappedKey(redisClient
*c
, robj
*key
) {
9492 struct dictEntry
*de
;
9496 /* If the key does not exist or is already in RAM we don't need to
9497 * block the client at all. */
9498 de
= dictFind(c
->db
->dict
,key
);
9499 if (de
== NULL
) return 0;
9500 o
= dictGetEntryKey(de
);
9501 if (o
->storage
== REDIS_VM_MEMORY
) {
9503 } else if (o
->storage
== REDIS_VM_SWAPPING
) {
9504 /* We were swapping the key, undo it! */
9505 vmCancelThreadedIOJob(o
);
9509 /* OK: the key is either swapped, or being loaded just now. */
9511 /* Add the key to the list of keys this client is waiting for.
9512 * This maps clients to keys they are waiting for. */
9513 listAddNodeTail(c
->io_keys
,key
);
9516 /* Add the client to the swapped keys => clients waiting map. */
9517 de
= dictFind(c
->db
->io_keys
,key
);
9521 /* For every key we take a list of clients blocked for it */
9523 retval
= dictAdd(c
->db
->io_keys
,key
,l
);
9525 assert(retval
== DICT_OK
);
9527 l
= dictGetEntryVal(de
);
9529 listAddNodeTail(l
,c
);
9531 /* Are we already loading the key from disk? If not create a job */
9532 if (o
->storage
== REDIS_VM_SWAPPED
) {
9535 o
->storage
= REDIS_VM_LOADING
;
9536 j
= zmalloc(sizeof(*j
));
9537 j
->type
= REDIS_IOJOB_LOAD
;
9540 j
->key
->vtype
= o
->vtype
;
9541 j
->page
= o
->vm
.page
;
9544 j
->thread
= (pthread_t
) -1;
9552 /* Preload keys for any command with first, last and step values for
9553 * the command keys prototype, as defined in the command table. */
9554 static void waitForMultipleSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
, int argc
, robj
**argv
) {
9556 if (cmd
->vm_firstkey
== 0) return;
9557 last
= cmd
->vm_lastkey
;
9558 if (last
< 0) last
= argc
+last
;
9559 for (j
= cmd
->vm_firstkey
; j
<= last
; j
+= cmd
->vm_keystep
) {
9560 redisAssert(j
< argc
);
9561 waitForSwappedKey(c
,argv
[j
]);
9565 /* Preload keys needed for the ZUNION and ZINTER commands.
9566 * Note that the number of keys to preload is user-defined, so we need to
9567 * apply a sanity check against argc. */
9568 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
, int argc
, robj
**argv
) {
9572 num
= atoi(argv
[2]->ptr
);
9573 if (num
> (argc
-3)) return;
9574 for (i
= 0; i
< num
; i
++) {
9575 waitForSwappedKey(c
,argv
[3+i
]);
9579 /* Is this client attempting to run a command against swapped keys?
9580 * If so, block it ASAP, load the keys in background, then resume it.
9582 * The important idea about this function is that it can fail! If keys will
9583 * still be swapped when the client is resumed, this key lookups will
9584 * just block loading keys from disk. In practical terms this should only
9585 * happen with SORT BY command or if there is a bug in this function.
9587 * Return 1 if the client is marked as blocked, 0 if the client can
9588 * continue as the keys it is going to access appear to be in memory. */
9589 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
) {
9590 if (cmd
->vm_preload_proc
!= NULL
) {
9591 cmd
->vm_preload_proc(c
,cmd
,c
->argc
,c
->argv
);
9593 waitForMultipleSwappedKeys(c
,cmd
,c
->argc
,c
->argv
);
9596 /* If the client was blocked for at least one key, mark it as blocked. */
9597 if (listLength(c
->io_keys
)) {
9598 c
->flags
|= REDIS_IO_WAIT
;
9599 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
9600 server
.vm_blocked_clients
++;
9607 /* Remove the 'key' from the list of blocked keys for a given client.
9609 * The function returns 1 when there are no longer blocking keys after
9610 * the current one was removed (and the client can be unblocked). */
9611 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
) {
9615 struct dictEntry
*de
;
9617 /* Remove the key from the list of keys this client is waiting for. */
9618 listRewind(c
->io_keys
,&li
);
9619 while ((ln
= listNext(&li
)) != NULL
) {
9620 if (compareStringObjects(ln
->value
,key
) == 0) {
9621 listDelNode(c
->io_keys
,ln
);
9627 /* Remove the client form the key => waiting clients map. */
9628 de
= dictFind(c
->db
->io_keys
,key
);
9630 l
= dictGetEntryVal(de
);
9631 ln
= listSearchKey(l
,c
);
9634 if (listLength(l
) == 0)
9635 dictDelete(c
->db
->io_keys
,key
);
9637 return listLength(c
->io_keys
) == 0;
9640 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
) {
9641 struct dictEntry
*de
;
9646 de
= dictFind(db
->io_keys
,key
);
9649 l
= dictGetEntryVal(de
);
9650 len
= listLength(l
);
9651 /* Note: we can't use something like while(listLength(l)) as the list
9652 * can be freed by the calling function when we remove the last element. */
9655 redisClient
*c
= ln
->value
;
9657 if (dontWaitForSwappedKey(c
,key
)) {
9658 /* Put the client in the list of clients ready to go as we
9659 * loaded all the keys about it. */
9660 listAddNodeTail(server
.io_ready_clients
,c
);
9665 /* =========================== Remote Configuration ========================= */
9667 static void configSetCommand(redisClient
*c
) {
9668 robj
*o
= getDecodedObject(c
->argv
[3]);
9669 if (!strcasecmp(c
->argv
[2]->ptr
,"dbfilename")) {
9670 zfree(server
.dbfilename
);
9671 server
.dbfilename
= zstrdup(o
->ptr
);
9672 } else if (!strcasecmp(c
->argv
[2]->ptr
,"requirepass")) {
9673 zfree(server
.requirepass
);
9674 server
.requirepass
= zstrdup(o
->ptr
);
9675 } else if (!strcasecmp(c
->argv
[2]->ptr
,"masterauth")) {
9676 zfree(server
.masterauth
);
9677 server
.masterauth
= zstrdup(o
->ptr
);
9678 } else if (!strcasecmp(c
->argv
[2]->ptr
,"maxmemory")) {
9679 server
.maxmemory
= strtoll(o
->ptr
, NULL
, 10);
9681 addReplySds(c
,sdscatprintf(sdsempty(),
9682 "-ERR not supported CONFIG parameter %s\r\n",
9683 (char*)c
->argv
[2]->ptr
));
9688 addReply(c
,shared
.ok
);
9691 static void configGetCommand(redisClient
*c
) {
9692 robj
*o
= getDecodedObject(c
->argv
[2]);
9693 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
9694 char *pattern
= o
->ptr
;
9698 decrRefCount(lenobj
);
9700 if (stringmatch(pattern
,"dbfilename",0)) {
9701 addReplyBulkCString(c
,"dbfilename");
9702 addReplyBulkCString(c
,server
.dbfilename
);
9705 if (stringmatch(pattern
,"requirepass",0)) {
9706 addReplyBulkCString(c
,"requirepass");
9707 addReplyBulkCString(c
,server
.requirepass
);
9710 if (stringmatch(pattern
,"masterauth",0)) {
9711 addReplyBulkCString(c
,"masterauth");
9712 addReplyBulkCString(c
,server
.masterauth
);
9715 if (stringmatch(pattern
,"maxmemory",0)) {
9718 snprintf(buf
,128,"%llu\n",server
.maxmemory
);
9719 addReplyBulkCString(c
,"maxmemory");
9720 addReplyBulkCString(c
,buf
);
9724 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%d\r\n",matches
*2);
9727 static void configCommand(redisClient
*c
) {
9728 if (!strcasecmp(c
->argv
[1]->ptr
,"set")) {
9729 if (c
->argc
!= 4) goto badarity
;
9730 configSetCommand(c
);
9731 } else if (!strcasecmp(c
->argv
[1]->ptr
,"get")) {
9732 if (c
->argc
!= 3) goto badarity
;
9733 configGetCommand(c
);
9734 } else if (!strcasecmp(c
->argv
[1]->ptr
,"resetstat")) {
9735 if (c
->argc
!= 2) goto badarity
;
9736 server
.stat_numcommands
= 0;
9737 server
.stat_numconnections
= 0;
9738 server
.stat_expiredkeys
= 0;
9739 server
.stat_starttime
= time(NULL
);
9740 addReply(c
,shared
.ok
);
9742 addReplySds(c
,sdscatprintf(sdsempty(),
9743 "-ERR CONFIG subcommand must be one of GET, SET, RESETSTAT\r\n"));
9748 addReplySds(c
,sdscatprintf(sdsempty(),
9749 "-ERR Wrong number of arguments for CONFIG %s\r\n",
9750 (char*) c
->argv
[1]->ptr
));
9753 /* =========================== Pubsub implementation ======================== */
9755 static void freePubsubPattern(void *p
) {
9756 pubsubPattern
*pat
= p
;
9758 decrRefCount(pat
->pattern
);
9762 static int listMatchPubsubPattern(void *a
, void *b
) {
9763 pubsubPattern
*pa
= a
, *pb
= b
;
9765 return (pa
->client
== pb
->client
) &&
9766 (compareStringObjects(pa
->pattern
,pb
->pattern
) == 0);
9769 /* Subscribe a client to a channel. Returns 1 if the operation succeeded, or
9770 * 0 if the client was already subscribed to that channel. */
9771 static int pubsubSubscribeChannel(redisClient
*c
, robj
*channel
) {
9772 struct dictEntry
*de
;
9773 list
*clients
= NULL
;
9776 /* Add the channel to the client -> channels hash table */
9777 if (dictAdd(c
->pubsub_channels
,channel
,NULL
) == DICT_OK
) {
9779 incrRefCount(channel
);
9780 /* Add the client to the channel -> list of clients hash table */
9781 de
= dictFind(server
.pubsub_channels
,channel
);
9783 clients
= listCreate();
9784 dictAdd(server
.pubsub_channels
,channel
,clients
);
9785 incrRefCount(channel
);
9787 clients
= dictGetEntryVal(de
);
9789 listAddNodeTail(clients
,c
);
9791 /* Notify the client */
9792 addReply(c
,shared
.mbulk3
);
9793 addReply(c
,shared
.subscribebulk
);
9794 addReplyBulk(c
,channel
);
9795 addReplyLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
9799 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9800 * 0 if the client was not subscribed to the specified channel. */
9801 static int pubsubUnsubscribeChannel(redisClient
*c
, robj
*channel
, int notify
) {
9802 struct dictEntry
*de
;
9807 /* Remove the channel from the client -> channels hash table */
9808 incrRefCount(channel
); /* channel may be just a pointer to the same object
9809 we have in the hash tables. Protect it... */
9810 if (dictDelete(c
->pubsub_channels
,channel
) == DICT_OK
) {
9812 /* Remove the client from the channel -> clients list hash table */
9813 de
= dictFind(server
.pubsub_channels
,channel
);
9815 clients
= dictGetEntryVal(de
);
9816 ln
= listSearchKey(clients
,c
);
9818 listDelNode(clients
,ln
);
9819 if (listLength(clients
) == 0) {
9820 /* Free the list and associated hash entry at all if this was
9821 * the latest client, so that it will be possible to abuse
9822 * Redis PUBSUB creating millions of channels. */
9823 dictDelete(server
.pubsub_channels
,channel
);
9826 /* Notify the client */
9828 addReply(c
,shared
.mbulk3
);
9829 addReply(c
,shared
.unsubscribebulk
);
9830 addReplyBulk(c
,channel
);
9831 addReplyLong(c
,dictSize(c
->pubsub_channels
)+
9832 listLength(c
->pubsub_patterns
));
9835 decrRefCount(channel
); /* it is finally safe to release it */
9839 /* Subscribe a client to a pattern. Returns 1 if the operation succeeded, or 0 if the clinet was already subscribed to that pattern. */
9840 static int pubsubSubscribePattern(redisClient
*c
, robj
*pattern
) {
9843 if (listSearchKey(c
->pubsub_patterns
,pattern
) == NULL
) {
9846 listAddNodeTail(c
->pubsub_patterns
,pattern
);
9847 incrRefCount(pattern
);
9848 pat
= zmalloc(sizeof(*pat
));
9849 pat
->pattern
= getDecodedObject(pattern
);
9851 listAddNodeTail(server
.pubsub_patterns
,pat
);
9853 /* Notify the client */
9854 addReply(c
,shared
.mbulk3
);
9855 addReply(c
,shared
.psubscribebulk
);
9856 addReplyBulk(c
,pattern
);
9857 addReplyLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
9861 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9862 * 0 if the client was not subscribed to the specified channel. */
9863 static int pubsubUnsubscribePattern(redisClient
*c
, robj
*pattern
, int notify
) {
9868 incrRefCount(pattern
); /* Protect the object. May be the same we remove */
9869 if ((ln
= listSearchKey(c
->pubsub_patterns
,pattern
)) != NULL
) {
9871 listDelNode(c
->pubsub_patterns
,ln
);
9873 pat
.pattern
= pattern
;
9874 ln
= listSearchKey(server
.pubsub_patterns
,&pat
);
9875 listDelNode(server
.pubsub_patterns
,ln
);
9877 /* Notify the client */
9879 addReply(c
,shared
.mbulk3
);
9880 addReply(c
,shared
.punsubscribebulk
);
9881 addReplyBulk(c
,pattern
);
9882 addReplyLong(c
,dictSize(c
->pubsub_channels
)+
9883 listLength(c
->pubsub_patterns
));
9885 decrRefCount(pattern
);
9889 /* Unsubscribe from all the channels. Return the number of channels the
9890 * client was subscribed from. */
9891 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
) {
9892 dictIterator
*di
= dictGetIterator(c
->pubsub_channels
);
9896 while((de
= dictNext(di
)) != NULL
) {
9897 robj
*channel
= dictGetEntryKey(de
);
9899 count
+= pubsubUnsubscribeChannel(c
,channel
,notify
);
9901 dictReleaseIterator(di
);
9905 /* Unsubscribe from all the patterns. Return the number of patterns the
9906 * client was subscribed from. */
9907 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
) {
9912 listRewind(c
->pubsub_patterns
,&li
);
9913 while ((ln
= listNext(&li
)) != NULL
) {
9914 robj
*pattern
= ln
->value
;
9916 count
+= pubsubUnsubscribePattern(c
,pattern
,notify
);
9921 /* Publish a message */
9922 static int pubsubPublishMessage(robj
*channel
, robj
*message
) {
9924 struct dictEntry
*de
;
9928 /* Send to clients listening for that channel */
9929 de
= dictFind(server
.pubsub_channels
,channel
);
9931 list
*list
= dictGetEntryVal(de
);
9935 listRewind(list
,&li
);
9936 while ((ln
= listNext(&li
)) != NULL
) {
9937 redisClient
*c
= ln
->value
;
9939 addReply(c
,shared
.mbulk3
);
9940 addReply(c
,shared
.messagebulk
);
9941 addReplyBulk(c
,channel
);
9942 addReplyBulk(c
,message
);
9946 /* Send to clients listening to matching channels */
9947 if (listLength(server
.pubsub_patterns
)) {
9948 listRewind(server
.pubsub_patterns
,&li
);
9949 channel
= getDecodedObject(channel
);
9950 while ((ln
= listNext(&li
)) != NULL
) {
9951 pubsubPattern
*pat
= ln
->value
;
9953 if (stringmatchlen((char*)pat
->pattern
->ptr
,
9954 sdslen(pat
->pattern
->ptr
),
9955 (char*)channel
->ptr
,
9956 sdslen(channel
->ptr
),0)) {
9957 addReply(pat
->client
,shared
.mbulk4
);
9958 addReply(pat
->client
,shared
.pmessagebulk
);
9959 addReplyBulk(pat
->client
,pat
->pattern
);
9960 addReplyBulk(pat
->client
,channel
);
9961 addReplyBulk(pat
->client
,message
);
9965 decrRefCount(channel
);
9970 static void subscribeCommand(redisClient
*c
) {
9973 for (j
= 1; j
< c
->argc
; j
++)
9974 pubsubSubscribeChannel(c
,c
->argv
[j
]);
9977 static void unsubscribeCommand(redisClient
*c
) {
9979 pubsubUnsubscribeAllChannels(c
,1);
9984 for (j
= 1; j
< c
->argc
; j
++)
9985 pubsubUnsubscribeChannel(c
,c
->argv
[j
],1);
9989 static void psubscribeCommand(redisClient
*c
) {
9992 for (j
= 1; j
< c
->argc
; j
++)
9993 pubsubSubscribePattern(c
,c
->argv
[j
]);
9996 static void punsubscribeCommand(redisClient
*c
) {
9998 pubsubUnsubscribeAllPatterns(c
,1);
10003 for (j
= 1; j
< c
->argc
; j
++)
10004 pubsubUnsubscribePattern(c
,c
->argv
[j
],1);
10008 static void publishCommand(redisClient
*c
) {
10009 int receivers
= pubsubPublishMessage(c
->argv
[1],c
->argv
[2]);
10010 addReplyLong(c
,receivers
);
10013 /* ================================= Debugging ============================== */
10015 static void debugCommand(redisClient
*c
) {
10016 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
10017 *((char*)-1) = 'x';
10018 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
10019 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
10020 addReply(c
,shared
.err
);
10024 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
10025 addReply(c
,shared
.err
);
10028 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
10029 addReply(c
,shared
.ok
);
10030 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
10032 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
10033 addReply(c
,shared
.err
);
10036 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
10037 addReply(c
,shared
.ok
);
10038 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
10039 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
10043 addReply(c
,shared
.nokeyerr
);
10046 key
= dictGetEntryKey(de
);
10047 val
= dictGetEntryVal(de
);
10048 if (!server
.vm_enabled
|| (key
->storage
== REDIS_VM_MEMORY
||
10049 key
->storage
== REDIS_VM_SWAPPING
)) {
10053 if (val
->encoding
< (sizeof(strencoding
)/sizeof(char*))) {
10054 strenc
= strencoding
[val
->encoding
];
10056 snprintf(buf
,64,"unknown encoding %d\n", val
->encoding
);
10059 addReplySds(c
,sdscatprintf(sdsempty(),
10060 "+Key at:%p refcount:%d, value at:%p refcount:%d "
10061 "encoding:%s serializedlength:%lld\r\n",
10062 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
10063 strenc
, (long long) rdbSavedObjectLen(val
,NULL
)));
10065 addReplySds(c
,sdscatprintf(sdsempty(),
10066 "+Key at:%p refcount:%d, value swapped at: page %llu "
10067 "using %llu pages\r\n",
10068 (void*)key
, key
->refcount
, (unsigned long long) key
->vm
.page
,
10069 (unsigned long long) key
->vm
.usedpages
));
10071 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapin") && c
->argc
== 3) {
10072 lookupKeyRead(c
->db
,c
->argv
[2]);
10073 addReply(c
,shared
.ok
);
10074 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
10075 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
10078 if (!server
.vm_enabled
) {
10079 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
10083 addReply(c
,shared
.nokeyerr
);
10086 key
= dictGetEntryKey(de
);
10087 val
= dictGetEntryVal(de
);
10088 /* If the key is shared we want to create a copy */
10089 if (key
->refcount
> 1) {
10090 robj
*newkey
= dupStringObject(key
);
10092 key
= dictGetEntryKey(de
) = newkey
;
10095 if (key
->storage
!= REDIS_VM_MEMORY
) {
10096 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
10097 } else if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
10098 dictGetEntryVal(de
) = NULL
;
10099 addReply(c
,shared
.ok
);
10101 addReply(c
,shared
.err
);
10104 addReplySds(c
,sdsnew(
10105 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPIN <key>|SWAPOUT <key>|RELOAD]\r\n"));
10109 static void _redisAssert(char *estr
, char *file
, int line
) {
10110 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
10111 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true\n",file
,line
,estr
);
10112 #ifdef HAVE_BACKTRACE
10113 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
10114 *((char*)-1) = 'x';
10118 static void _redisPanic(char *msg
, char *file
, int line
) {
10119 redisLog(REDIS_WARNING
,"!!! Software Failure. Press left mouse button to continue");
10120 redisLog(REDIS_WARNING
,"Guru Meditation: %s #%s:%d",msg
,file
,line
);
10121 #ifdef HAVE_BACKTRACE
10122 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
10123 *((char*)-1) = 'x';
10127 /* =================================== Main! ================================ */
10130 int linuxOvercommitMemoryValue(void) {
10131 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
10134 if (!fp
) return -1;
10135 if (fgets(buf
,64,fp
) == NULL
) {
10144 void linuxOvercommitMemoryWarning(void) {
10145 if (linuxOvercommitMemoryValue() == 0) {
10146 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.");
10149 #endif /* __linux__ */
10151 static void daemonize(void) {
10155 if (fork() != 0) exit(0); /* parent exits */
10156 setsid(); /* create a new session */
10158 /* Every output goes to /dev/null. If Redis is daemonized but
10159 * the 'logfile' is set to 'stdout' in the configuration file
10160 * it will not log at all. */
10161 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
10162 dup2(fd
, STDIN_FILENO
);
10163 dup2(fd
, STDOUT_FILENO
);
10164 dup2(fd
, STDERR_FILENO
);
10165 if (fd
> STDERR_FILENO
) close(fd
);
10167 /* Try to write the pid file */
10168 fp
= fopen(server
.pidfile
,"w");
10170 fprintf(fp
,"%d\n",getpid());
10175 static void version() {
10176 printf("Redis server version %s\n", REDIS_VERSION
);
10180 static void usage() {
10181 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
10182 fprintf(stderr
," ./redis-server - (read config from stdin)\n");
10186 int main(int argc
, char **argv
) {
10189 initServerConfig();
10191 if (strcmp(argv
[1], "-v") == 0 ||
10192 strcmp(argv
[1], "--version") == 0) version();
10193 if (strcmp(argv
[1], "--help") == 0) usage();
10194 resetServerSaveParams();
10195 loadServerConfig(argv
[1]);
10196 } else if ((argc
> 2)) {
10199 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'");
10201 if (server
.daemonize
) daemonize();
10203 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
10205 linuxOvercommitMemoryWarning();
10207 start
= time(NULL
);
10208 if (server
.appendonly
) {
10209 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
10210 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %ld seconds",time(NULL
)-start
);
10212 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
10213 redisLog(REDIS_NOTICE
,"DB loaded from disk: %ld seconds",time(NULL
)-start
);
10215 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
10216 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
10218 aeDeleteEventLoop(server
.el
);
10222 /* ============================= Backtrace support ========================= */
10224 #ifdef HAVE_BACKTRACE
10225 static char *findFuncName(void *pointer
, unsigned long *offset
);
10227 static void *getMcontextEip(ucontext_t
*uc
) {
10228 #if defined(__FreeBSD__)
10229 return (void*) uc
->uc_mcontext
.mc_eip
;
10230 #elif defined(__dietlibc__)
10231 return (void*) uc
->uc_mcontext
.eip
;
10232 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
10234 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
10236 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
10238 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
10239 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
10240 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
10242 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
10244 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
10245 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
10246 #elif defined(__ia64__) /* Linux IA64 */
10247 return (void*) uc
->uc_mcontext
.sc_ip
;
10253 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
10255 char **messages
= NULL
;
10256 int i
, trace_size
= 0;
10257 unsigned long offset
=0;
10258 ucontext_t
*uc
= (ucontext_t
*) secret
;
10260 REDIS_NOTUSED(info
);
10262 redisLog(REDIS_WARNING
,
10263 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
10264 infostring
= genRedisInfoString();
10265 redisLog(REDIS_WARNING
, "%s",infostring
);
10266 /* It's not safe to sdsfree() the returned string under memory
10267 * corruption conditions. Let it leak as we are going to abort */
10269 trace_size
= backtrace(trace
, 100);
10270 /* overwrite sigaction with caller's address */
10271 if (getMcontextEip(uc
) != NULL
) {
10272 trace
[1] = getMcontextEip(uc
);
10274 messages
= backtrace_symbols(trace
, trace_size
);
10276 for (i
=1; i
<trace_size
; ++i
) {
10277 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
10279 p
= strchr(messages
[i
],'+');
10280 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
10281 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
10283 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
10286 /* free(messages); Don't call free() with possibly corrupted memory. */
10290 static void setupSigSegvAction(void) {
10291 struct sigaction act
;
10293 sigemptyset (&act
.sa_mask
);
10294 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
10295 * is used. Otherwise, sa_handler is used */
10296 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
10297 act
.sa_sigaction
= segvHandler
;
10298 sigaction (SIGSEGV
, &act
, NULL
);
10299 sigaction (SIGBUS
, &act
, NULL
);
10300 sigaction (SIGFPE
, &act
, NULL
);
10301 sigaction (SIGILL
, &act
, NULL
);
10302 sigaction (SIGBUS
, &act
, NULL
);
10306 #include "staticsymbols.h"
10307 /* This function try to convert a pointer into a function name. It's used in
10308 * oreder to provide a backtrace under segmentation fault that's able to
10309 * display functions declared as static (otherwise the backtrace is useless). */
10310 static char *findFuncName(void *pointer
, unsigned long *offset
){
10312 unsigned long off
, minoff
= 0;
10314 /* Try to match against the Symbol with the smallest offset */
10315 for (i
=0; symsTable
[i
].pointer
; i
++) {
10316 unsigned long lp
= (unsigned long) pointer
;
10318 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
10319 off
=lp
-symsTable
[i
].pointer
;
10320 if (ret
< 0 || off
< minoff
) {
10326 if (ret
== -1) return NULL
;
10328 return symsTable
[ret
].name
;
10330 #else /* HAVE_BACKTRACE */
10331 static void setupSigSegvAction(void) {
10333 #endif /* HAVE_BACKTRACE */