2 * Copyright (c) 2009-2010, Salvatore Sanfilippo <antirez at gmail dot com>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
8 * * Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * * Neither the name of Redis nor the names of its contributors may be used
14 * to endorse or promote products derived from this software without
15 * specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 * POSSIBILITY OF SUCH DAMAGE.
30 #define REDIS_VERSION "1.3.10"
45 #endif /* HAVE_BACKTRACE */
53 #include <arpa/inet.h>
57 #include <sys/resource.h>
64 #include "solarisfixes.h"
68 #include "ae.h" /* Event driven programming library */
69 #include "sds.h" /* Dynamic safe strings */
70 #include "anet.h" /* Networking the easy way */
71 #include "dict.h" /* Hash tables */
72 #include "adlist.h" /* Linked lists */
73 #include "zmalloc.h" /* total memory usage aware version of malloc/free */
74 #include "lzf.h" /* LZF compression library */
75 #include "pqsort.h" /* Partial qsort for SORT+LIMIT */
82 /* Static server configuration */
83 #define REDIS_SERVERPORT 6379 /* TCP port */
84 #define REDIS_MAXIDLETIME (60*5) /* default client timeout */
85 #define REDIS_IOBUF_LEN 1024
86 #define REDIS_LOADBUF_LEN 1024
87 #define REDIS_STATIC_ARGS 8
88 #define REDIS_DEFAULT_DBNUM 16
89 #define REDIS_CONFIGLINE_MAX 1024
90 #define REDIS_OBJFREELIST_MAX 1000000 /* Max number of objects to cache */
91 #define REDIS_MAX_SYNC_TIME 60 /* Slave can't take more to sync */
92 #define REDIS_EXPIRELOOKUPS_PER_CRON 10 /* lookup 10 expires per loop */
93 #define REDIS_MAX_WRITE_PER_EVENT (1024*64)
94 #define REDIS_REQUEST_MAX_SIZE (1024*1024*256) /* max bytes in inline command */
96 /* If more then REDIS_WRITEV_THRESHOLD write packets are pending use writev */
97 #define REDIS_WRITEV_THRESHOLD 3
98 /* Max number of iovecs used for each writev call */
99 #define REDIS_WRITEV_IOVEC_COUNT 256
101 /* Hash table parameters */
102 #define REDIS_HT_MINFILL 10 /* Minimal hash table fill 10% */
105 #define REDIS_CMD_BULK 1 /* Bulk write command */
106 #define REDIS_CMD_INLINE 2 /* Inline command */
107 /* REDIS_CMD_DENYOOM reserves a longer comment: all the commands marked with
108 this flags will return an error when the 'maxmemory' option is set in the
109 config file and the server is using more than maxmemory bytes of memory.
110 In short this commands are denied on low memory conditions. */
111 #define REDIS_CMD_DENYOOM 4
112 #define REDIS_CMD_FORCE_REPLICATION 8 /* Force replication even if dirty is 0 */
115 #define REDIS_STRING 0
121 /* Objects encoding. Some kind of objects like Strings and Hashes can be
122 * internally represented in multiple ways. The 'encoding' field of the object
123 * is set to one of this fields for this object. */
124 #define REDIS_ENCODING_RAW 0 /* Raw representation */
125 #define REDIS_ENCODING_INT 1 /* Encoded as integer */
126 #define REDIS_ENCODING_ZIPMAP 2 /* Encoded as zipmap */
127 #define REDIS_ENCODING_HT 3 /* Encoded as an hash table */
129 static char* strencoding
[] = {
130 "raw", "int", "zipmap", "hashtable"
133 /* Object types only used for dumping to disk */
134 #define REDIS_EXPIRETIME 253
135 #define REDIS_SELECTDB 254
136 #define REDIS_EOF 255
138 /* Defines related to the dump file format. To store 32 bits lengths for short
139 * keys requires a lot of space, so we check the most significant 2 bits of
140 * the first byte to interpreter the length:
142 * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
143 * 01|000000 00000000 => 01, the len is 14 byes, 6 bits + 8 bits of next byte
144 * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
145 * 11|000000 this means: specially encoded object will follow. The six bits
146 * number specify the kind of object that follows.
147 * See the REDIS_RDB_ENC_* defines.
149 * Lenghts up to 63 are stored using a single byte, most DB keys, and may
150 * values, will fit inside. */
151 #define REDIS_RDB_6BITLEN 0
152 #define REDIS_RDB_14BITLEN 1
153 #define REDIS_RDB_32BITLEN 2
154 #define REDIS_RDB_ENCVAL 3
155 #define REDIS_RDB_LENERR UINT_MAX
157 /* When a length of a string object stored on disk has the first two bits
158 * set, the remaining two bits specify a special encoding for the object
159 * accordingly to the following defines: */
160 #define REDIS_RDB_ENC_INT8 0 /* 8 bit signed integer */
161 #define REDIS_RDB_ENC_INT16 1 /* 16 bit signed integer */
162 #define REDIS_RDB_ENC_INT32 2 /* 32 bit signed integer */
163 #define REDIS_RDB_ENC_LZF 3 /* string compressed with FASTLZ */
165 /* Virtual memory object->where field. */
166 #define REDIS_VM_MEMORY 0 /* The object is on memory */
167 #define REDIS_VM_SWAPPED 1 /* The object is on disk */
168 #define REDIS_VM_SWAPPING 2 /* Redis is swapping this object on disk */
169 #define REDIS_VM_LOADING 3 /* Redis is loading this object from disk */
171 /* Virtual memory static configuration stuff.
172 * Check vmFindContiguousPages() to know more about this magic numbers. */
173 #define REDIS_VM_MAX_NEAR_PAGES 65536
174 #define REDIS_VM_MAX_RANDOM_JUMP 4096
175 #define REDIS_VM_MAX_THREADS 32
176 #define REDIS_THREAD_STACK_SIZE (1024*1024*4)
177 /* The following is the *percentage* of completed I/O jobs to process when the
178 * handelr is called. While Virtual Memory I/O operations are performed by
179 * threads, this operations must be processed by the main thread when completed
180 * in order to take effect. */
181 #define REDIS_MAX_COMPLETED_JOBS_PROCESSED 1
184 #define REDIS_SLAVE 1 /* This client is a slave server */
185 #define REDIS_MASTER 2 /* This client is a master server */
186 #define REDIS_MONITOR 4 /* This client is a slave monitor, see MONITOR */
187 #define REDIS_MULTI 8 /* This client is in a MULTI context */
188 #define REDIS_BLOCKED 16 /* The client is waiting in a blocking operation */
189 #define REDIS_IO_WAIT 32 /* The client is waiting for Virtual Memory I/O */
191 /* Slave replication state - slave side */
192 #define REDIS_REPL_NONE 0 /* No active replication */
193 #define REDIS_REPL_CONNECT 1 /* Must connect to master */
194 #define REDIS_REPL_CONNECTED 2 /* Connected to master */
196 /* Slave replication state - from the point of view of master
197 * Note that in SEND_BULK and ONLINE state the slave receives new updates
198 * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
199 * to start the next background saving in order to send updates to it. */
200 #define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
201 #define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
202 #define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
203 #define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
205 /* List related stuff */
209 /* Sort operations */
210 #define REDIS_SORT_GET 0
211 #define REDIS_SORT_ASC 1
212 #define REDIS_SORT_DESC 2
213 #define REDIS_SORTKEY_MAX 1024
216 #define REDIS_DEBUG 0
217 #define REDIS_VERBOSE 1
218 #define REDIS_NOTICE 2
219 #define REDIS_WARNING 3
221 /* Anti-warning macro... */
222 #define REDIS_NOTUSED(V) ((void) V)
224 #define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
225 #define ZSKIPLIST_P 0.25 /* Skiplist P = 1/4 */
227 /* Append only defines */
228 #define APPENDFSYNC_NO 0
229 #define APPENDFSYNC_ALWAYS 1
230 #define APPENDFSYNC_EVERYSEC 2
232 /* Hashes related defaults */
233 #define REDIS_HASH_MAX_ZIPMAP_ENTRIES 64
234 #define REDIS_HASH_MAX_ZIPMAP_VALUE 512
236 /* We can print the stacktrace, so our assert is defined this way: */
237 #define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
238 #define redisPanic(_e) _redisPanic(#_e,__FILE__,__LINE__),_exit(1)
239 static void _redisAssert(char *estr
, char *file
, int line
);
240 static void _redisPanic(char *msg
, char *file
, int line
);
242 /*================================= Data types ============================== */
244 /* A redis object, that is a type able to hold a string / list / set */
246 /* The VM object structure */
247 struct redisObjectVM
{
248 off_t page
; /* the page at witch the object is stored on disk */
249 off_t usedpages
; /* number of pages used on disk */
250 time_t atime
; /* Last access time */
253 /* The actual Redis Object */
254 typedef struct redisObject
{
257 unsigned char encoding
;
258 unsigned char storage
; /* If this object is a key, where is the value?
259 * REDIS_VM_MEMORY, REDIS_VM_SWAPPED, ... */
260 unsigned char vtype
; /* If this object is a key, and value is swapped out,
261 * this is the type of the swapped out object. */
263 /* VM fields, this are only allocated if VM is active, otherwise the
264 * object allocation function will just allocate
265 * sizeof(redisObjct) minus sizeof(redisObjectVM), so using
266 * Redis without VM active will not have any overhead. */
267 struct redisObjectVM vm
;
270 /* Macro used to initalize a Redis object allocated on the stack.
271 * Note that this macro is taken near the structure definition to make sure
272 * we'll update it when the structure is changed, to avoid bugs like
273 * bug #85 introduced exactly in this way. */
274 #define initStaticStringObject(_var,_ptr) do { \
276 _var.type = REDIS_STRING; \
277 _var.encoding = REDIS_ENCODING_RAW; \
279 if (server.vm_enabled) _var.storage = REDIS_VM_MEMORY; \
282 typedef struct redisDb
{
283 dict
*dict
; /* The keyspace for this DB */
284 dict
*expires
; /* Timeout of keys with a timeout set */
285 dict
*blockingkeys
; /* Keys with clients waiting for data (BLPOP) */
286 dict
*io_keys
; /* Keys with clients waiting for VM I/O */
290 /* Client MULTI/EXEC state */
291 typedef struct multiCmd
{
294 struct redisCommand
*cmd
;
297 typedef struct multiState
{
298 multiCmd
*commands
; /* Array of MULTI commands */
299 int count
; /* Total number of MULTI commands */
302 /* With multiplexing we need to take per-clinet state.
303 * Clients are taken in a liked list. */
304 typedef struct redisClient
{
309 robj
**argv
, **mbargv
;
311 int bulklen
; /* bulk read len. -1 if not in bulk read mode */
312 int multibulk
; /* multi bulk command format active */
315 time_t lastinteraction
; /* time of the last interaction, used for timeout */
316 int flags
; /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
317 int slaveseldb
; /* slave selected db, if this client is a slave */
318 int authenticated
; /* when requirepass is non-NULL */
319 int replstate
; /* replication state if this is a slave */
320 int repldbfd
; /* replication DB file descriptor */
321 long repldboff
; /* replication DB file offset */
322 off_t repldbsize
; /* replication DB file size */
323 multiState mstate
; /* MULTI/EXEC state */
324 robj
**blockingkeys
; /* The key we are waiting to terminate a blocking
325 * operation such as BLPOP. Otherwise NULL. */
326 int blockingkeysnum
; /* Number of blocking keys */
327 time_t blockingto
; /* Blocking operation timeout. If UNIX current time
328 * is >= blockingto then the operation timed out. */
329 list
*io_keys
; /* Keys this client is waiting to be loaded from the
330 * swap file in order to continue. */
331 dict
*pubsub_channels
; /* channels a client is interested in (SUBSCRIBE) */
332 list
*pubsub_patterns
; /* patterns a client is interested in (SUBSCRIBE) */
340 /* Global server state structure */
345 long long dirty
; /* changes to DB from the last save */
347 list
*slaves
, *monitors
;
348 char neterr
[ANET_ERR_LEN
];
350 int cronloops
; /* number of times the cron function run */
351 list
*objfreelist
; /* A list of freed objects to avoid malloc() */
352 time_t lastsave
; /* Unix time of last save succeeede */
353 /* Fields used only for stats */
354 time_t stat_starttime
; /* server start time */
355 long long stat_numcommands
; /* number of processed commands */
356 long long stat_numconnections
; /* number of connections received */
357 long long stat_expiredkeys
; /* number of expired keys */
370 pid_t bgsavechildpid
;
371 pid_t bgrewritechildpid
;
372 sds bgrewritebuf
; /* buffer taken by parent during oppend only rewrite */
373 sds aofbuf
; /* AOF buffer, written before entering the event loop */
374 struct saveparam
*saveparams
;
379 char *appendfilename
;
383 /* Replication related */
388 redisClient
*master
; /* client that is master for this slave */
390 unsigned int maxclients
;
391 unsigned long long maxmemory
;
392 unsigned int blpop_blocked_clients
;
393 unsigned int vm_blocked_clients
;
394 /* Sort parameters - qsort_r() is only available under BSD so we
395 * have to take this state global, in order to pass it to sortCompare() */
399 /* Virtual memory configuration */
404 unsigned long long vm_max_memory
;
406 size_t hash_max_zipmap_entries
;
407 size_t hash_max_zipmap_value
;
408 /* Virtual memory state */
411 off_t vm_next_page
; /* Next probably empty page */
412 off_t vm_near_pages
; /* Number of pages allocated sequentially */
413 unsigned char *vm_bitmap
; /* Bitmap of free/used pages */
414 time_t unixtime
; /* Unix time sampled every second. */
415 /* Virtual memory I/O threads stuff */
416 /* An I/O thread process an element taken from the io_jobs queue and
417 * put the result of the operation in the io_done list. While the
418 * job is being processed, it's put on io_processing queue. */
419 list
*io_newjobs
; /* List of VM I/O jobs yet to be processed */
420 list
*io_processing
; /* List of VM I/O jobs being processed */
421 list
*io_processed
; /* List of VM I/O jobs already processed */
422 list
*io_ready_clients
; /* Clients ready to be unblocked. All keys loaded */
423 pthread_mutex_t io_mutex
; /* lock to access io_jobs/io_done/io_thread_job */
424 pthread_mutex_t obj_freelist_mutex
; /* safe redis objects creation/free */
425 pthread_mutex_t io_swapfile_mutex
; /* So we can lseek + write */
426 pthread_attr_t io_threads_attr
; /* attributes for threads creation */
427 int io_active_threads
; /* Number of running I/O threads */
428 int vm_max_threads
; /* Max number of I/O threads running at the same time */
429 /* Our main thread is blocked on the event loop, locking for sockets ready
430 * to be read or written, so when a threaded I/O operation is ready to be
431 * processed by the main thread, the I/O thread will use a unix pipe to
432 * awake the main thread. The followings are the two pipe FDs. */
433 int io_ready_pipe_read
;
434 int io_ready_pipe_write
;
435 /* Virtual memory stats */
436 unsigned long long vm_stats_used_pages
;
437 unsigned long long vm_stats_swapped_objects
;
438 unsigned long long vm_stats_swapouts
;
439 unsigned long long vm_stats_swapins
;
441 dict
*pubsub_channels
; /* Map channels to list of subscribed clients */
442 list
*pubsub_patterns
; /* A list of pubsub_patterns */
447 typedef struct pubsubPattern
{
452 typedef void redisCommandProc(redisClient
*c
);
453 struct redisCommand
{
455 redisCommandProc
*proc
;
458 /* Use a function to determine which keys need to be loaded
459 * in the background prior to executing this command. Takes precedence
460 * over vm_firstkey and others, ignored when NULL */
461 redisCommandProc
*vm_preload_proc
;
462 /* What keys should be loaded in background when calling this command? */
463 int vm_firstkey
; /* The first argument that's a key (0 = no keys) */
464 int vm_lastkey
; /* THe last argument that's a key */
465 int vm_keystep
; /* The step between first and last key */
468 struct redisFunctionSym
{
470 unsigned long pointer
;
473 typedef struct _redisSortObject
{
481 typedef struct _redisSortOperation
{
484 } redisSortOperation
;
486 /* ZSETs use a specialized version of Skiplists */
488 typedef struct zskiplistNode
{
489 struct zskiplistNode
**forward
;
490 struct zskiplistNode
*backward
;
496 typedef struct zskiplist
{
497 struct zskiplistNode
*header
, *tail
;
498 unsigned long length
;
502 typedef struct zset
{
507 /* Our shared "common" objects */
509 #define REDIS_SHARED_INTEGERS 10000
510 struct sharedObjectsStruct
{
511 robj
*crlf
, *ok
, *err
, *emptybulk
, *czero
, *cone
, *pong
, *space
,
512 *colon
, *nullbulk
, *nullmultibulk
, *queued
,
513 *emptymultibulk
, *wrongtypeerr
, *nokeyerr
, *syntaxerr
, *sameobjecterr
,
514 *outofrangeerr
, *plus
,
515 *select0
, *select1
, *select2
, *select3
, *select4
,
516 *select5
, *select6
, *select7
, *select8
, *select9
,
517 *messagebulk
, *pmessagebulk
, *subscribebulk
, *unsubscribebulk
, *mbulk3
,
518 *mbulk4
, *psubscribebulk
, *punsubscribebulk
,
519 *integers
[REDIS_SHARED_INTEGERS
];
522 /* Global vars that are actally used as constants. The following double
523 * values are used for double on-disk serialization, and are initialized
524 * at runtime to avoid strange compiler optimizations. */
526 static double R_Zero
, R_PosInf
, R_NegInf
, R_Nan
;
528 /* VM threaded I/O request message */
529 #define REDIS_IOJOB_LOAD 0 /* Load from disk to memory */
530 #define REDIS_IOJOB_PREPARE_SWAP 1 /* Compute needed pages */
531 #define REDIS_IOJOB_DO_SWAP 2 /* Swap from memory to disk */
532 typedef struct iojob
{
533 int type
; /* Request type, REDIS_IOJOB_* */
534 redisDb
*db
;/* Redis database */
535 robj
*key
; /* This I/O request is about swapping this key */
536 robj
*val
; /* the value to swap for REDIS_IOREQ_*_SWAP, otherwise this
537 * field is populated by the I/O thread for REDIS_IOREQ_LOAD. */
538 off_t page
; /* Swap page where to read/write the object */
539 off_t pages
; /* Swap pages needed to save object. PREPARE_SWAP return val */
540 int canceled
; /* True if this command was canceled by blocking side of VM */
541 pthread_t thread
; /* ID of the thread processing this entry */
544 /*================================ Prototypes =============================== */
546 static void freeStringObject(robj
*o
);
547 static void freeListObject(robj
*o
);
548 static void freeSetObject(robj
*o
);
549 static void decrRefCount(void *o
);
550 static robj
*createObject(int type
, void *ptr
);
551 static void freeClient(redisClient
*c
);
552 static int rdbLoad(char *filename
);
553 static void addReply(redisClient
*c
, robj
*obj
);
554 static void addReplySds(redisClient
*c
, sds s
);
555 static void incrRefCount(robj
*o
);
556 static int rdbSaveBackground(char *filename
);
557 static robj
*createStringObject(char *ptr
, size_t len
);
558 static robj
*dupStringObject(robj
*o
);
559 static void replicationFeedSlaves(list
*slaves
, int dictid
, robj
**argv
, int argc
);
560 static void replicationFeedMonitors(list
*monitors
, int dictid
, robj
**argv
, int argc
);
561 static void flushAppendOnlyFile(void);
562 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
563 static int syncWithMaster(void);
564 static robj
*tryObjectEncoding(robj
*o
);
565 static robj
*getDecodedObject(robj
*o
);
566 static int removeExpire(redisDb
*db
, robj
*key
);
567 static int expireIfNeeded(redisDb
*db
, robj
*key
);
568 static int deleteIfVolatile(redisDb
*db
, robj
*key
);
569 static int deleteIfSwapped(redisDb
*db
, robj
*key
);
570 static int deleteKey(redisDb
*db
, robj
*key
);
571 static time_t getExpire(redisDb
*db
, robj
*key
);
572 static int setExpire(redisDb
*db
, robj
*key
, time_t when
);
573 static void updateSlavesWaitingBgsave(int bgsaveerr
);
574 static void freeMemoryIfNeeded(void);
575 static int processCommand(redisClient
*c
);
576 static void setupSigSegvAction(void);
577 static void rdbRemoveTempFile(pid_t childpid
);
578 static void aofRemoveTempFile(pid_t childpid
);
579 static size_t stringObjectLen(robj
*o
);
580 static void processInputBuffer(redisClient
*c
);
581 static zskiplist
*zslCreate(void);
582 static void zslFree(zskiplist
*zsl
);
583 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
);
584 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
585 static void initClientMultiState(redisClient
*c
);
586 static void freeClientMultiState(redisClient
*c
);
587 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
);
588 static void unblockClientWaitingData(redisClient
*c
);
589 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
);
590 static void vmInit(void);
591 static void vmMarkPagesFree(off_t page
, off_t count
);
592 static robj
*vmLoadObject(robj
*key
);
593 static robj
*vmPreviewObject(robj
*key
);
594 static int vmSwapOneObjectBlocking(void);
595 static int vmSwapOneObjectThreaded(void);
596 static int vmCanSwapOut(void);
597 static int tryFreeOneObjectFromFreelist(void);
598 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
599 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
600 static void vmCancelThreadedIOJob(robj
*o
);
601 static void lockThreadedIO(void);
602 static void unlockThreadedIO(void);
603 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
);
604 static void freeIOJob(iojob
*j
);
605 static void queueIOJob(iojob
*j
);
606 static int vmWriteObjectOnSwap(robj
*o
, off_t page
);
607 static robj
*vmReadObjectFromSwap(off_t page
, int type
);
608 static void waitEmptyIOJobsQueue(void);
609 static void vmReopenSwapFile(void);
610 static int vmFreePage(off_t page
);
611 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
);
612 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
);
613 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
);
614 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
);
615 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
616 static struct redisCommand
*lookupCommand(char *name
);
617 static void call(redisClient
*c
, struct redisCommand
*cmd
);
618 static void resetClient(redisClient
*c
);
619 static void convertToRealHash(robj
*o
);
620 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
);
621 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
);
622 static void freePubsubPattern(void *p
);
623 static int listMatchPubsubPattern(void *a
, void *b
);
624 static int compareStringObjects(robj
*a
, robj
*b
);
626 static int rewriteAppendOnlyFileBackground(void);
627 static int vmSwapObjectBlocking(robj
*key
, robj
*val
);
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],"appendfsync") && argc
== 2) {
1891 if (!strcasecmp(argv
[1],"no")) {
1892 server
.appendfsync
= APPENDFSYNC_NO
;
1893 } else if (!strcasecmp(argv
[1],"always")) {
1894 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1895 } else if (!strcasecmp(argv
[1],"everysec")) {
1896 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1898 err
= "argument must be 'no', 'always' or 'everysec'";
1901 } else if (!strcasecmp(argv
[0],"requirepass") && argc
== 2) {
1902 server
.requirepass
= zstrdup(argv
[1]);
1903 } else if (!strcasecmp(argv
[0],"pidfile") && argc
== 2) {
1904 zfree(server
.pidfile
);
1905 server
.pidfile
= zstrdup(argv
[1]);
1906 } else if (!strcasecmp(argv
[0],"dbfilename") && argc
== 2) {
1907 zfree(server
.dbfilename
);
1908 server
.dbfilename
= zstrdup(argv
[1]);
1909 } else if (!strcasecmp(argv
[0],"vm-enabled") && argc
== 2) {
1910 if ((server
.vm_enabled
= yesnotoi(argv
[1])) == -1) {
1911 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1913 } else if (!strcasecmp(argv
[0],"vm-swap-file") && argc
== 2) {
1914 zfree(server
.vm_swap_file
);
1915 server
.vm_swap_file
= zstrdup(argv
[1]);
1916 } else if (!strcasecmp(argv
[0],"vm-max-memory") && argc
== 2) {
1917 server
.vm_max_memory
= memtoll(argv
[1],NULL
);
1918 } else if (!strcasecmp(argv
[0],"vm-page-size") && argc
== 2) {
1919 server
.vm_page_size
= memtoll(argv
[1], NULL
);
1920 } else if (!strcasecmp(argv
[0],"vm-pages") && argc
== 2) {
1921 server
.vm_pages
= memtoll(argv
[1], NULL
);
1922 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1923 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1924 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-entries") && argc
== 2){
1925 server
.hash_max_zipmap_entries
= memtoll(argv
[1], NULL
);
1926 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-value") && argc
== 2){
1927 server
.hash_max_zipmap_value
= memtoll(argv
[1], NULL
);
1929 err
= "Bad directive or wrong number of arguments"; goto loaderr
;
1931 for (j
= 0; j
< argc
; j
++)
1936 if (fp
!= stdin
) fclose(fp
);
1940 fprintf(stderr
, "\n*** FATAL CONFIG FILE ERROR ***\n");
1941 fprintf(stderr
, "Reading the configuration file, at line %d\n", linenum
);
1942 fprintf(stderr
, ">>> '%s'\n", line
);
1943 fprintf(stderr
, "%s\n", err
);
1947 static void freeClientArgv(redisClient
*c
) {
1950 for (j
= 0; j
< c
->argc
; j
++)
1951 decrRefCount(c
->argv
[j
]);
1952 for (j
= 0; j
< c
->mbargc
; j
++)
1953 decrRefCount(c
->mbargv
[j
]);
1958 static void freeClient(redisClient
*c
) {
1961 /* Note that if the client we are freeing is blocked into a blocking
1962 * call, we have to set querybuf to NULL *before* to call
1963 * unblockClientWaitingData() to avoid processInputBuffer() will get
1964 * called. Also it is important to remove the file events after
1965 * this, because this call adds the READABLE event. */
1966 sdsfree(c
->querybuf
);
1968 if (c
->flags
& REDIS_BLOCKED
)
1969 unblockClientWaitingData(c
);
1971 /* Unsubscribe from all the pubsub channels */
1972 pubsubUnsubscribeAllChannels(c
,0);
1973 pubsubUnsubscribeAllPatterns(c
,0);
1974 dictRelease(c
->pubsub_channels
);
1975 listRelease(c
->pubsub_patterns
);
1976 /* Obvious cleanup */
1977 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
1978 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1979 listRelease(c
->reply
);
1982 /* Remove from the list of clients */
1983 ln
= listSearchKey(server
.clients
,c
);
1984 redisAssert(ln
!= NULL
);
1985 listDelNode(server
.clients
,ln
);
1986 /* Remove from the list of clients waiting for swapped keys */
1987 if (c
->flags
& REDIS_IO_WAIT
&& listLength(c
->io_keys
) == 0) {
1988 ln
= listSearchKey(server
.io_ready_clients
,c
);
1990 listDelNode(server
.io_ready_clients
,ln
);
1991 server
.vm_blocked_clients
--;
1994 while (server
.vm_enabled
&& listLength(c
->io_keys
)) {
1995 ln
= listFirst(c
->io_keys
);
1996 dontWaitForSwappedKey(c
,ln
->value
);
1998 listRelease(c
->io_keys
);
1999 /* Master/slave cleanup */
2000 if (c
->flags
& REDIS_SLAVE
) {
2001 if (c
->replstate
== REDIS_REPL_SEND_BULK
&& c
->repldbfd
!= -1)
2003 list
*l
= (c
->flags
& REDIS_MONITOR
) ? server
.monitors
: server
.slaves
;
2004 ln
= listSearchKey(l
,c
);
2005 redisAssert(ln
!= NULL
);
2008 if (c
->flags
& REDIS_MASTER
) {
2009 server
.master
= NULL
;
2010 server
.replstate
= REDIS_REPL_CONNECT
;
2012 /* Release memory */
2015 freeClientMultiState(c
);
2019 #define GLUEREPLY_UP_TO (1024)
2020 static void glueReplyBuffersIfNeeded(redisClient
*c
) {
2022 char buf
[GLUEREPLY_UP_TO
];
2027 listRewind(c
->reply
,&li
);
2028 while((ln
= listNext(&li
))) {
2032 objlen
= sdslen(o
->ptr
);
2033 if (copylen
+ objlen
<= GLUEREPLY_UP_TO
) {
2034 memcpy(buf
+copylen
,o
->ptr
,objlen
);
2036 listDelNode(c
->reply
,ln
);
2038 if (copylen
== 0) return;
2042 /* Now the output buffer is empty, add the new single element */
2043 o
= createObject(REDIS_STRING
,sdsnewlen(buf
,copylen
));
2044 listAddNodeHead(c
->reply
,o
);
2047 static void sendReplyToClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2048 redisClient
*c
= privdata
;
2049 int nwritten
= 0, totwritten
= 0, objlen
;
2052 REDIS_NOTUSED(mask
);
2054 /* Use writev() if we have enough buffers to send */
2055 if (!server
.glueoutputbuf
&&
2056 listLength(c
->reply
) > REDIS_WRITEV_THRESHOLD
&&
2057 !(c
->flags
& REDIS_MASTER
))
2059 sendReplyToClientWritev(el
, fd
, privdata
, mask
);
2063 while(listLength(c
->reply
)) {
2064 if (server
.glueoutputbuf
&& listLength(c
->reply
) > 1)
2065 glueReplyBuffersIfNeeded(c
);
2067 o
= listNodeValue(listFirst(c
->reply
));
2068 objlen
= sdslen(o
->ptr
);
2071 listDelNode(c
->reply
,listFirst(c
->reply
));
2075 if (c
->flags
& REDIS_MASTER
) {
2076 /* Don't reply to a master */
2077 nwritten
= objlen
- c
->sentlen
;
2079 nwritten
= write(fd
, ((char*)o
->ptr
)+c
->sentlen
, objlen
- c
->sentlen
);
2080 if (nwritten
<= 0) break;
2082 c
->sentlen
+= nwritten
;
2083 totwritten
+= nwritten
;
2084 /* If we fully sent the object on head go to the next one */
2085 if (c
->sentlen
== objlen
) {
2086 listDelNode(c
->reply
,listFirst(c
->reply
));
2089 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
2090 * bytes, in a single threaded server it's a good idea to serve
2091 * other clients as well, even if a very large request comes from
2092 * super fast link that is always able to accept data (in real world
2093 * scenario think about 'KEYS *' against the loopback interfae) */
2094 if (totwritten
> REDIS_MAX_WRITE_PER_EVENT
) break;
2096 if (nwritten
== -1) {
2097 if (errno
== EAGAIN
) {
2100 redisLog(REDIS_VERBOSE
,
2101 "Error writing to client: %s", strerror(errno
));
2106 if (totwritten
> 0) c
->lastinteraction
= time(NULL
);
2107 if (listLength(c
->reply
) == 0) {
2109 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2113 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
)
2115 redisClient
*c
= privdata
;
2116 int nwritten
= 0, totwritten
= 0, objlen
, willwrite
;
2118 struct iovec iov
[REDIS_WRITEV_IOVEC_COUNT
];
2119 int offset
, ion
= 0;
2121 REDIS_NOTUSED(mask
);
2124 while (listLength(c
->reply
)) {
2125 offset
= c
->sentlen
;
2129 /* fill-in the iov[] array */
2130 for(node
= listFirst(c
->reply
); node
; node
= listNextNode(node
)) {
2131 o
= listNodeValue(node
);
2132 objlen
= sdslen(o
->ptr
);
2134 if (totwritten
+ objlen
- offset
> REDIS_MAX_WRITE_PER_EVENT
)
2137 if(ion
== REDIS_WRITEV_IOVEC_COUNT
)
2138 break; /* no more iovecs */
2140 iov
[ion
].iov_base
= ((char*)o
->ptr
) + offset
;
2141 iov
[ion
].iov_len
= objlen
- offset
;
2142 willwrite
+= objlen
- offset
;
2143 offset
= 0; /* just for the first item */
2150 /* write all collected blocks at once */
2151 if((nwritten
= writev(fd
, iov
, ion
)) < 0) {
2152 if (errno
!= EAGAIN
) {
2153 redisLog(REDIS_VERBOSE
,
2154 "Error writing to client: %s", strerror(errno
));
2161 totwritten
+= nwritten
;
2162 offset
= c
->sentlen
;
2164 /* remove written robjs from c->reply */
2165 while (nwritten
&& listLength(c
->reply
)) {
2166 o
= listNodeValue(listFirst(c
->reply
));
2167 objlen
= sdslen(o
->ptr
);
2169 if(nwritten
>= objlen
- offset
) {
2170 listDelNode(c
->reply
, listFirst(c
->reply
));
2171 nwritten
-= objlen
- offset
;
2175 c
->sentlen
+= nwritten
;
2183 c
->lastinteraction
= time(NULL
);
2185 if (listLength(c
->reply
) == 0) {
2187 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2191 static struct redisCommand
*lookupCommand(char *name
) {
2193 while(cmdTable
[j
].name
!= NULL
) {
2194 if (!strcasecmp(name
,cmdTable
[j
].name
)) return &cmdTable
[j
];
2200 /* resetClient prepare the client to process the next command */
2201 static void resetClient(redisClient
*c
) {
2207 /* Call() is the core of Redis execution of a command */
2208 static void call(redisClient
*c
, struct redisCommand
*cmd
) {
2211 dirty
= server
.dirty
;
2213 dirty
= server
.dirty
-dirty
;
2215 if (server
.appendonly
&& dirty
)
2216 feedAppendOnlyFile(cmd
,c
->db
->id
,c
->argv
,c
->argc
);
2217 if ((dirty
|| cmd
->flags
& REDIS_CMD_FORCE_REPLICATION
) &&
2218 listLength(server
.slaves
))
2219 replicationFeedSlaves(server
.slaves
,c
->db
->id
,c
->argv
,c
->argc
);
2220 if (listLength(server
.monitors
))
2221 replicationFeedMonitors(server
.monitors
,c
->db
->id
,c
->argv
,c
->argc
);
2222 server
.stat_numcommands
++;
2225 /* If this function gets called we already read a whole
2226 * command, argments are in the client argv/argc fields.
2227 * processCommand() execute the command or prepare the
2228 * server for a bulk read from the client.
2230 * If 1 is returned the client is still alive and valid and
2231 * and other operations can be performed by the caller. Otherwise
2232 * if 0 is returned the client was destroied (i.e. after QUIT). */
2233 static int processCommand(redisClient
*c
) {
2234 struct redisCommand
*cmd
;
2236 /* Free some memory if needed (maxmemory setting) */
2237 if (server
.maxmemory
) freeMemoryIfNeeded();
2239 /* Handle the multi bulk command type. This is an alternative protocol
2240 * supported by Redis in order to receive commands that are composed of
2241 * multiple binary-safe "bulk" arguments. The latency of processing is
2242 * a bit higher but this allows things like multi-sets, so if this
2243 * protocol is used only for MSET and similar commands this is a big win. */
2244 if (c
->multibulk
== 0 && c
->argc
== 1 && ((char*)(c
->argv
[0]->ptr
))[0] == '*') {
2245 c
->multibulk
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2246 if (c
->multibulk
<= 0) {
2250 decrRefCount(c
->argv
[c
->argc
-1]);
2254 } else if (c
->multibulk
) {
2255 if (c
->bulklen
== -1) {
2256 if (((char*)c
->argv
[0]->ptr
)[0] != '$') {
2257 addReplySds(c
,sdsnew("-ERR multi bulk protocol error\r\n"));
2261 int bulklen
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2262 decrRefCount(c
->argv
[0]);
2263 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2265 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2270 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2274 c
->mbargv
= zrealloc(c
->mbargv
,(sizeof(robj
*))*(c
->mbargc
+1));
2275 c
->mbargv
[c
->mbargc
] = c
->argv
[0];
2279 if (c
->multibulk
== 0) {
2283 /* Here we need to swap the multi-bulk argc/argv with the
2284 * normal argc/argv of the client structure. */
2286 c
->argv
= c
->mbargv
;
2287 c
->mbargv
= auxargv
;
2290 c
->argc
= c
->mbargc
;
2291 c
->mbargc
= auxargc
;
2293 /* We need to set bulklen to something different than -1
2294 * in order for the code below to process the command without
2295 * to try to read the last argument of a bulk command as
2296 * a special argument. */
2298 /* continue below and process the command */
2305 /* -- end of multi bulk commands processing -- */
2307 /* The QUIT command is handled as a special case. Normal command
2308 * procs are unable to close the client connection safely */
2309 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
2314 /* Now lookup the command and check ASAP about trivial error conditions
2315 * such wrong arity, bad command name and so forth. */
2316 cmd
= lookupCommand(c
->argv
[0]->ptr
);
2319 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2320 (char*)c
->argv
[0]->ptr
));
2323 } else if ((cmd
->arity
> 0 && cmd
->arity
!= c
->argc
) ||
2324 (c
->argc
< -cmd
->arity
)) {
2326 sdscatprintf(sdsempty(),
2327 "-ERR wrong number of arguments for '%s' command\r\n",
2331 } else if (cmd
->flags
& REDIS_CMD_BULK
&& c
->bulklen
== -1) {
2332 /* This is a bulk command, we have to read the last argument yet. */
2333 int bulklen
= atoi(c
->argv
[c
->argc
-1]->ptr
);
2335 decrRefCount(c
->argv
[c
->argc
-1]);
2336 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2338 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2343 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2344 /* It is possible that the bulk read is already in the
2345 * buffer. Check this condition and handle it accordingly.
2346 * This is just a fast path, alternative to call processInputBuffer().
2347 * It's a good idea since the code is small and this condition
2348 * happens most of the times. */
2349 if ((signed)sdslen(c
->querybuf
) >= c
->bulklen
) {
2350 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2352 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2354 /* Otherwise return... there is to read the last argument
2355 * from the socket. */
2359 /* Let's try to encode the bulk object to save space. */
2360 if (cmd
->flags
& REDIS_CMD_BULK
)
2361 c
->argv
[c
->argc
-1] = tryObjectEncoding(c
->argv
[c
->argc
-1]);
2363 /* Check if the user is authenticated */
2364 if (server
.requirepass
&& !c
->authenticated
&& cmd
->proc
!= authCommand
) {
2365 addReplySds(c
,sdsnew("-ERR operation not permitted\r\n"));
2370 /* Handle the maxmemory directive */
2371 if (server
.maxmemory
&& (cmd
->flags
& REDIS_CMD_DENYOOM
) &&
2372 zmalloc_used_memory() > server
.maxmemory
)
2374 addReplySds(c
,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2379 /* Only allow SUBSCRIBE and UNSUBSCRIBE in the context of Pub/Sub */
2380 if ((dictSize(c
->pubsub_channels
) > 0 || listLength(c
->pubsub_patterns
) > 0)
2382 cmd
->proc
!= subscribeCommand
&& cmd
->proc
!= unsubscribeCommand
&&
2383 cmd
->proc
!= psubscribeCommand
&& cmd
->proc
!= punsubscribeCommand
) {
2384 addReplySds(c
,sdsnew("-ERR only (P)SUBSCRIBE / (P)UNSUBSCRIBE / QUIT allowed in this context\r\n"));
2389 /* Exec the command */
2390 if (c
->flags
& REDIS_MULTI
&& cmd
->proc
!= execCommand
&& cmd
->proc
!= discardCommand
) {
2391 queueMultiCommand(c
,cmd
);
2392 addReply(c
,shared
.queued
);
2394 if (server
.vm_enabled
&& server
.vm_max_threads
> 0 &&
2395 blockClientOnSwappedKeys(cmd
,c
)) return 1;
2399 /* Prepare the client for the next command */
2404 static void replicationFeedSlaves(list
*slaves
, int dictid
, robj
**argv
, int argc
) {
2409 /* We need 1+(ARGS*3) objects since commands are using the new protocol
2410 * and we one 1 object for the first "*<count>\r\n" multibulk count, then
2411 * for every additional object we have "$<count>\r\n" + object + "\r\n". */
2412 robj
*static_outv
[REDIS_STATIC_ARGS
*3+1];
2415 if (argc
<= REDIS_STATIC_ARGS
) {
2418 outv
= zmalloc(sizeof(robj
*)*(argc
*3+1));
2421 lenobj
= createObject(REDIS_STRING
,
2422 sdscatprintf(sdsempty(), "*%d\r\n", argc
));
2423 lenobj
->refcount
= 0;
2424 outv
[outc
++] = lenobj
;
2425 for (j
= 0; j
< argc
; j
++) {
2426 lenobj
= createObject(REDIS_STRING
,
2427 sdscatprintf(sdsempty(),"$%lu\r\n",
2428 (unsigned long) stringObjectLen(argv
[j
])));
2429 lenobj
->refcount
= 0;
2430 outv
[outc
++] = lenobj
;
2431 outv
[outc
++] = argv
[j
];
2432 outv
[outc
++] = shared
.crlf
;
2435 /* Increment all the refcounts at start and decrement at end in order to
2436 * be sure to free objects if there is no slave in a replication state
2437 * able to be feed with commands */
2438 for (j
= 0; j
< outc
; j
++) incrRefCount(outv
[j
]);
2439 listRewind(slaves
,&li
);
2440 while((ln
= listNext(&li
))) {
2441 redisClient
*slave
= ln
->value
;
2443 /* Don't feed slaves that are still waiting for BGSAVE to start */
2444 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) continue;
2446 /* Feed all the other slaves, MONITORs and so on */
2447 if (slave
->slaveseldb
!= dictid
) {
2451 case 0: selectcmd
= shared
.select0
; break;
2452 case 1: selectcmd
= shared
.select1
; break;
2453 case 2: selectcmd
= shared
.select2
; break;
2454 case 3: selectcmd
= shared
.select3
; break;
2455 case 4: selectcmd
= shared
.select4
; break;
2456 case 5: selectcmd
= shared
.select5
; break;
2457 case 6: selectcmd
= shared
.select6
; break;
2458 case 7: selectcmd
= shared
.select7
; break;
2459 case 8: selectcmd
= shared
.select8
; break;
2460 case 9: selectcmd
= shared
.select9
; break;
2462 selectcmd
= createObject(REDIS_STRING
,
2463 sdscatprintf(sdsempty(),"select %d\r\n",dictid
));
2464 selectcmd
->refcount
= 0;
2467 addReply(slave
,selectcmd
);
2468 slave
->slaveseldb
= dictid
;
2470 for (j
= 0; j
< outc
; j
++) addReply(slave
,outv
[j
]);
2472 for (j
= 0; j
< outc
; j
++) decrRefCount(outv
[j
]);
2473 if (outv
!= static_outv
) zfree(outv
);
2476 static sds
sdscatrepr(sds s
, char *p
, size_t len
) {
2477 s
= sdscatlen(s
,"\"",1);
2482 s
= sdscatprintf(s
,"\\%c",*p
);
2484 case '\n': s
= sdscatlen(s
,"\\n",1); break;
2485 case '\r': s
= sdscatlen(s
,"\\r",1); break;
2486 case '\t': s
= sdscatlen(s
,"\\t",1); break;
2487 case '\a': s
= sdscatlen(s
,"\\a",1); break;
2488 case '\b': s
= sdscatlen(s
,"\\b",1); break;
2491 s
= sdscatprintf(s
,"%c",*p
);
2493 s
= sdscatprintf(s
,"\\x%02x",(unsigned char)*p
);
2498 return sdscatlen(s
,"\"",1);
2501 static void replicationFeedMonitors(list
*monitors
, int dictid
, robj
**argv
, int argc
) {
2505 sds cmdrepr
= sdsnew("+");
2509 gettimeofday(&tv
,NULL
);
2510 cmdrepr
= sdscatprintf(cmdrepr
,"%ld.%ld ",(long)tv
.tv_sec
,(long)tv
.tv_usec
);
2511 if (dictid
!= 0) cmdrepr
= sdscatprintf(cmdrepr
,"(db %d) ", dictid
);
2513 for (j
= 0; j
< argc
; j
++) {
2514 if (argv
[j
]->encoding
== REDIS_ENCODING_INT
) {
2515 cmdrepr
= sdscatprintf(cmdrepr
, "%ld", (long)argv
[j
]->ptr
);
2517 cmdrepr
= sdscatrepr(cmdrepr
,(char*)argv
[j
]->ptr
,
2518 sdslen(argv
[j
]->ptr
));
2521 cmdrepr
= sdscatlen(cmdrepr
," ",1);
2523 cmdrepr
= sdscatlen(cmdrepr
,"\r\n",2);
2524 cmdobj
= createObject(REDIS_STRING
,cmdrepr
);
2526 listRewind(monitors
,&li
);
2527 while((ln
= listNext(&li
))) {
2528 redisClient
*monitor
= ln
->value
;
2529 addReply(monitor
,cmdobj
);
2531 decrRefCount(cmdobj
);
2534 static void processInputBuffer(redisClient
*c
) {
2536 /* Before to process the input buffer, make sure the client is not
2537 * waitig for a blocking operation such as BLPOP. Note that the first
2538 * iteration the client is never blocked, otherwise the processInputBuffer
2539 * would not be called at all, but after the execution of the first commands
2540 * in the input buffer the client may be blocked, and the "goto again"
2541 * will try to reiterate. The following line will make it return asap. */
2542 if (c
->flags
& REDIS_BLOCKED
|| c
->flags
& REDIS_IO_WAIT
) return;
2543 if (c
->bulklen
== -1) {
2544 /* Read the first line of the query */
2545 char *p
= strchr(c
->querybuf
,'\n');
2552 query
= c
->querybuf
;
2553 c
->querybuf
= sdsempty();
2554 querylen
= 1+(p
-(query
));
2555 if (sdslen(query
) > querylen
) {
2556 /* leave data after the first line of the query in the buffer */
2557 c
->querybuf
= sdscatlen(c
->querybuf
,query
+querylen
,sdslen(query
)-querylen
);
2559 *p
= '\0'; /* remove "\n" */
2560 if (*(p
-1) == '\r') *(p
-1) = '\0'; /* and "\r" if any */
2561 sdsupdatelen(query
);
2563 /* Now we can split the query in arguments */
2564 argv
= sdssplitlen(query
,sdslen(query
)," ",1,&argc
);
2567 if (c
->argv
) zfree(c
->argv
);
2568 c
->argv
= zmalloc(sizeof(robj
*)*argc
);
2570 for (j
= 0; j
< argc
; j
++) {
2571 if (sdslen(argv
[j
])) {
2572 c
->argv
[c
->argc
] = createObject(REDIS_STRING
,argv
[j
]);
2580 /* Execute the command. If the client is still valid
2581 * after processCommand() return and there is something
2582 * on the query buffer try to process the next command. */
2583 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2585 /* Nothing to process, argc == 0. Just process the query
2586 * buffer if it's not empty or return to the caller */
2587 if (sdslen(c
->querybuf
)) goto again
;
2590 } else if (sdslen(c
->querybuf
) >= REDIS_REQUEST_MAX_SIZE
) {
2591 redisLog(REDIS_VERBOSE
, "Client protocol error");
2596 /* Bulk read handling. Note that if we are at this point
2597 the client already sent a command terminated with a newline,
2598 we are reading the bulk data that is actually the last
2599 argument of the command. */
2600 int qbl
= sdslen(c
->querybuf
);
2602 if (c
->bulklen
<= qbl
) {
2603 /* Copy everything but the final CRLF as final argument */
2604 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2606 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2607 /* Process the command. If the client is still valid after
2608 * the processing and there is more data in the buffer
2609 * try to parse it. */
2610 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2616 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2617 redisClient
*c
= (redisClient
*) privdata
;
2618 char buf
[REDIS_IOBUF_LEN
];
2621 REDIS_NOTUSED(mask
);
2623 nread
= read(fd
, buf
, REDIS_IOBUF_LEN
);
2625 if (errno
== EAGAIN
) {
2628 redisLog(REDIS_VERBOSE
, "Reading from client: %s",strerror(errno
));
2632 } else if (nread
== 0) {
2633 redisLog(REDIS_VERBOSE
, "Client closed connection");
2638 c
->querybuf
= sdscatlen(c
->querybuf
, buf
, nread
);
2639 c
->lastinteraction
= time(NULL
);
2643 processInputBuffer(c
);
2646 static int selectDb(redisClient
*c
, int id
) {
2647 if (id
< 0 || id
>= server
.dbnum
)
2649 c
->db
= &server
.db
[id
];
2653 static void *dupClientReplyValue(void *o
) {
2654 incrRefCount((robj
*)o
);
2658 static int listMatchObjects(void *a
, void *b
) {
2659 return compareStringObjects(a
,b
) == 0;
2662 static redisClient
*createClient(int fd
) {
2663 redisClient
*c
= zmalloc(sizeof(*c
));
2665 anetNonBlock(NULL
,fd
);
2666 anetTcpNoDelay(NULL
,fd
);
2667 if (!c
) return NULL
;
2670 c
->querybuf
= sdsempty();
2679 c
->lastinteraction
= time(NULL
);
2680 c
->authenticated
= 0;
2681 c
->replstate
= REDIS_REPL_NONE
;
2682 c
->reply
= listCreate();
2683 listSetFreeMethod(c
->reply
,decrRefCount
);
2684 listSetDupMethod(c
->reply
,dupClientReplyValue
);
2685 c
->blockingkeys
= NULL
;
2686 c
->blockingkeysnum
= 0;
2687 c
->io_keys
= listCreate();
2688 listSetFreeMethod(c
->io_keys
,decrRefCount
);
2689 c
->pubsub_channels
= dictCreate(&setDictType
,NULL
);
2690 c
->pubsub_patterns
= listCreate();
2691 listSetFreeMethod(c
->pubsub_patterns
,decrRefCount
);
2692 listSetMatchMethod(c
->pubsub_patterns
,listMatchObjects
);
2693 if (aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
2694 readQueryFromClient
, c
) == AE_ERR
) {
2698 listAddNodeTail(server
.clients
,c
);
2699 initClientMultiState(c
);
2703 static void addReply(redisClient
*c
, robj
*obj
) {
2704 if (listLength(c
->reply
) == 0 &&
2705 (c
->replstate
== REDIS_REPL_NONE
||
2706 c
->replstate
== REDIS_REPL_ONLINE
) &&
2707 aeCreateFileEvent(server
.el
, c
->fd
, AE_WRITABLE
,
2708 sendReplyToClient
, c
) == AE_ERR
) return;
2710 if (server
.vm_enabled
&& obj
->storage
!= REDIS_VM_MEMORY
) {
2711 obj
= dupStringObject(obj
);
2712 obj
->refcount
= 0; /* getDecodedObject() will increment the refcount */
2714 listAddNodeTail(c
->reply
,getDecodedObject(obj
));
2717 static void addReplySds(redisClient
*c
, sds s
) {
2718 robj
*o
= createObject(REDIS_STRING
,s
);
2723 static void addReplyDouble(redisClient
*c
, double d
) {
2726 snprintf(buf
,sizeof(buf
),"%.17g",d
);
2727 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2728 (unsigned long) strlen(buf
),buf
));
2731 static void addReplyLong(redisClient
*c
, long l
) {
2736 addReply(c
,shared
.czero
);
2738 } else if (l
== 1) {
2739 addReply(c
,shared
.cone
);
2742 len
= snprintf(buf
,sizeof(buf
),":%ld\r\n",l
);
2743 addReplySds(c
,sdsnewlen(buf
,len
));
2746 static void addReplyLongLong(redisClient
*c
, long long ll
) {
2751 addReply(c
,shared
.czero
);
2753 } else if (ll
== 1) {
2754 addReply(c
,shared
.cone
);
2757 len
= snprintf(buf
,sizeof(buf
),":%lld\r\n",ll
);
2758 addReplySds(c
,sdsnewlen(buf
,len
));
2761 static void addReplyUlong(redisClient
*c
, unsigned long ul
) {
2766 addReply(c
,shared
.czero
);
2768 } else if (ul
== 1) {
2769 addReply(c
,shared
.cone
);
2772 len
= snprintf(buf
,sizeof(buf
),":%lu\r\n",ul
);
2773 addReplySds(c
,sdsnewlen(buf
,len
));
2776 static void addReplyBulkLen(redisClient
*c
, robj
*obj
) {
2779 if (obj
->encoding
== REDIS_ENCODING_RAW
) {
2780 len
= sdslen(obj
->ptr
);
2782 long n
= (long)obj
->ptr
;
2784 /* Compute how many bytes will take this integer as a radix 10 string */
2790 while((n
= n
/10) != 0) {
2794 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",(unsigned long)len
));
2797 static void addReplyBulk(redisClient
*c
, robj
*obj
) {
2798 addReplyBulkLen(c
,obj
);
2800 addReply(c
,shared
.crlf
);
2803 /* In the CONFIG command we need to add vanilla C string as bulk replies */
2804 static void addReplyBulkCString(redisClient
*c
, char *s
) {
2806 addReply(c
,shared
.nullbulk
);
2808 robj
*o
= createStringObject(s
,strlen(s
));
2814 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2819 REDIS_NOTUSED(mask
);
2820 REDIS_NOTUSED(privdata
);
2822 cfd
= anetAccept(server
.neterr
, fd
, cip
, &cport
);
2823 if (cfd
== AE_ERR
) {
2824 redisLog(REDIS_VERBOSE
,"Accepting client connection: %s", server
.neterr
);
2827 redisLog(REDIS_VERBOSE
,"Accepted %s:%d", cip
, cport
);
2828 if ((c
= createClient(cfd
)) == NULL
) {
2829 redisLog(REDIS_WARNING
,"Error allocating resoures for the client");
2830 close(cfd
); /* May be already closed, just ingore errors */
2833 /* If maxclient directive is set and this is one client more... close the
2834 * connection. Note that we create the client instead to check before
2835 * for this condition, since now the socket is already set in nonblocking
2836 * mode and we can send an error for free using the Kernel I/O */
2837 if (server
.maxclients
&& listLength(server
.clients
) > server
.maxclients
) {
2838 char *err
= "-ERR max number of clients reached\r\n";
2840 /* That's a best effort error message, don't check write errors */
2841 if (write(c
->fd
,err
,strlen(err
)) == -1) {
2842 /* Nothing to do, Just to avoid the warning... */
2847 server
.stat_numconnections
++;
2850 /* ======================= Redis objects implementation ===================== */
2852 static robj
*createObject(int type
, void *ptr
) {
2855 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2856 if (listLength(server
.objfreelist
)) {
2857 listNode
*head
= listFirst(server
.objfreelist
);
2858 o
= listNodeValue(head
);
2859 listDelNode(server
.objfreelist
,head
);
2860 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2862 if (server
.vm_enabled
) {
2863 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2864 o
= zmalloc(sizeof(*o
));
2866 o
= zmalloc(sizeof(*o
)-sizeof(struct redisObjectVM
));
2870 o
->encoding
= REDIS_ENCODING_RAW
;
2873 if (server
.vm_enabled
) {
2874 /* Note that this code may run in the context of an I/O thread
2875 * and accessing to server.unixtime in theory is an error
2876 * (no locks). But in practice this is safe, and even if we read
2877 * garbage Redis will not fail, as it's just a statistical info */
2878 o
->vm
.atime
= server
.unixtime
;
2879 o
->storage
= REDIS_VM_MEMORY
;
2884 static robj
*createStringObject(char *ptr
, size_t len
) {
2885 return createObject(REDIS_STRING
,sdsnewlen(ptr
,len
));
2888 static robj
*createStringObjectFromLongLong(long long value
) {
2890 if (value
>= 0 && value
< REDIS_SHARED_INTEGERS
) {
2891 incrRefCount(shared
.integers
[value
]);
2892 o
= shared
.integers
[value
];
2894 o
= createObject(REDIS_STRING
, NULL
);
2895 if (value
>= LONG_MIN
&& value
<= LONG_MAX
) {
2896 o
->encoding
= REDIS_ENCODING_INT
;
2897 o
->ptr
= (void*)((long)value
);
2899 o
->ptr
= sdscatprintf(sdsempty(),"%lld",value
);
2905 static robj
*dupStringObject(robj
*o
) {
2906 assert(o
->encoding
== REDIS_ENCODING_RAW
);
2907 return createStringObject(o
->ptr
,sdslen(o
->ptr
));
2910 static robj
*createListObject(void) {
2911 list
*l
= listCreate();
2913 listSetFreeMethod(l
,decrRefCount
);
2914 return createObject(REDIS_LIST
,l
);
2917 static robj
*createSetObject(void) {
2918 dict
*d
= dictCreate(&setDictType
,NULL
);
2919 return createObject(REDIS_SET
,d
);
2922 static robj
*createHashObject(void) {
2923 /* All the Hashes start as zipmaps. Will be automatically converted
2924 * into hash tables if there are enough elements or big elements
2926 unsigned char *zm
= zipmapNew();
2927 robj
*o
= createObject(REDIS_HASH
,zm
);
2928 o
->encoding
= REDIS_ENCODING_ZIPMAP
;
2932 static robj
*createZsetObject(void) {
2933 zset
*zs
= zmalloc(sizeof(*zs
));
2935 zs
->dict
= dictCreate(&zsetDictType
,NULL
);
2936 zs
->zsl
= zslCreate();
2937 return createObject(REDIS_ZSET
,zs
);
2940 static void freeStringObject(robj
*o
) {
2941 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2946 static void freeListObject(robj
*o
) {
2947 listRelease((list
*) o
->ptr
);
2950 static void freeSetObject(robj
*o
) {
2951 dictRelease((dict
*) o
->ptr
);
2954 static void freeZsetObject(robj
*o
) {
2957 dictRelease(zs
->dict
);
2962 static void freeHashObject(robj
*o
) {
2963 switch (o
->encoding
) {
2964 case REDIS_ENCODING_HT
:
2965 dictRelease((dict
*) o
->ptr
);
2967 case REDIS_ENCODING_ZIPMAP
:
2971 redisPanic("Unknown hash encoding type");
2976 static void incrRefCount(robj
*o
) {
2980 static void decrRefCount(void *obj
) {
2983 if (o
->refcount
<= 0) redisPanic("decrRefCount against refcount <= 0");
2984 /* Object is a key of a swapped out value, or in the process of being
2986 if (server
.vm_enabled
&&
2987 (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
))
2989 if (o
->storage
== REDIS_VM_LOADING
) vmCancelThreadedIOJob(obj
);
2990 redisAssert(o
->type
== REDIS_STRING
);
2991 freeStringObject(o
);
2992 vmMarkPagesFree(o
->vm
.page
,o
->vm
.usedpages
);
2993 pthread_mutex_lock(&server
.obj_freelist_mutex
);
2994 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2995 !listAddNodeHead(server
.objfreelist
,o
))
2997 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2998 server
.vm_stats_swapped_objects
--;
3001 /* Object is in memory, or in the process of being swapped out. */
3002 if (--(o
->refcount
) == 0) {
3003 if (server
.vm_enabled
&& o
->storage
== REDIS_VM_SWAPPING
)
3004 vmCancelThreadedIOJob(obj
);
3006 case REDIS_STRING
: freeStringObject(o
); break;
3007 case REDIS_LIST
: freeListObject(o
); break;
3008 case REDIS_SET
: freeSetObject(o
); break;
3009 case REDIS_ZSET
: freeZsetObject(o
); break;
3010 case REDIS_HASH
: freeHashObject(o
); break;
3011 default: redisPanic("Unknown object type"); break;
3013 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
3014 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
3015 !listAddNodeHead(server
.objfreelist
,o
))
3017 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
3021 static robj
*lookupKey(redisDb
*db
, robj
*key
) {
3022 dictEntry
*de
= dictFind(db
->dict
,key
);
3024 robj
*key
= dictGetEntryKey(de
);
3025 robj
*val
= dictGetEntryVal(de
);
3027 if (server
.vm_enabled
) {
3028 if (key
->storage
== REDIS_VM_MEMORY
||
3029 key
->storage
== REDIS_VM_SWAPPING
)
3031 /* If we were swapping the object out, stop it, this key
3033 if (key
->storage
== REDIS_VM_SWAPPING
)
3034 vmCancelThreadedIOJob(key
);
3035 /* Update the access time of the key for the aging algorithm. */
3036 key
->vm
.atime
= server
.unixtime
;
3038 int notify
= (key
->storage
== REDIS_VM_LOADING
);
3040 /* Our value was swapped on disk. Bring it at home. */
3041 redisAssert(val
== NULL
);
3042 val
= vmLoadObject(key
);
3043 dictGetEntryVal(de
) = val
;
3045 /* Clients blocked by the VM subsystem may be waiting for
3047 if (notify
) handleClientsBlockedOnSwappedKey(db
,key
);
3056 static robj
*lookupKeyRead(redisDb
*db
, robj
*key
) {
3057 expireIfNeeded(db
,key
);
3058 return lookupKey(db
,key
);
3061 static robj
*lookupKeyWrite(redisDb
*db
, robj
*key
) {
3062 deleteIfVolatile(db
,key
);
3063 return lookupKey(db
,key
);
3066 static robj
*lookupKeyReadOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
3067 robj
*o
= lookupKeyRead(c
->db
, key
);
3068 if (!o
) addReply(c
,reply
);
3072 static robj
*lookupKeyWriteOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
3073 robj
*o
= lookupKeyWrite(c
->db
, key
);
3074 if (!o
) addReply(c
,reply
);
3078 static int checkType(redisClient
*c
, robj
*o
, int type
) {
3079 if (o
->type
!= type
) {
3080 addReply(c
,shared
.wrongtypeerr
);
3086 static int deleteKey(redisDb
*db
, robj
*key
) {
3089 /* We need to protect key from destruction: after the first dictDelete()
3090 * it may happen that 'key' is no longer valid if we don't increment
3091 * it's count. This may happen when we get the object reference directly
3092 * from the hash table with dictRandomKey() or dict iterators */
3094 if (dictSize(db
->expires
)) dictDelete(db
->expires
,key
);
3095 retval
= dictDelete(db
->dict
,key
);
3098 return retval
== DICT_OK
;
3101 /* Check if the nul-terminated string 's' can be represented by a long
3102 * (that is, is a number that fits into long without any other space or
3103 * character before or after the digits).
3105 * If so, the function returns REDIS_OK and *longval is set to the value
3106 * of the number. Otherwise REDIS_ERR is returned */
3107 static int isStringRepresentableAsLong(sds s
, long *longval
) {
3108 char buf
[32], *endptr
;
3112 value
= strtol(s
, &endptr
, 10);
3113 if (endptr
[0] != '\0') return REDIS_ERR
;
3114 slen
= snprintf(buf
,32,"%ld",value
);
3116 /* If the number converted back into a string is not identical
3117 * then it's not possible to encode the string as integer */
3118 if (sdslen(s
) != (unsigned)slen
|| memcmp(buf
,s
,slen
)) return REDIS_ERR
;
3119 if (longval
) *longval
= value
;
3123 /* Try to encode a string object in order to save space */
3124 static robj
*tryObjectEncoding(robj
*o
) {
3128 if (o
->encoding
!= REDIS_ENCODING_RAW
)
3129 return o
; /* Already encoded */
3131 /* It's not safe to encode shared objects: shared objects can be shared
3132 * everywhere in the "object space" of Redis. Encoded objects can only
3133 * appear as "values" (and not, for instance, as keys) */
3134 if (o
->refcount
> 1) return o
;
3136 /* Currently we try to encode only strings */
3137 redisAssert(o
->type
== REDIS_STRING
);
3139 /* Check if we can represent this string as a long integer */
3140 if (isStringRepresentableAsLong(s
,&value
) == REDIS_ERR
) return o
;
3142 /* Ok, this object can be encoded */
3143 if (value
>= 0 && value
< REDIS_SHARED_INTEGERS
) {
3145 incrRefCount(shared
.integers
[value
]);
3146 return shared
.integers
[value
];
3148 o
->encoding
= REDIS_ENCODING_INT
;
3150 o
->ptr
= (void*) value
;
3155 /* Get a decoded version of an encoded object (returned as a new object).
3156 * If the object is already raw-encoded just increment the ref count. */
3157 static robj
*getDecodedObject(robj
*o
) {
3160 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3164 if (o
->type
== REDIS_STRING
&& o
->encoding
== REDIS_ENCODING_INT
) {
3167 snprintf(buf
,32,"%ld",(long)o
->ptr
);
3168 dec
= createStringObject(buf
,strlen(buf
));
3171 redisPanic("Unknown encoding type");
3175 /* Compare two string objects via strcmp() or alike.
3176 * Note that the objects may be integer-encoded. In such a case we
3177 * use snprintf() to get a string representation of the numbers on the stack
3178 * and compare the strings, it's much faster than calling getDecodedObject().
3180 * Important note: if objects are not integer encoded, but binary-safe strings,
3181 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
3183 static int compareStringObjects(robj
*a
, robj
*b
) {
3184 redisAssert(a
->type
== REDIS_STRING
&& b
->type
== REDIS_STRING
);
3185 char bufa
[128], bufb
[128], *astr
, *bstr
;
3188 if (a
== b
) return 0;
3189 if (a
->encoding
!= REDIS_ENCODING_RAW
) {
3190 snprintf(bufa
,sizeof(bufa
),"%ld",(long) a
->ptr
);
3196 if (b
->encoding
!= REDIS_ENCODING_RAW
) {
3197 snprintf(bufb
,sizeof(bufb
),"%ld",(long) b
->ptr
);
3203 return bothsds
? sdscmp(astr
,bstr
) : strcmp(astr
,bstr
);
3206 static size_t stringObjectLen(robj
*o
) {
3207 redisAssert(o
->type
== REDIS_STRING
);
3208 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3209 return sdslen(o
->ptr
);
3213 return snprintf(buf
,32,"%ld",(long)o
->ptr
);
3217 static int getDoubleFromObject(robj
*o
, double *target
) {
3224 redisAssert(o
->type
== REDIS_STRING
);
3225 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3226 value
= strtod(o
->ptr
, &eptr
);
3227 if (eptr
[0] != '\0') return REDIS_ERR
;
3228 } else if (o
->encoding
== REDIS_ENCODING_INT
) {
3229 value
= (long)o
->ptr
;
3231 redisPanic("Unknown string encoding");
3239 static int getDoubleFromObjectOrReply(redisClient
*c
, robj
*o
, double *target
, const char *msg
) {
3241 if (getDoubleFromObject(o
, &value
) != REDIS_OK
) {
3243 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3245 addReplySds(c
, sdsnew("-ERR value is not a double\r\n"));
3254 static int getLongLongFromObject(robj
*o
, long long *target
) {
3261 redisAssert(o
->type
== REDIS_STRING
);
3262 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3263 value
= strtoll(o
->ptr
, &eptr
, 10);
3264 if (eptr
[0] != '\0') return REDIS_ERR
;
3265 } else if (o
->encoding
== REDIS_ENCODING_INT
) {
3266 value
= (long)o
->ptr
;
3268 redisPanic("Unknown string encoding");
3276 static int getLongLongFromObjectOrReply(redisClient
*c
, robj
*o
, long long *target
, const char *msg
) {
3278 if (getLongLongFromObject(o
, &value
) != REDIS_OK
) {
3280 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3282 addReplySds(c
, sdsnew("-ERR value is not an integer\r\n"));
3291 static int getLongFromObjectOrReply(redisClient
*c
, robj
*o
, long *target
, const char *msg
) {
3294 if (getLongLongFromObjectOrReply(c
, o
, &value
, msg
) != REDIS_OK
) return REDIS_ERR
;
3295 if (value
< LONG_MIN
|| value
> LONG_MAX
) {
3297 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3299 addReplySds(c
, sdsnew("-ERR value is out of range\r\n"));
3308 /*============================ RDB saving/loading =========================== */
3310 static int rdbSaveType(FILE *fp
, unsigned char type
) {
3311 if (fwrite(&type
,1,1,fp
) == 0) return -1;
3315 static int rdbSaveTime(FILE *fp
, time_t t
) {
3316 int32_t t32
= (int32_t) t
;
3317 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
3321 /* check rdbLoadLen() comments for more info */
3322 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
3323 unsigned char buf
[2];
3326 /* Save a 6 bit len */
3327 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
3328 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3329 } else if (len
< (1<<14)) {
3330 /* Save a 14 bit len */
3331 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
3333 if (fwrite(buf
,2,1,fp
) == 0) return -1;
3335 /* Save a 32 bit len */
3336 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
3337 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3339 if (fwrite(&len
,4,1,fp
) == 0) return -1;
3344 /* String objects in the form "2391" "-100" without any space and with a
3345 * range of values that can fit in an 8, 16 or 32 bit signed value can be
3346 * encoded as integers to save space */
3347 static int rdbTryIntegerEncoding(char *s
, size_t len
, unsigned char *enc
) {
3349 char *endptr
, buf
[32];
3351 /* Check if it's possible to encode this value as a number */
3352 value
= strtoll(s
, &endptr
, 10);
3353 if (endptr
[0] != '\0') return 0;
3354 snprintf(buf
,32,"%lld",value
);
3356 /* If the number converted back into a string is not identical
3357 * then it's not possible to encode the string as integer */
3358 if (strlen(buf
) != len
|| memcmp(buf
,s
,len
)) return 0;
3360 /* Finally check if it fits in our ranges */
3361 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
3362 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
3363 enc
[1] = value
&0xFF;
3365 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
3366 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
3367 enc
[1] = value
&0xFF;
3368 enc
[2] = (value
>>8)&0xFF;
3370 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
3371 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
3372 enc
[1] = value
&0xFF;
3373 enc
[2] = (value
>>8)&0xFF;
3374 enc
[3] = (value
>>16)&0xFF;
3375 enc
[4] = (value
>>24)&0xFF;
3382 static int rdbSaveLzfStringObject(FILE *fp
, unsigned char *s
, size_t len
) {
3383 size_t comprlen
, outlen
;
3387 /* We require at least four bytes compression for this to be worth it */
3388 if (len
<= 4) return 0;
3390 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
3391 comprlen
= lzf_compress(s
, len
, out
, outlen
);
3392 if (comprlen
== 0) {
3396 /* Data compressed! Let's save it on disk */
3397 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
3398 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
3399 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
3400 if (rdbSaveLen(fp
,len
) == -1) goto writeerr
;
3401 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
3410 /* Save a string objet as [len][data] on disk. If the object is a string
3411 * representation of an integer value we try to safe it in a special form */
3412 static int rdbSaveRawString(FILE *fp
, unsigned char *s
, size_t len
) {
3415 /* Try integer encoding */
3417 unsigned char buf
[5];
3418 if ((enclen
= rdbTryIntegerEncoding((char*)s
,len
,buf
)) > 0) {
3419 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3424 /* Try LZF compression - under 20 bytes it's unable to compress even
3425 * aaaaaaaaaaaaaaaaaa so skip it */
3426 if (server
.rdbcompression
&& len
> 20) {
3429 retval
= rdbSaveLzfStringObject(fp
,s
,len
);
3430 if (retval
== -1) return -1;
3431 if (retval
> 0) return 0;
3432 /* retval == 0 means data can't be compressed, save the old way */
3435 /* Store verbatim */
3436 if (rdbSaveLen(fp
,len
) == -1) return -1;
3437 if (len
&& fwrite(s
,len
,1,fp
) == 0) return -1;
3441 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
3442 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
3445 /* Avoid incr/decr ref count business when possible.
3446 * This plays well with copy-on-write given that we are probably
3447 * in a child process (BGSAVE). Also this makes sure key objects
3448 * of swapped objects are not incRefCount-ed (an assert does not allow
3449 * this in order to avoid bugs) */
3450 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
3451 obj
= getDecodedObject(obj
);
3452 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3455 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3460 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
3461 * 8 bit integer specifing the length of the representation.
3462 * This 8 bit integer has special values in order to specify the following
3468 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
3469 unsigned char buf
[128];
3475 } else if (!isfinite(val
)) {
3477 buf
[0] = (val
< 0) ? 255 : 254;
3479 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
3480 buf
[0] = strlen((char*)buf
+1);
3483 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
3487 /* Save a Redis object. */
3488 static int rdbSaveObject(FILE *fp
, robj
*o
) {
3489 if (o
->type
== REDIS_STRING
) {
3490 /* Save a string value */
3491 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
3492 } else if (o
->type
== REDIS_LIST
) {
3493 /* Save a list value */
3494 list
*list
= o
->ptr
;
3498 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
3499 listRewind(list
,&li
);
3500 while((ln
= listNext(&li
))) {
3501 robj
*eleobj
= listNodeValue(ln
);
3503 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3505 } else if (o
->type
== REDIS_SET
) {
3506 /* Save a set value */
3508 dictIterator
*di
= dictGetIterator(set
);
3511 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
3512 while((de
= dictNext(di
)) != NULL
) {
3513 robj
*eleobj
= dictGetEntryKey(de
);
3515 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3517 dictReleaseIterator(di
);
3518 } else if (o
->type
== REDIS_ZSET
) {
3519 /* Save a set value */
3521 dictIterator
*di
= dictGetIterator(zs
->dict
);
3524 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
3525 while((de
= dictNext(di
)) != NULL
) {
3526 robj
*eleobj
= dictGetEntryKey(de
);
3527 double *score
= dictGetEntryVal(de
);
3529 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3530 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
3532 dictReleaseIterator(di
);
3533 } else if (o
->type
== REDIS_HASH
) {
3534 /* Save a hash value */
3535 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3536 unsigned char *p
= zipmapRewind(o
->ptr
);
3537 unsigned int count
= zipmapLen(o
->ptr
);
3538 unsigned char *key
, *val
;
3539 unsigned int klen
, vlen
;
3541 if (rdbSaveLen(fp
,count
) == -1) return -1;
3542 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
3543 if (rdbSaveRawString(fp
,key
,klen
) == -1) return -1;
3544 if (rdbSaveRawString(fp
,val
,vlen
) == -1) return -1;
3547 dictIterator
*di
= dictGetIterator(o
->ptr
);
3550 if (rdbSaveLen(fp
,dictSize((dict
*)o
->ptr
)) == -1) return -1;
3551 while((de
= dictNext(di
)) != NULL
) {
3552 robj
*key
= dictGetEntryKey(de
);
3553 robj
*val
= dictGetEntryVal(de
);
3555 if (rdbSaveStringObject(fp
,key
) == -1) return -1;
3556 if (rdbSaveStringObject(fp
,val
) == -1) return -1;
3558 dictReleaseIterator(di
);
3561 redisPanic("Unknown object type");
3566 /* Return the length the object will have on disk if saved with
3567 * the rdbSaveObject() function. Currently we use a trick to get
3568 * this length with very little changes to the code. In the future
3569 * we could switch to a faster solution. */
3570 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
3571 if (fp
== NULL
) fp
= server
.devnull
;
3573 assert(rdbSaveObject(fp
,o
) != 1);
3577 /* Return the number of pages required to save this object in the swap file */
3578 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
3579 off_t bytes
= rdbSavedObjectLen(o
,fp
);
3581 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
3584 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3585 static int rdbSave(char *filename
) {
3586 dictIterator
*di
= NULL
;
3591 time_t now
= time(NULL
);
3593 /* Wait for I/O therads to terminate, just in case this is a
3594 * foreground-saving, to avoid seeking the swap file descriptor at the
3596 if (server
.vm_enabled
)
3597 waitEmptyIOJobsQueue();
3599 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3600 fp
= fopen(tmpfile
,"w");
3602 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3605 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3606 for (j
= 0; j
< server
.dbnum
; j
++) {
3607 redisDb
*db
= server
.db
+j
;
3609 if (dictSize(d
) == 0) continue;
3610 di
= dictGetIterator(d
);
3616 /* Write the SELECT DB opcode */
3617 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3618 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3620 /* Iterate this DB writing every entry */
3621 while((de
= dictNext(di
)) != NULL
) {
3622 robj
*key
= dictGetEntryKey(de
);
3623 robj
*o
= dictGetEntryVal(de
);
3624 time_t expiretime
= getExpire(db
,key
);
3626 /* Save the expire time */
3627 if (expiretime
!= -1) {
3628 /* If this key is already expired skip it */
3629 if (expiretime
< now
) continue;
3630 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3631 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3633 /* Save the key and associated value. This requires special
3634 * handling if the value is swapped out. */
3635 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
3636 key
->storage
== REDIS_VM_SWAPPING
) {
3637 /* Save type, key, value */
3638 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3639 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3640 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3642 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3644 /* Get a preview of the object in memory */
3645 po
= vmPreviewObject(key
);
3646 /* Save type, key, value */
3647 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
3648 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3649 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3650 /* Remove the loaded object from memory */
3654 dictReleaseIterator(di
);
3657 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3659 /* Make sure data will not remain on the OS's output buffers */
3664 /* Use RENAME to make sure the DB file is changed atomically only
3665 * if the generate DB file is ok. */
3666 if (rename(tmpfile
,filename
) == -1) {
3667 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3671 redisLog(REDIS_NOTICE
,"DB saved on disk");
3673 server
.lastsave
= time(NULL
);
3679 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3680 if (di
) dictReleaseIterator(di
);
3684 static int rdbSaveBackground(char *filename
) {
3687 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3688 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
3689 if ((childpid
= fork()) == 0) {
3691 if (server
.vm_enabled
) vmReopenSwapFile();
3693 if (rdbSave(filename
) == REDIS_OK
) {
3700 if (childpid
== -1) {
3701 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3705 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3706 server
.bgsavechildpid
= childpid
;
3707 updateDictResizePolicy();
3710 return REDIS_OK
; /* unreached */
3713 static void rdbRemoveTempFile(pid_t childpid
) {
3716 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
3720 static int rdbLoadType(FILE *fp
) {
3722 if (fread(&type
,1,1,fp
) == 0) return -1;
3726 static time_t rdbLoadTime(FILE *fp
) {
3728 if (fread(&t32
,4,1,fp
) == 0) return -1;
3729 return (time_t) t32
;
3732 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3733 * of this file for a description of how this are stored on disk.
3735 * isencoded is set to 1 if the readed length is not actually a length but
3736 * an "encoding type", check the above comments for more info */
3737 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3738 unsigned char buf
[2];
3742 if (isencoded
) *isencoded
= 0;
3743 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3744 type
= (buf
[0]&0xC0)>>6;
3745 if (type
== REDIS_RDB_6BITLEN
) {
3746 /* Read a 6 bit len */
3748 } else if (type
== REDIS_RDB_ENCVAL
) {
3749 /* Read a 6 bit len encoding type */
3750 if (isencoded
) *isencoded
= 1;
3752 } else if (type
== REDIS_RDB_14BITLEN
) {
3753 /* Read a 14 bit len */
3754 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3755 return ((buf
[0]&0x3F)<<8)|buf
[1];
3757 /* Read a 32 bit len */
3758 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3763 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
) {
3764 unsigned char enc
[4];
3767 if (enctype
== REDIS_RDB_ENC_INT8
) {
3768 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3769 val
= (signed char)enc
[0];
3770 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3772 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3773 v
= enc
[0]|(enc
[1]<<8);
3775 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3777 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3778 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3781 val
= 0; /* anti-warning */
3782 redisPanic("Unknown RDB integer encoding type");
3784 return createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",val
));
3787 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3788 unsigned int len
, clen
;
3789 unsigned char *c
= NULL
;
3792 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3793 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3794 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3795 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3796 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3797 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3799 return createObject(REDIS_STRING
,val
);
3806 static robj
*rdbLoadStringObject(FILE*fp
) {
3811 len
= rdbLoadLen(fp
,&isencoded
);
3814 case REDIS_RDB_ENC_INT8
:
3815 case REDIS_RDB_ENC_INT16
:
3816 case REDIS_RDB_ENC_INT32
:
3817 return rdbLoadIntegerObject(fp
,len
);
3818 case REDIS_RDB_ENC_LZF
:
3819 return rdbLoadLzfStringObject(fp
);
3821 redisPanic("Unknown RDB encoding type");
3825 if (len
== REDIS_RDB_LENERR
) return NULL
;
3826 val
= sdsnewlen(NULL
,len
);
3827 if (len
&& fread(val
,len
,1,fp
) == 0) {
3831 return createObject(REDIS_STRING
,val
);
3834 /* For information about double serialization check rdbSaveDoubleValue() */
3835 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
3839 if (fread(&len
,1,1,fp
) == 0) return -1;
3841 case 255: *val
= R_NegInf
; return 0;
3842 case 254: *val
= R_PosInf
; return 0;
3843 case 253: *val
= R_Nan
; return 0;
3845 if (fread(buf
,len
,1,fp
) == 0) return -1;
3847 sscanf(buf
, "%lg", val
);
3852 /* Load a Redis object of the specified type from the specified file.
3853 * On success a newly allocated object is returned, otherwise NULL. */
3854 static robj
*rdbLoadObject(int type
, FILE *fp
) {
3857 redisLog(REDIS_DEBUG
,"LOADING OBJECT %d (at %d)\n",type
,ftell(fp
));
3858 if (type
== REDIS_STRING
) {
3859 /* Read string value */
3860 if ((o
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3861 o
= tryObjectEncoding(o
);
3862 } else if (type
== REDIS_LIST
|| type
== REDIS_SET
) {
3863 /* Read list/set value */
3866 if ((listlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3867 o
= (type
== REDIS_LIST
) ? createListObject() : createSetObject();
3868 /* It's faster to expand the dict to the right size asap in order
3869 * to avoid rehashing */
3870 if (type
== REDIS_SET
&& listlen
> DICT_HT_INITIAL_SIZE
)
3871 dictExpand(o
->ptr
,listlen
);
3872 /* Load every single element of the list/set */
3876 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3877 ele
= tryObjectEncoding(ele
);
3878 if (type
== REDIS_LIST
) {
3879 listAddNodeTail((list
*)o
->ptr
,ele
);
3881 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
3884 } else if (type
== REDIS_ZSET
) {
3885 /* Read list/set value */
3889 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3890 o
= createZsetObject();
3892 /* Load every single element of the list/set */
3895 double *score
= zmalloc(sizeof(double));
3897 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3898 ele
= tryObjectEncoding(ele
);
3899 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
3900 dictAdd(zs
->dict
,ele
,score
);
3901 zslInsert(zs
->zsl
,*score
,ele
);
3902 incrRefCount(ele
); /* added to skiplist */
3904 } else if (type
== REDIS_HASH
) {
3907 if ((hashlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3908 o
= createHashObject();
3909 /* Too many entries? Use an hash table. */
3910 if (hashlen
> server
.hash_max_zipmap_entries
)
3911 convertToRealHash(o
);
3912 /* Load every key/value, then set it into the zipmap or hash
3913 * table, as needed. */
3917 if ((key
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3918 if ((val
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3919 /* If we are using a zipmap and there are too big values
3920 * the object is converted to real hash table encoding. */
3921 if (o
->encoding
!= REDIS_ENCODING_HT
&&
3922 (sdslen(key
->ptr
) > server
.hash_max_zipmap_value
||
3923 sdslen(val
->ptr
) > server
.hash_max_zipmap_value
))
3925 convertToRealHash(o
);
3928 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3929 unsigned char *zm
= o
->ptr
;
3931 zm
= zipmapSet(zm
,key
->ptr
,sdslen(key
->ptr
),
3932 val
->ptr
,sdslen(val
->ptr
),NULL
);
3937 key
= tryObjectEncoding(key
);
3938 val
= tryObjectEncoding(val
);
3939 dictAdd((dict
*)o
->ptr
,key
,val
);
3943 redisPanic("Unknown object type");
3948 static int rdbLoad(char *filename
) {
3951 int type
, retval
, rdbver
;
3952 int swap_all_values
= 0;
3953 dict
*d
= server
.db
[0].dict
;
3954 redisDb
*db
= server
.db
+0;
3956 time_t expiretime
, now
= time(NULL
);
3957 long long loadedkeys
= 0;
3959 fp
= fopen(filename
,"r");
3960 if (!fp
) return REDIS_ERR
;
3961 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
3963 if (memcmp(buf
,"REDIS",5) != 0) {
3965 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
3968 rdbver
= atoi(buf
+5);
3971 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
3979 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3980 if (type
== REDIS_EXPIRETIME
) {
3981 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
3982 /* We read the time so we need to read the object type again */
3983 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3985 if (type
== REDIS_EOF
) break;
3986 /* Handle SELECT DB opcode as a special case */
3987 if (type
== REDIS_SELECTDB
) {
3988 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
3990 if (dbid
>= (unsigned)server
.dbnum
) {
3991 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
3994 db
= server
.db
+dbid
;
3999 if ((key
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
4001 if ((val
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
4002 /* Add the new object in the hash table */
4003 retval
= dictAdd(d
,key
,val
);
4004 if (retval
== DICT_ERR
) {
4005 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", key
->ptr
);
4009 /* Set the expire time if needed */
4010 if (expiretime
!= -1) {
4011 setExpire(db
,key
,expiretime
);
4012 /* Delete this key if already expired */
4013 if (expiretime
< now
) {
4015 continue; /* don't try to swap this out */
4019 /* Handle swapping while loading big datasets when VM is on */
4021 /* If we detecter we are hopeless about fitting something in memory
4022 * we just swap every new key on disk. Directly...
4023 * Note that's important to check for this condition before resorting
4024 * to random sampling, otherwise we may try to swap already
4026 if (swap_all_values
) {
4027 dictEntry
*de
= dictFind(d
,key
);
4029 /* de may be NULL since the key already expired */
4031 key
= dictGetEntryKey(de
);
4032 val
= dictGetEntryVal(de
);
4034 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
4035 dictGetEntryVal(de
) = NULL
;
4041 /* If we have still some hope of having some value fitting memory
4042 * then we try random sampling. */
4043 if (!swap_all_values
&& server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
4044 while (zmalloc_used_memory() > server
.vm_max_memory
) {
4045 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
4047 if (zmalloc_used_memory() > server
.vm_max_memory
)
4048 swap_all_values
= 1; /* We are already using too much mem */
4054 eoferr
: /* unexpected end of file is handled here with a fatal exit */
4055 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
4057 return REDIS_ERR
; /* Just to avoid warning */
4060 /*================================== Commands =============================== */
4062 static void authCommand(redisClient
*c
) {
4063 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
4064 c
->authenticated
= 1;
4065 addReply(c
,shared
.ok
);
4067 c
->authenticated
= 0;
4068 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
4072 static void pingCommand(redisClient
*c
) {
4073 addReply(c
,shared
.pong
);
4076 static void echoCommand(redisClient
*c
) {
4077 addReplyBulk(c
,c
->argv
[1]);
4080 /*=================================== Strings =============================== */
4082 static void setGenericCommand(redisClient
*c
, int nx
, robj
*key
, robj
*val
, robj
*expire
) {
4084 long seconds
= 0; /* initialized to avoid an harmness warning */
4087 if (getLongFromObjectOrReply(c
, expire
, &seconds
, NULL
) != REDIS_OK
)
4090 addReplySds(c
,sdsnew("-ERR invalid expire time in SETEX\r\n"));
4095 if (nx
) deleteIfVolatile(c
->db
,key
);
4096 retval
= dictAdd(c
->db
->dict
,key
,val
);
4097 if (retval
== DICT_ERR
) {
4099 /* If the key is about a swapped value, we want a new key object
4100 * to overwrite the old. So we delete the old key in the database.
4101 * This will also make sure that swap pages about the old object
4102 * will be marked as free. */
4103 if (server
.vm_enabled
&& deleteIfSwapped(c
->db
,key
))
4105 dictReplace(c
->db
->dict
,key
,val
);
4108 addReply(c
,shared
.czero
);
4116 removeExpire(c
->db
,key
);
4117 if (expire
) setExpire(c
->db
,key
,time(NULL
)+seconds
);
4118 addReply(c
, nx
? shared
.cone
: shared
.ok
);
4121 static void setCommand(redisClient
*c
) {
4122 setGenericCommand(c
,0,c
->argv
[1],c
->argv
[2],NULL
);
4125 static void setnxCommand(redisClient
*c
) {
4126 setGenericCommand(c
,1,c
->argv
[1],c
->argv
[2],NULL
);
4129 static void setexCommand(redisClient
*c
) {
4130 setGenericCommand(c
,0,c
->argv
[1],c
->argv
[3],c
->argv
[2]);
4133 static int getGenericCommand(redisClient
*c
) {
4136 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
)
4139 if (o
->type
!= REDIS_STRING
) {
4140 addReply(c
,shared
.wrongtypeerr
);
4148 static void getCommand(redisClient
*c
) {
4149 getGenericCommand(c
);
4152 static void getsetCommand(redisClient
*c
) {
4153 if (getGenericCommand(c
) == REDIS_ERR
) return;
4154 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
4155 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4157 incrRefCount(c
->argv
[1]);
4159 incrRefCount(c
->argv
[2]);
4161 removeExpire(c
->db
,c
->argv
[1]);
4164 static void mgetCommand(redisClient
*c
) {
4167 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
4168 for (j
= 1; j
< c
->argc
; j
++) {
4169 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
4171 addReply(c
,shared
.nullbulk
);
4173 if (o
->type
!= REDIS_STRING
) {
4174 addReply(c
,shared
.nullbulk
);
4182 static void msetGenericCommand(redisClient
*c
, int nx
) {
4183 int j
, busykeys
= 0;
4185 if ((c
->argc
% 2) == 0) {
4186 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
4189 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
4190 * set nothing at all if at least one already key exists. */
4192 for (j
= 1; j
< c
->argc
; j
+= 2) {
4193 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
4199 addReply(c
, shared
.czero
);
4203 for (j
= 1; j
< c
->argc
; j
+= 2) {
4206 c
->argv
[j
+1] = tryObjectEncoding(c
->argv
[j
+1]);
4207 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
4208 if (retval
== DICT_ERR
) {
4209 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
4210 incrRefCount(c
->argv
[j
+1]);
4212 incrRefCount(c
->argv
[j
]);
4213 incrRefCount(c
->argv
[j
+1]);
4215 removeExpire(c
->db
,c
->argv
[j
]);
4217 server
.dirty
+= (c
->argc
-1)/2;
4218 addReply(c
, nx
? shared
.cone
: shared
.ok
);
4221 static void msetCommand(redisClient
*c
) {
4222 msetGenericCommand(c
,0);
4225 static void msetnxCommand(redisClient
*c
) {
4226 msetGenericCommand(c
,1);
4229 static void incrDecrCommand(redisClient
*c
, long long incr
) {
4234 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4236 if (getLongLongFromObjectOrReply(c
, o
, &value
, NULL
) != REDIS_OK
) return;
4239 o
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
4240 o
= tryObjectEncoding(o
);
4241 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
4242 if (retval
== DICT_ERR
) {
4243 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4244 removeExpire(c
->db
,c
->argv
[1]);
4246 incrRefCount(c
->argv
[1]);
4249 addReply(c
,shared
.colon
);
4251 addReply(c
,shared
.crlf
);
4254 static void incrCommand(redisClient
*c
) {
4255 incrDecrCommand(c
,1);
4258 static void decrCommand(redisClient
*c
) {
4259 incrDecrCommand(c
,-1);
4262 static void incrbyCommand(redisClient
*c
) {
4265 if (getLongLongFromObjectOrReply(c
, c
->argv
[2], &incr
, NULL
) != REDIS_OK
) return;
4266 incrDecrCommand(c
,incr
);
4269 static void decrbyCommand(redisClient
*c
) {
4272 if (getLongLongFromObjectOrReply(c
, c
->argv
[2], &incr
, NULL
) != REDIS_OK
) return;
4273 incrDecrCommand(c
,-incr
);
4276 static void appendCommand(redisClient
*c
) {
4281 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4283 /* Create the key */
4284 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4285 incrRefCount(c
->argv
[1]);
4286 incrRefCount(c
->argv
[2]);
4287 totlen
= stringObjectLen(c
->argv
[2]);
4291 de
= dictFind(c
->db
->dict
,c
->argv
[1]);
4294 o
= dictGetEntryVal(de
);
4295 if (o
->type
!= REDIS_STRING
) {
4296 addReply(c
,shared
.wrongtypeerr
);
4299 /* If the object is specially encoded or shared we have to make
4301 if (o
->refcount
!= 1 || o
->encoding
!= REDIS_ENCODING_RAW
) {
4302 robj
*decoded
= getDecodedObject(o
);
4304 o
= createStringObject(decoded
->ptr
, sdslen(decoded
->ptr
));
4305 decrRefCount(decoded
);
4306 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4309 if (c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
) {
4310 o
->ptr
= sdscatlen(o
->ptr
,
4311 c
->argv
[2]->ptr
, sdslen(c
->argv
[2]->ptr
));
4313 o
->ptr
= sdscatprintf(o
->ptr
, "%ld",
4314 (unsigned long) c
->argv
[2]->ptr
);
4316 totlen
= sdslen(o
->ptr
);
4319 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen
));
4322 static void substrCommand(redisClient
*c
) {
4324 long start
= atoi(c
->argv
[2]->ptr
);
4325 long end
= atoi(c
->argv
[3]->ptr
);
4326 size_t rangelen
, strlen
;
4329 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4330 checkType(c
,o
,REDIS_STRING
)) return;
4332 o
= getDecodedObject(o
);
4333 strlen
= sdslen(o
->ptr
);
4335 /* convert negative indexes */
4336 if (start
< 0) start
= strlen
+start
;
4337 if (end
< 0) end
= strlen
+end
;
4338 if (start
< 0) start
= 0;
4339 if (end
< 0) end
= 0;
4341 /* indexes sanity checks */
4342 if (start
> end
|| (size_t)start
>= strlen
) {
4343 /* Out of range start or start > end result in null reply */
4344 addReply(c
,shared
.nullbulk
);
4348 if ((size_t)end
>= strlen
) end
= strlen
-1;
4349 rangelen
= (end
-start
)+1;
4351 /* Return the result */
4352 addReplySds(c
,sdscatprintf(sdsempty(),"$%zu\r\n",rangelen
));
4353 range
= sdsnewlen((char*)o
->ptr
+start
,rangelen
);
4354 addReplySds(c
,range
);
4355 addReply(c
,shared
.crlf
);
4359 /* ========================= Type agnostic commands ========================= */
4361 static void delCommand(redisClient
*c
) {
4364 for (j
= 1; j
< c
->argc
; j
++) {
4365 if (deleteKey(c
->db
,c
->argv
[j
])) {
4370 addReplyLong(c
,deleted
);
4373 static void existsCommand(redisClient
*c
) {
4374 addReply(c
,lookupKeyRead(c
->db
,c
->argv
[1]) ? shared
.cone
: shared
.czero
);
4377 static void selectCommand(redisClient
*c
) {
4378 int id
= atoi(c
->argv
[1]->ptr
);
4380 if (selectDb(c
,id
) == REDIS_ERR
) {
4381 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
4383 addReply(c
,shared
.ok
);
4387 static void randomkeyCommand(redisClient
*c
) {
4392 de
= dictGetRandomKey(c
->db
->dict
);
4393 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
4397 addReply(c
,shared
.nullbulk
);
4401 key
= dictGetEntryKey(de
);
4402 if (server
.vm_enabled
) {
4403 key
= dupStringObject(key
);
4404 addReplyBulk(c
,key
);
4407 addReplyBulk(c
,key
);
4411 static void keysCommand(redisClient
*c
) {
4414 sds pattern
= c
->argv
[1]->ptr
;
4415 int plen
= sdslen(pattern
);
4416 unsigned long numkeys
= 0;
4417 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
4419 di
= dictGetIterator(c
->db
->dict
);
4421 decrRefCount(lenobj
);
4422 while((de
= dictNext(di
)) != NULL
) {
4423 robj
*keyobj
= dictGetEntryKey(de
);
4425 sds key
= keyobj
->ptr
;
4426 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
4427 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
4428 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
4429 addReplyBulk(c
,keyobj
);
4434 dictReleaseIterator(di
);
4435 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",numkeys
);
4438 static void dbsizeCommand(redisClient
*c
) {
4440 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
4443 static void lastsaveCommand(redisClient
*c
) {
4445 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
4448 static void typeCommand(redisClient
*c
) {
4452 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4457 case REDIS_STRING
: type
= "+string"; break;
4458 case REDIS_LIST
: type
= "+list"; break;
4459 case REDIS_SET
: type
= "+set"; break;
4460 case REDIS_ZSET
: type
= "+zset"; break;
4461 case REDIS_HASH
: type
= "+hash"; break;
4462 default: type
= "+unknown"; break;
4465 addReplySds(c
,sdsnew(type
));
4466 addReply(c
,shared
.crlf
);
4469 static void saveCommand(redisClient
*c
) {
4470 if (server
.bgsavechildpid
!= -1) {
4471 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
4474 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4475 addReply(c
,shared
.ok
);
4477 addReply(c
,shared
.err
);
4481 static void bgsaveCommand(redisClient
*c
) {
4482 if (server
.bgsavechildpid
!= -1) {
4483 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
4486 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
4487 char *status
= "+Background saving started\r\n";
4488 addReplySds(c
,sdsnew(status
));
4490 addReply(c
,shared
.err
);
4494 static void shutdownCommand(redisClient
*c
) {
4495 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
4496 /* Kill the saving child if there is a background saving in progress.
4497 We want to avoid race conditions, for instance our saving child may
4498 overwrite the synchronous saving did by SHUTDOWN. */
4499 if (server
.bgsavechildpid
!= -1) {
4500 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
4501 kill(server
.bgsavechildpid
,SIGKILL
);
4502 rdbRemoveTempFile(server
.bgsavechildpid
);
4504 if (server
.appendonly
) {
4505 /* Append only file: fsync() the AOF and exit */
4506 fsync(server
.appendfd
);
4507 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4510 /* Snapshotting. Perform a SYNC SAVE and exit */
4511 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4512 if (server
.daemonize
)
4513 unlink(server
.pidfile
);
4514 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
4515 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
4518 /* Ooops.. error saving! The best we can do is to continue
4519 * operating. Note that if there was a background saving process,
4520 * in the next cron() Redis will be notified that the background
4521 * saving aborted, handling special stuff like slaves pending for
4522 * synchronization... */
4523 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
4525 sdsnew("-ERR can't quit, problems saving the DB\r\n"));
4530 static void renameGenericCommand(redisClient
*c
, int nx
) {
4533 /* To use the same key as src and dst is probably an error */
4534 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
4535 addReply(c
,shared
.sameobjecterr
);
4539 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
)
4543 deleteIfVolatile(c
->db
,c
->argv
[2]);
4544 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
4547 addReply(c
,shared
.czero
);
4550 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
4552 incrRefCount(c
->argv
[2]);
4554 deleteKey(c
->db
,c
->argv
[1]);
4556 addReply(c
,nx
? shared
.cone
: shared
.ok
);
4559 static void renameCommand(redisClient
*c
) {
4560 renameGenericCommand(c
,0);
4563 static void renamenxCommand(redisClient
*c
) {
4564 renameGenericCommand(c
,1);
4567 static void moveCommand(redisClient
*c
) {
4572 /* Obtain source and target DB pointers */
4575 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
4576 addReply(c
,shared
.outofrangeerr
);
4580 selectDb(c
,srcid
); /* Back to the source DB */
4582 /* If the user is moving using as target the same
4583 * DB as the source DB it is probably an error. */
4585 addReply(c
,shared
.sameobjecterr
);
4589 /* Check if the element exists and get a reference */
4590 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4592 addReply(c
,shared
.czero
);
4596 /* Try to add the element to the target DB */
4597 deleteIfVolatile(dst
,c
->argv
[1]);
4598 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
4599 addReply(c
,shared
.czero
);
4602 incrRefCount(c
->argv
[1]);
4605 /* OK! key moved, free the entry in the source DB */
4606 deleteKey(src
,c
->argv
[1]);
4608 addReply(c
,shared
.cone
);
4611 /* =================================== Lists ================================ */
4612 static void pushGenericCommand(redisClient
*c
, int where
) {
4616 lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4618 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4619 addReply(c
,shared
.cone
);
4622 lobj
= createListObject();
4624 if (where
== REDIS_HEAD
) {
4625 listAddNodeHead(list
,c
->argv
[2]);
4627 listAddNodeTail(list
,c
->argv
[2]);
4629 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
4630 incrRefCount(c
->argv
[1]);
4631 incrRefCount(c
->argv
[2]);
4633 if (lobj
->type
!= REDIS_LIST
) {
4634 addReply(c
,shared
.wrongtypeerr
);
4637 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4638 addReply(c
,shared
.cone
);
4642 if (where
== REDIS_HEAD
) {
4643 listAddNodeHead(list
,c
->argv
[2]);
4645 listAddNodeTail(list
,c
->argv
[2]);
4647 incrRefCount(c
->argv
[2]);
4650 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",listLength(list
)));
4653 static void lpushCommand(redisClient
*c
) {
4654 pushGenericCommand(c
,REDIS_HEAD
);
4657 static void rpushCommand(redisClient
*c
) {
4658 pushGenericCommand(c
,REDIS_TAIL
);
4661 static void llenCommand(redisClient
*c
) {
4665 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4666 checkType(c
,o
,REDIS_LIST
)) return;
4669 addReplyUlong(c
,listLength(l
));
4672 static void lindexCommand(redisClient
*c
) {
4674 int index
= atoi(c
->argv
[2]->ptr
);
4678 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4679 checkType(c
,o
,REDIS_LIST
)) return;
4682 ln
= listIndex(list
, index
);
4684 addReply(c
,shared
.nullbulk
);
4686 robj
*ele
= listNodeValue(ln
);
4687 addReplyBulk(c
,ele
);
4691 static void lsetCommand(redisClient
*c
) {
4693 int index
= atoi(c
->argv
[2]->ptr
);
4697 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
||
4698 checkType(c
,o
,REDIS_LIST
)) return;
4701 ln
= listIndex(list
, index
);
4703 addReply(c
,shared
.outofrangeerr
);
4705 robj
*ele
= listNodeValue(ln
);
4708 listNodeValue(ln
) = c
->argv
[3];
4709 incrRefCount(c
->argv
[3]);
4710 addReply(c
,shared
.ok
);
4715 static void popGenericCommand(redisClient
*c
, int where
) {
4720 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4721 checkType(c
,o
,REDIS_LIST
)) return;
4724 if (where
== REDIS_HEAD
)
4725 ln
= listFirst(list
);
4727 ln
= listLast(list
);
4730 addReply(c
,shared
.nullbulk
);
4732 robj
*ele
= listNodeValue(ln
);
4733 addReplyBulk(c
,ele
);
4734 listDelNode(list
,ln
);
4735 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4740 static void lpopCommand(redisClient
*c
) {
4741 popGenericCommand(c
,REDIS_HEAD
);
4744 static void rpopCommand(redisClient
*c
) {
4745 popGenericCommand(c
,REDIS_TAIL
);
4748 static void lrangeCommand(redisClient
*c
) {
4750 int start
= atoi(c
->argv
[2]->ptr
);
4751 int end
= atoi(c
->argv
[3]->ptr
);
4758 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
4759 || checkType(c
,o
,REDIS_LIST
)) return;
4761 llen
= listLength(list
);
4763 /* convert negative indexes */
4764 if (start
< 0) start
= llen
+start
;
4765 if (end
< 0) end
= llen
+end
;
4766 if (start
< 0) start
= 0;
4767 if (end
< 0) end
= 0;
4769 /* indexes sanity checks */
4770 if (start
> end
|| start
>= llen
) {
4771 /* Out of range start or start > end result in empty list */
4772 addReply(c
,shared
.emptymultibulk
);
4775 if (end
>= llen
) end
= llen
-1;
4776 rangelen
= (end
-start
)+1;
4778 /* Return the result in form of a multi-bulk reply */
4779 ln
= listIndex(list
, start
);
4780 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
4781 for (j
= 0; j
< rangelen
; j
++) {
4782 ele
= listNodeValue(ln
);
4783 addReplyBulk(c
,ele
);
4788 static void ltrimCommand(redisClient
*c
) {
4790 int start
= atoi(c
->argv
[2]->ptr
);
4791 int end
= atoi(c
->argv
[3]->ptr
);
4793 int j
, ltrim
, rtrim
;
4797 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.ok
)) == NULL
||
4798 checkType(c
,o
,REDIS_LIST
)) return;
4800 llen
= listLength(list
);
4802 /* convert negative indexes */
4803 if (start
< 0) start
= llen
+start
;
4804 if (end
< 0) end
= llen
+end
;
4805 if (start
< 0) start
= 0;
4806 if (end
< 0) end
= 0;
4808 /* indexes sanity checks */
4809 if (start
> end
|| start
>= llen
) {
4810 /* Out of range start or start > end result in empty list */
4814 if (end
>= llen
) end
= llen
-1;
4819 /* Remove list elements to perform the trim */
4820 for (j
= 0; j
< ltrim
; j
++) {
4821 ln
= listFirst(list
);
4822 listDelNode(list
,ln
);
4824 for (j
= 0; j
< rtrim
; j
++) {
4825 ln
= listLast(list
);
4826 listDelNode(list
,ln
);
4828 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4830 addReply(c
,shared
.ok
);
4833 static void lremCommand(redisClient
*c
) {
4836 listNode
*ln
, *next
;
4837 int toremove
= atoi(c
->argv
[2]->ptr
);
4841 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4842 checkType(c
,o
,REDIS_LIST
)) return;
4846 toremove
= -toremove
;
4849 ln
= fromtail
? list
->tail
: list
->head
;
4851 robj
*ele
= listNodeValue(ln
);
4853 next
= fromtail
? ln
->prev
: ln
->next
;
4854 if (compareStringObjects(ele
,c
->argv
[3]) == 0) {
4855 listDelNode(list
,ln
);
4858 if (toremove
&& removed
== toremove
) break;
4862 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4863 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
4866 /* This is the semantic of this command:
4867 * RPOPLPUSH srclist dstlist:
4868 * IF LLEN(srclist) > 0
4869 * element = RPOP srclist
4870 * LPUSH dstlist element
4877 * The idea is to be able to get an element from a list in a reliable way
4878 * since the element is not just returned but pushed against another list
4879 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4881 static void rpoplpushcommand(redisClient
*c
) {
4886 if ((sobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4887 checkType(c
,sobj
,REDIS_LIST
)) return;
4888 srclist
= sobj
->ptr
;
4889 ln
= listLast(srclist
);
4892 addReply(c
,shared
.nullbulk
);
4894 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4895 robj
*ele
= listNodeValue(ln
);
4898 if (dobj
&& dobj
->type
!= REDIS_LIST
) {
4899 addReply(c
,shared
.wrongtypeerr
);
4903 /* Add the element to the target list (unless it's directly
4904 * passed to some BLPOP-ing client */
4905 if (!handleClientsWaitingListPush(c
,c
->argv
[2],ele
)) {
4907 /* Create the list if the key does not exist */
4908 dobj
= createListObject();
4909 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
4910 incrRefCount(c
->argv
[2]);
4912 dstlist
= dobj
->ptr
;
4913 listAddNodeHead(dstlist
,ele
);
4917 /* Send the element to the client as reply as well */
4918 addReplyBulk(c
,ele
);
4920 /* Finally remove the element from the source list */
4921 listDelNode(srclist
,ln
);
4922 if (listLength(srclist
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4927 /* ==================================== Sets ================================ */
4929 static void saddCommand(redisClient
*c
) {
4932 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4934 set
= createSetObject();
4935 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
4936 incrRefCount(c
->argv
[1]);
4938 if (set
->type
!= REDIS_SET
) {
4939 addReply(c
,shared
.wrongtypeerr
);
4943 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
4944 incrRefCount(c
->argv
[2]);
4946 addReply(c
,shared
.cone
);
4948 addReply(c
,shared
.czero
);
4952 static void sremCommand(redisClient
*c
) {
4955 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4956 checkType(c
,set
,REDIS_SET
)) return;
4958 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
4960 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4961 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4962 addReply(c
,shared
.cone
);
4964 addReply(c
,shared
.czero
);
4968 static void smoveCommand(redisClient
*c
) {
4969 robj
*srcset
, *dstset
;
4971 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4972 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4974 /* If the source key does not exist return 0, if it's of the wrong type
4976 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
4977 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
4980 /* Error if the destination key is not a set as well */
4981 if (dstset
&& dstset
->type
!= REDIS_SET
) {
4982 addReply(c
,shared
.wrongtypeerr
);
4985 /* Remove the element from the source set */
4986 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
4987 /* Key not found in the src set! return zero */
4988 addReply(c
,shared
.czero
);
4991 if (dictSize((dict
*)srcset
->ptr
) == 0 && srcset
!= dstset
)
4992 deleteKey(c
->db
,c
->argv
[1]);
4994 /* Add the element to the destination set */
4996 dstset
= createSetObject();
4997 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
4998 incrRefCount(c
->argv
[2]);
5000 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
5001 incrRefCount(c
->argv
[3]);
5002 addReply(c
,shared
.cone
);
5005 static void sismemberCommand(redisClient
*c
) {
5008 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5009 checkType(c
,set
,REDIS_SET
)) return;
5011 if (dictFind(set
->ptr
,c
->argv
[2]))
5012 addReply(c
,shared
.cone
);
5014 addReply(c
,shared
.czero
);
5017 static void scardCommand(redisClient
*c
) {
5021 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5022 checkType(c
,o
,REDIS_SET
)) return;
5025 addReplyUlong(c
,dictSize(s
));
5028 static void spopCommand(redisClient
*c
) {
5032 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5033 checkType(c
,set
,REDIS_SET
)) return;
5035 de
= dictGetRandomKey(set
->ptr
);
5037 addReply(c
,shared
.nullbulk
);
5039 robj
*ele
= dictGetEntryKey(de
);
5041 addReplyBulk(c
,ele
);
5042 dictDelete(set
->ptr
,ele
);
5043 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
5044 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5049 static void srandmemberCommand(redisClient
*c
) {
5053 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5054 checkType(c
,set
,REDIS_SET
)) return;
5056 de
= dictGetRandomKey(set
->ptr
);
5058 addReply(c
,shared
.nullbulk
);
5060 robj
*ele
= dictGetEntryKey(de
);
5062 addReplyBulk(c
,ele
);
5066 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
5067 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
5069 return dictSize(*d1
)-dictSize(*d2
);
5072 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
5073 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
5076 robj
*lenobj
= NULL
, *dstset
= NULL
;
5077 unsigned long j
, cardinality
= 0;
5079 for (j
= 0; j
< setsnum
; j
++) {
5083 lookupKeyWrite(c
->db
,setskeys
[j
]) :
5084 lookupKeyRead(c
->db
,setskeys
[j
]);
5088 if (deleteKey(c
->db
,dstkey
))
5090 addReply(c
,shared
.czero
);
5092 addReply(c
,shared
.emptymultibulk
);
5096 if (setobj
->type
!= REDIS_SET
) {
5098 addReply(c
,shared
.wrongtypeerr
);
5101 dv
[j
] = setobj
->ptr
;
5103 /* Sort sets from the smallest to largest, this will improve our
5104 * algorithm's performace */
5105 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
5107 /* The first thing we should output is the total number of elements...
5108 * since this is a multi-bulk write, but at this stage we don't know
5109 * the intersection set size, so we use a trick, append an empty object
5110 * to the output list and save the pointer to later modify it with the
5113 lenobj
= createObject(REDIS_STRING
,NULL
);
5115 decrRefCount(lenobj
);
5117 /* If we have a target key where to store the resulting set
5118 * create this key with an empty set inside */
5119 dstset
= createSetObject();
5122 /* Iterate all the elements of the first (smallest) set, and test
5123 * the element against all the other sets, if at least one set does
5124 * not include the element it is discarded */
5125 di
= dictGetIterator(dv
[0]);
5127 while((de
= dictNext(di
)) != NULL
) {
5130 for (j
= 1; j
< setsnum
; j
++)
5131 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
5133 continue; /* at least one set does not contain the member */
5134 ele
= dictGetEntryKey(de
);
5136 addReplyBulk(c
,ele
);
5139 dictAdd(dstset
->ptr
,ele
,NULL
);
5143 dictReleaseIterator(di
);
5146 /* Store the resulting set into the target, if the intersection
5147 * is not an empty set. */
5148 deleteKey(c
->db
,dstkey
);
5149 if (dictSize((dict
*)dstset
->ptr
) > 0) {
5150 dictAdd(c
->db
->dict
,dstkey
,dstset
);
5151 incrRefCount(dstkey
);
5152 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
5154 decrRefCount(dstset
);
5155 addReply(c
,shared
.czero
);
5159 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
5164 static void sinterCommand(redisClient
*c
) {
5165 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
5168 static void sinterstoreCommand(redisClient
*c
) {
5169 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
5172 #define REDIS_OP_UNION 0
5173 #define REDIS_OP_DIFF 1
5174 #define REDIS_OP_INTER 2
5176 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
5177 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
5180 robj
*dstset
= NULL
;
5181 int j
, cardinality
= 0;
5183 for (j
= 0; j
< setsnum
; j
++) {
5187 lookupKeyWrite(c
->db
,setskeys
[j
]) :
5188 lookupKeyRead(c
->db
,setskeys
[j
]);
5193 if (setobj
->type
!= REDIS_SET
) {
5195 addReply(c
,shared
.wrongtypeerr
);
5198 dv
[j
] = setobj
->ptr
;
5201 /* We need a temp set object to store our union. If the dstkey
5202 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
5203 * this set object will be the resulting object to set into the target key*/
5204 dstset
= createSetObject();
5206 /* Iterate all the elements of all the sets, add every element a single
5207 * time to the result set */
5208 for (j
= 0; j
< setsnum
; j
++) {
5209 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
5210 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
5212 di
= dictGetIterator(dv
[j
]);
5214 while((de
= dictNext(di
)) != NULL
) {
5217 /* dictAdd will not add the same element multiple times */
5218 ele
= dictGetEntryKey(de
);
5219 if (op
== REDIS_OP_UNION
|| j
== 0) {
5220 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
5224 } else if (op
== REDIS_OP_DIFF
) {
5225 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
5230 dictReleaseIterator(di
);
5232 /* result set is empty? Exit asap. */
5233 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break;
5236 /* Output the content of the resulting set, if not in STORE mode */
5238 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
5239 di
= dictGetIterator(dstset
->ptr
);
5240 while((de
= dictNext(di
)) != NULL
) {
5243 ele
= dictGetEntryKey(de
);
5244 addReplyBulk(c
,ele
);
5246 dictReleaseIterator(di
);
5247 decrRefCount(dstset
);
5249 /* If we have a target key where to store the resulting set
5250 * create this key with the result set inside */
5251 deleteKey(c
->db
,dstkey
);
5252 if (dictSize((dict
*)dstset
->ptr
) > 0) {
5253 dictAdd(c
->db
->dict
,dstkey
,dstset
);
5254 incrRefCount(dstkey
);
5255 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
5257 decrRefCount(dstset
);
5258 addReply(c
,shared
.czero
);
5265 static void sunionCommand(redisClient
*c
) {
5266 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
5269 static void sunionstoreCommand(redisClient
*c
) {
5270 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
5273 static void sdiffCommand(redisClient
*c
) {
5274 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
5277 static void sdiffstoreCommand(redisClient
*c
) {
5278 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
5281 /* ==================================== ZSets =============================== */
5283 /* ZSETs are ordered sets using two data structures to hold the same elements
5284 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
5287 * The elements are added to an hash table mapping Redis objects to scores.
5288 * At the same time the elements are added to a skip list mapping scores
5289 * to Redis objects (so objects are sorted by scores in this "view"). */
5291 /* This skiplist implementation is almost a C translation of the original
5292 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
5293 * Alternative to Balanced Trees", modified in three ways:
5294 * a) this implementation allows for repeated values.
5295 * b) the comparison is not just by key (our 'score') but by satellite data.
5296 * c) there is a back pointer, so it's a doubly linked list with the back
5297 * pointers being only at "level 1". This allows to traverse the list
5298 * from tail to head, useful for ZREVRANGE. */
5300 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
5301 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
5303 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
5305 zn
->span
= zmalloc(sizeof(unsigned int) * (level
- 1));
5311 static zskiplist
*zslCreate(void) {
5315 zsl
= zmalloc(sizeof(*zsl
));
5318 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
5319 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++) {
5320 zsl
->header
->forward
[j
] = NULL
;
5322 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
5323 if (j
< ZSKIPLIST_MAXLEVEL
-1)
5324 zsl
->header
->span
[j
] = 0;
5326 zsl
->header
->backward
= NULL
;
5331 static void zslFreeNode(zskiplistNode
*node
) {
5332 decrRefCount(node
->obj
);
5333 zfree(node
->forward
);
5338 static void zslFree(zskiplist
*zsl
) {
5339 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
5341 zfree(zsl
->header
->forward
);
5342 zfree(zsl
->header
->span
);
5345 next
= node
->forward
[0];
5352 static int zslRandomLevel(void) {
5354 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
5356 return (level
<ZSKIPLIST_MAXLEVEL
) ? level
: ZSKIPLIST_MAXLEVEL
;
5359 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
5360 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5361 unsigned int rank
[ZSKIPLIST_MAXLEVEL
];
5365 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5366 /* store rank that is crossed to reach the insert position */
5367 rank
[i
] = i
== (zsl
->level
-1) ? 0 : rank
[i
+1];
5369 while (x
->forward
[i
] &&
5370 (x
->forward
[i
]->score
< score
||
5371 (x
->forward
[i
]->score
== score
&&
5372 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0))) {
5373 rank
[i
] += i
> 0 ? x
->span
[i
-1] : 1;
5378 /* we assume the key is not already inside, since we allow duplicated
5379 * scores, and the re-insertion of score and redis object should never
5380 * happpen since the caller of zslInsert() should test in the hash table
5381 * if the element is already inside or not. */
5382 level
= zslRandomLevel();
5383 if (level
> zsl
->level
) {
5384 for (i
= zsl
->level
; i
< level
; i
++) {
5386 update
[i
] = zsl
->header
;
5387 update
[i
]->span
[i
-1] = zsl
->length
;
5391 x
= zslCreateNode(level
,score
,obj
);
5392 for (i
= 0; i
< level
; i
++) {
5393 x
->forward
[i
] = update
[i
]->forward
[i
];
5394 update
[i
]->forward
[i
] = x
;
5396 /* update span covered by update[i] as x is inserted here */
5398 x
->span
[i
-1] = update
[i
]->span
[i
-1] - (rank
[0] - rank
[i
]);
5399 update
[i
]->span
[i
-1] = (rank
[0] - rank
[i
]) + 1;
5403 /* increment span for untouched levels */
5404 for (i
= level
; i
< zsl
->level
; i
++) {
5405 update
[i
]->span
[i
-1]++;
5408 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
5410 x
->forward
[0]->backward
= x
;
5416 /* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank */
5417 void zslDeleteNode(zskiplist
*zsl
, zskiplistNode
*x
, zskiplistNode
**update
) {
5419 for (i
= 0; i
< zsl
->level
; i
++) {
5420 if (update
[i
]->forward
[i
] == x
) {
5422 update
[i
]->span
[i
-1] += x
->span
[i
-1] - 1;
5424 update
[i
]->forward
[i
] = x
->forward
[i
];
5426 /* invariant: i > 0, because update[0]->forward[0]
5427 * is always equal to x */
5428 update
[i
]->span
[i
-1] -= 1;
5431 if (x
->forward
[0]) {
5432 x
->forward
[0]->backward
= x
->backward
;
5434 zsl
->tail
= x
->backward
;
5436 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
5441 /* Delete an element with matching score/object from the skiplist. */
5442 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
5443 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5447 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5448 while (x
->forward
[i
] &&
5449 (x
->forward
[i
]->score
< score
||
5450 (x
->forward
[i
]->score
== score
&&
5451 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
5455 /* We may have multiple elements with the same score, what we need
5456 * is to find the element with both the right score and object. */
5458 if (x
&& score
== x
->score
&& compareStringObjects(x
->obj
,obj
) == 0) {
5459 zslDeleteNode(zsl
, x
, update
);
5463 return 0; /* not found */
5465 return 0; /* not found */
5468 /* Delete all the elements with score between min and max from the skiplist.
5469 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
5470 * Note that this function takes the reference to the hash table view of the
5471 * sorted set, in order to remove the elements from the hash table too. */
5472 static unsigned long zslDeleteRangeByScore(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
5473 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5474 unsigned long removed
= 0;
5478 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5479 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
5483 /* We may have multiple elements with the same score, what we need
5484 * is to find the element with both the right score and object. */
5486 while (x
&& x
->score
<= max
) {
5487 zskiplistNode
*next
= x
->forward
[0];
5488 zslDeleteNode(zsl
, x
, update
);
5489 dictDelete(dict
,x
->obj
);
5494 return removed
; /* not found */
5497 /* Delete all the elements with rank between start and end from the skiplist.
5498 * Start and end are inclusive. Note that start and end need to be 1-based */
5499 static unsigned long zslDeleteRangeByRank(zskiplist
*zsl
, unsigned int start
, unsigned int end
, dict
*dict
) {
5500 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5501 unsigned long traversed
= 0, removed
= 0;
5505 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5506 while (x
->forward
[i
] && (traversed
+ (i
> 0 ? x
->span
[i
-1] : 1)) < start
) {
5507 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5515 while (x
&& traversed
<= end
) {
5516 zskiplistNode
*next
= x
->forward
[0];
5517 zslDeleteNode(zsl
, x
, update
);
5518 dictDelete(dict
,x
->obj
);
5527 /* Find the first node having a score equal or greater than the specified one.
5528 * Returns NULL if there is no match. */
5529 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
5534 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5535 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
5538 /* We may have multiple elements with the same score, what we need
5539 * is to find the element with both the right score and object. */
5540 return x
->forward
[0];
5543 /* Find the rank for an element by both score and key.
5544 * Returns 0 when the element cannot be found, rank otherwise.
5545 * Note that the rank is 1-based due to the span of zsl->header to the
5547 static unsigned long zslGetRank(zskiplist
*zsl
, double score
, robj
*o
) {
5549 unsigned long rank
= 0;
5553 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5554 while (x
->forward
[i
] &&
5555 (x
->forward
[i
]->score
< score
||
5556 (x
->forward
[i
]->score
== score
&&
5557 compareStringObjects(x
->forward
[i
]->obj
,o
) <= 0))) {
5558 rank
+= i
> 0 ? x
->span
[i
-1] : 1;
5562 /* x might be equal to zsl->header, so test if obj is non-NULL */
5563 if (x
->obj
&& compareStringObjects(x
->obj
,o
) == 0) {
5570 /* Finds an element by its rank. The rank argument needs to be 1-based. */
5571 zskiplistNode
* zslGetElementByRank(zskiplist
*zsl
, unsigned long rank
) {
5573 unsigned long traversed
= 0;
5577 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5578 while (x
->forward
[i
] && (traversed
+ (i
>0 ? x
->span
[i
-1] : 1)) <= rank
)
5580 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5583 if (traversed
== rank
) {
5590 /* The actual Z-commands implementations */
5592 /* This generic command implements both ZADD and ZINCRBY.
5593 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
5594 * the increment if the operation is a ZINCRBY (doincrement == 1). */
5595 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
5600 zsetobj
= lookupKeyWrite(c
->db
,key
);
5601 if (zsetobj
== NULL
) {
5602 zsetobj
= createZsetObject();
5603 dictAdd(c
->db
->dict
,key
,zsetobj
);
5606 if (zsetobj
->type
!= REDIS_ZSET
) {
5607 addReply(c
,shared
.wrongtypeerr
);
5613 /* Ok now since we implement both ZADD and ZINCRBY here the code
5614 * needs to handle the two different conditions. It's all about setting
5615 * '*score', that is, the new score to set, to the right value. */
5616 score
= zmalloc(sizeof(double));
5620 /* Read the old score. If the element was not present starts from 0 */
5621 de
= dictFind(zs
->dict
,ele
);
5623 double *oldscore
= dictGetEntryVal(de
);
5624 *score
= *oldscore
+ scoreval
;
5632 /* What follows is a simple remove and re-insert operation that is common
5633 * to both ZADD and ZINCRBY... */
5634 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
5635 /* case 1: New element */
5636 incrRefCount(ele
); /* added to hash */
5637 zslInsert(zs
->zsl
,*score
,ele
);
5638 incrRefCount(ele
); /* added to skiplist */
5641 addReplyDouble(c
,*score
);
5643 addReply(c
,shared
.cone
);
5648 /* case 2: Score update operation */
5649 de
= dictFind(zs
->dict
,ele
);
5650 redisAssert(de
!= NULL
);
5651 oldscore
= dictGetEntryVal(de
);
5652 if (*score
!= *oldscore
) {
5655 /* Remove and insert the element in the skip list with new score */
5656 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
5657 redisAssert(deleted
!= 0);
5658 zslInsert(zs
->zsl
,*score
,ele
);
5660 /* Update the score in the hash table */
5661 dictReplace(zs
->dict
,ele
,score
);
5667 addReplyDouble(c
,*score
);
5669 addReply(c
,shared
.czero
);
5673 static void zaddCommand(redisClient
*c
) {
5676 if (getDoubleFromObjectOrReply(c
, c
->argv
[2], &scoreval
, NULL
) != REDIS_OK
) return;
5677 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
5680 static void zincrbyCommand(redisClient
*c
) {
5683 if (getDoubleFromObjectOrReply(c
, c
->argv
[2], &scoreval
, NULL
) != REDIS_OK
) return;
5684 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
5687 static void zremCommand(redisClient
*c
) {
5694 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5695 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5698 de
= dictFind(zs
->dict
,c
->argv
[2]);
5700 addReply(c
,shared
.czero
);
5703 /* Delete from the skiplist */
5704 oldscore
= dictGetEntryVal(de
);
5705 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
5706 redisAssert(deleted
!= 0);
5708 /* Delete from the hash table */
5709 dictDelete(zs
->dict
,c
->argv
[2]);
5710 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5711 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5713 addReply(c
,shared
.cone
);
5716 static void zremrangebyscoreCommand(redisClient
*c
) {
5723 if ((getDoubleFromObjectOrReply(c
, c
->argv
[2], &min
, NULL
) != REDIS_OK
) ||
5724 (getDoubleFromObjectOrReply(c
, c
->argv
[3], &max
, NULL
) != REDIS_OK
)) return;
5726 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5727 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5730 deleted
= zslDeleteRangeByScore(zs
->zsl
,min
,max
,zs
->dict
);
5731 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5732 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5733 server
.dirty
+= deleted
;
5734 addReplyLong(c
,deleted
);
5737 static void zremrangebyrankCommand(redisClient
*c
) {
5745 if ((getLongFromObjectOrReply(c
, c
->argv
[2], &start
, NULL
) != REDIS_OK
) ||
5746 (getLongFromObjectOrReply(c
, c
->argv
[3], &end
, NULL
) != REDIS_OK
)) return;
5748 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5749 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5751 llen
= zs
->zsl
->length
;
5753 /* convert negative indexes */
5754 if (start
< 0) start
= llen
+start
;
5755 if (end
< 0) end
= llen
+end
;
5756 if (start
< 0) start
= 0;
5757 if (end
< 0) end
= 0;
5759 /* indexes sanity checks */
5760 if (start
> end
|| start
>= llen
) {
5761 addReply(c
,shared
.czero
);
5764 if (end
>= llen
) end
= llen
-1;
5766 /* increment start and end because zsl*Rank functions
5767 * use 1-based rank */
5768 deleted
= zslDeleteRangeByRank(zs
->zsl
,start
+1,end
+1,zs
->dict
);
5769 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5770 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5771 server
.dirty
+= deleted
;
5772 addReplyLong(c
, deleted
);
5780 static int qsortCompareZsetopsrcByCardinality(const void *s1
, const void *s2
) {
5781 zsetopsrc
*d1
= (void*) s1
, *d2
= (void*) s2
;
5782 unsigned long size1
, size2
;
5783 size1
= d1
->dict
? dictSize(d1
->dict
) : 0;
5784 size2
= d2
->dict
? dictSize(d2
->dict
) : 0;
5785 return size1
- size2
;
5788 #define REDIS_AGGR_SUM 1
5789 #define REDIS_AGGR_MIN 2
5790 #define REDIS_AGGR_MAX 3
5792 inline static void zunionInterAggregate(double *target
, double val
, int aggregate
) {
5793 if (aggregate
== REDIS_AGGR_SUM
) {
5794 *target
= *target
+ val
;
5795 } else if (aggregate
== REDIS_AGGR_MIN
) {
5796 *target
= val
< *target
? val
: *target
;
5797 } else if (aggregate
== REDIS_AGGR_MAX
) {
5798 *target
= val
> *target
? val
: *target
;
5801 redisPanic("Unknown ZUNION/INTER aggregate type");
5805 static void zunionInterGenericCommand(redisClient
*c
, robj
*dstkey
, int op
) {
5807 int aggregate
= REDIS_AGGR_SUM
;
5814 /* expect zsetnum input keys to be given */
5815 zsetnum
= atoi(c
->argv
[2]->ptr
);
5817 addReplySds(c
,sdsnew("-ERR at least 1 input key is needed for ZUNION/ZINTER\r\n"));
5821 /* test if the expected number of keys would overflow */
5822 if (3+zsetnum
> c
->argc
) {
5823 addReply(c
,shared
.syntaxerr
);
5827 /* read keys to be used for input */
5828 src
= zmalloc(sizeof(zsetopsrc
) * zsetnum
);
5829 for (i
= 0, j
= 3; i
< zsetnum
; i
++, j
++) {
5830 robj
*zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
5834 if (zsetobj
->type
!= REDIS_ZSET
) {
5836 addReply(c
,shared
.wrongtypeerr
);
5839 src
[i
].dict
= ((zset
*)zsetobj
->ptr
)->dict
;
5842 /* default all weights to 1 */
5843 src
[i
].weight
= 1.0;
5846 /* parse optional extra arguments */
5848 int remaining
= c
->argc
- j
;
5851 if (remaining
>= (zsetnum
+ 1) && !strcasecmp(c
->argv
[j
]->ptr
,"weights")) {
5853 for (i
= 0; i
< zsetnum
; i
++, j
++, remaining
--) {
5854 if (getDoubleFromObjectOrReply(c
, c
->argv
[j
], &src
[i
].weight
, NULL
) != REDIS_OK
)
5857 } else if (remaining
>= 2 && !strcasecmp(c
->argv
[j
]->ptr
,"aggregate")) {
5859 if (!strcasecmp(c
->argv
[j
]->ptr
,"sum")) {
5860 aggregate
= REDIS_AGGR_SUM
;
5861 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"min")) {
5862 aggregate
= REDIS_AGGR_MIN
;
5863 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"max")) {
5864 aggregate
= REDIS_AGGR_MAX
;
5867 addReply(c
,shared
.syntaxerr
);
5873 addReply(c
,shared
.syntaxerr
);
5879 /* sort sets from the smallest to largest, this will improve our
5880 * algorithm's performance */
5881 qsort(src
,zsetnum
,sizeof(zsetopsrc
), qsortCompareZsetopsrcByCardinality
);
5883 dstobj
= createZsetObject();
5884 dstzset
= dstobj
->ptr
;
5886 if (op
== REDIS_OP_INTER
) {
5887 /* skip going over all entries if the smallest zset is NULL or empty */
5888 if (src
[0].dict
&& dictSize(src
[0].dict
) > 0) {
5889 /* precondition: as src[0].dict is non-empty and the zsets are ordered
5890 * from small to large, all src[i > 0].dict are non-empty too */
5891 di
= dictGetIterator(src
[0].dict
);
5892 while((de
= dictNext(di
)) != NULL
) {
5893 double *score
= zmalloc(sizeof(double)), value
;
5894 *score
= src
[0].weight
* (*(double*)dictGetEntryVal(de
));
5896 for (j
= 1; j
< zsetnum
; j
++) {
5897 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5899 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5900 zunionInterAggregate(score
, value
, aggregate
);
5906 /* skip entry when not present in every source dict */
5910 robj
*o
= dictGetEntryKey(de
);
5911 dictAdd(dstzset
->dict
,o
,score
);
5912 incrRefCount(o
); /* added to dictionary */
5913 zslInsert(dstzset
->zsl
,*score
,o
);
5914 incrRefCount(o
); /* added to skiplist */
5917 dictReleaseIterator(di
);
5919 } else if (op
== REDIS_OP_UNION
) {
5920 for (i
= 0; i
< zsetnum
; i
++) {
5921 if (!src
[i
].dict
) continue;
5923 di
= dictGetIterator(src
[i
].dict
);
5924 while((de
= dictNext(di
)) != NULL
) {
5925 /* skip key when already processed */
5926 if (dictFind(dstzset
->dict
,dictGetEntryKey(de
)) != NULL
) continue;
5928 double *score
= zmalloc(sizeof(double)), value
;
5929 *score
= src
[i
].weight
* (*(double*)dictGetEntryVal(de
));
5931 /* because the zsets are sorted by size, its only possible
5932 * for sets at larger indices to hold this entry */
5933 for (j
= (i
+1); j
< zsetnum
; j
++) {
5934 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5936 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5937 zunionInterAggregate(score
, value
, aggregate
);
5941 robj
*o
= dictGetEntryKey(de
);
5942 dictAdd(dstzset
->dict
,o
,score
);
5943 incrRefCount(o
); /* added to dictionary */
5944 zslInsert(dstzset
->zsl
,*score
,o
);
5945 incrRefCount(o
); /* added to skiplist */
5947 dictReleaseIterator(di
);
5950 /* unknown operator */
5951 redisAssert(op
== REDIS_OP_INTER
|| op
== REDIS_OP_UNION
);
5954 deleteKey(c
->db
,dstkey
);
5955 if (dstzset
->zsl
->length
) {
5956 dictAdd(c
->db
->dict
,dstkey
,dstobj
);
5957 incrRefCount(dstkey
);
5958 addReplyLong(c
, dstzset
->zsl
->length
);
5961 decrRefCount(dstobj
);
5962 addReply(c
, shared
.czero
);
5967 static void zunionCommand(redisClient
*c
) {
5968 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_UNION
);
5971 static void zinterCommand(redisClient
*c
) {
5972 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_INTER
);
5975 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
5987 if ((getLongFromObjectOrReply(c
, c
->argv
[2], &start
, NULL
) != REDIS_OK
) ||
5988 (getLongFromObjectOrReply(c
, c
->argv
[3], &end
, NULL
) != REDIS_OK
)) return;
5990 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
5992 } else if (c
->argc
>= 5) {
5993 addReply(c
,shared
.syntaxerr
);
5997 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
5998 || checkType(c
,o
,REDIS_ZSET
)) return;
6003 /* convert negative indexes */
6004 if (start
< 0) start
= llen
+start
;
6005 if (end
< 0) end
= llen
+end
;
6006 if (start
< 0) start
= 0;
6007 if (end
< 0) end
= 0;
6009 /* indexes sanity checks */
6010 if (start
> end
|| start
>= llen
) {
6011 /* Out of range start or start > end result in empty list */
6012 addReply(c
,shared
.emptymultibulk
);
6015 if (end
>= llen
) end
= llen
-1;
6016 rangelen
= (end
-start
)+1;
6018 /* check if starting point is trivial, before searching
6019 * the element in log(N) time */
6021 ln
= start
== 0 ? zsl
->tail
: zslGetElementByRank(zsl
, llen
-start
);
6024 zsl
->header
->forward
[0] : zslGetElementByRank(zsl
, start
+1);
6027 /* Return the result in form of a multi-bulk reply */
6028 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
6029 withscores
? (rangelen
*2) : rangelen
));
6030 for (j
= 0; j
< rangelen
; j
++) {
6032 addReplyBulk(c
,ele
);
6034 addReplyDouble(c
,ln
->score
);
6035 ln
= reverse
? ln
->backward
: ln
->forward
[0];
6039 static void zrangeCommand(redisClient
*c
) {
6040 zrangeGenericCommand(c
,0);
6043 static void zrevrangeCommand(redisClient
*c
) {
6044 zrangeGenericCommand(c
,1);
6047 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
6048 * If justcount is non-zero, just the count is returned. */
6049 static void genericZrangebyscoreCommand(redisClient
*c
, int justcount
) {
6052 int minex
= 0, maxex
= 0; /* are min or max exclusive? */
6053 int offset
= 0, limit
= -1;
6057 /* Parse the min-max interval. If one of the values is prefixed
6058 * by the "(" character, it's considered "open". For instance
6059 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
6060 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
6061 if (((char*)c
->argv
[2]->ptr
)[0] == '(') {
6062 min
= strtod((char*)c
->argv
[2]->ptr
+1,NULL
);
6065 min
= strtod(c
->argv
[2]->ptr
,NULL
);
6067 if (((char*)c
->argv
[3]->ptr
)[0] == '(') {
6068 max
= strtod((char*)c
->argv
[3]->ptr
+1,NULL
);
6071 max
= strtod(c
->argv
[3]->ptr
,NULL
);
6074 /* Parse "WITHSCORES": note that if the command was called with
6075 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
6076 * enter the following paths to parse WITHSCORES and LIMIT. */
6077 if (c
->argc
== 5 || c
->argc
== 8) {
6078 if (strcasecmp(c
->argv
[c
->argc
-1]->ptr
,"withscores") == 0)
6083 if (c
->argc
!= (4 + withscores
) && c
->argc
!= (7 + withscores
))
6087 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
6092 if (c
->argc
== (7 + withscores
) && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
6093 addReply(c
,shared
.syntaxerr
);
6095 } else if (c
->argc
== (7 + withscores
)) {
6096 offset
= atoi(c
->argv
[5]->ptr
);
6097 limit
= atoi(c
->argv
[6]->ptr
);
6098 if (offset
< 0) offset
= 0;
6101 /* Ok, lookup the key and get the range */
6102 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
6104 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
6106 if (o
->type
!= REDIS_ZSET
) {
6107 addReply(c
,shared
.wrongtypeerr
);
6109 zset
*zsetobj
= o
->ptr
;
6110 zskiplist
*zsl
= zsetobj
->zsl
;
6112 robj
*ele
, *lenobj
= NULL
;
6113 unsigned long rangelen
= 0;
6115 /* Get the first node with the score >= min, or with
6116 * score > min if 'minex' is true. */
6117 ln
= zslFirstWithScore(zsl
,min
);
6118 while (minex
&& ln
&& ln
->score
== min
) ln
= ln
->forward
[0];
6121 /* No element matching the speciifed interval */
6122 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
6126 /* We don't know in advance how many matching elements there
6127 * are in the list, so we push this object that will represent
6128 * the multi-bulk length in the output buffer, and will "fix"
6131 lenobj
= createObject(REDIS_STRING
,NULL
);
6133 decrRefCount(lenobj
);
6136 while(ln
&& (maxex
? (ln
->score
< max
) : (ln
->score
<= max
))) {
6139 ln
= ln
->forward
[0];
6142 if (limit
== 0) break;
6145 addReplyBulk(c
,ele
);
6147 addReplyDouble(c
,ln
->score
);
6149 ln
= ln
->forward
[0];
6151 if (limit
> 0) limit
--;
6154 addReplyLong(c
,(long)rangelen
);
6156 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",
6157 withscores
? (rangelen
*2) : rangelen
);
6163 static void zrangebyscoreCommand(redisClient
*c
) {
6164 genericZrangebyscoreCommand(c
,0);
6167 static void zcountCommand(redisClient
*c
) {
6168 genericZrangebyscoreCommand(c
,1);
6171 static void zcardCommand(redisClient
*c
) {
6175 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6176 checkType(c
,o
,REDIS_ZSET
)) return;
6179 addReplyUlong(c
,zs
->zsl
->length
);
6182 static void zscoreCommand(redisClient
*c
) {
6187 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6188 checkType(c
,o
,REDIS_ZSET
)) return;
6191 de
= dictFind(zs
->dict
,c
->argv
[2]);
6193 addReply(c
,shared
.nullbulk
);
6195 double *score
= dictGetEntryVal(de
);
6197 addReplyDouble(c
,*score
);
6201 static void zrankGenericCommand(redisClient
*c
, int reverse
) {
6209 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6210 checkType(c
,o
,REDIS_ZSET
)) return;
6214 de
= dictFind(zs
->dict
,c
->argv
[2]);
6216 addReply(c
,shared
.nullbulk
);
6220 score
= dictGetEntryVal(de
);
6221 rank
= zslGetRank(zsl
, *score
, c
->argv
[2]);
6224 addReplyLong(c
, zsl
->length
- rank
);
6226 addReplyLong(c
, rank
-1);
6229 addReply(c
,shared
.nullbulk
);
6233 static void zrankCommand(redisClient
*c
) {
6234 zrankGenericCommand(c
, 0);
6237 static void zrevrankCommand(redisClient
*c
) {
6238 zrankGenericCommand(c
, 1);
6241 /* ========================= Hashes utility functions ======================= */
6242 #define REDIS_HASH_KEY 1
6243 #define REDIS_HASH_VALUE 2
6245 /* Check the length of a number of objects to see if we need to convert a
6246 * zipmap to a real hash. Note that we only check string encoded objects
6247 * as their string length can be queried in constant time. */
6248 static void hashTryConversion(robj
*subject
, robj
**argv
, int start
, int end
) {
6250 if (subject
->encoding
!= REDIS_ENCODING_ZIPMAP
) return;
6252 for (i
= start
; i
<= end
; i
++) {
6253 if (argv
[i
]->encoding
== REDIS_ENCODING_RAW
&&
6254 sdslen(argv
[i
]->ptr
) > server
.hash_max_zipmap_value
)
6256 convertToRealHash(subject
);
6262 /* Encode given objects in-place when the hash uses a dict. */
6263 static void hashTryObjectEncoding(robj
*subject
, robj
**o1
, robj
**o2
) {
6264 if (subject
->encoding
== REDIS_ENCODING_HT
) {
6265 if (o1
) *o1
= tryObjectEncoding(*o1
);
6266 if (o2
) *o2
= tryObjectEncoding(*o2
);
6270 /* Get the value from a hash identified by key. Returns either a string
6271 * object or NULL if the value cannot be found. The refcount of the object
6272 * is always increased by 1 when the value was found. */
6273 static robj
*hashGet(robj
*o
, robj
*key
) {
6275 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6278 key
= getDecodedObject(key
);
6279 if (zipmapGet(o
->ptr
,key
->ptr
,sdslen(key
->ptr
),&v
,&vlen
)) {
6280 value
= createStringObject((char*)v
,vlen
);
6284 dictEntry
*de
= dictFind(o
->ptr
,key
);
6286 value
= dictGetEntryVal(de
);
6287 incrRefCount(value
);
6293 /* Test if the key exists in the given hash. Returns 1 if the key
6294 * exists and 0 when it doesn't. */
6295 static int hashExists(robj
*o
, robj
*key
) {
6296 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6297 key
= getDecodedObject(key
);
6298 if (zipmapExists(o
->ptr
,key
->ptr
,sdslen(key
->ptr
))) {
6304 if (dictFind(o
->ptr
,key
) != NULL
) {
6311 /* Add an element, discard the old if the key already exists.
6312 * Return 0 on insert and 1 on update. */
6313 static int hashSet(robj
*o
, robj
*key
, robj
*value
) {
6315 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6316 key
= getDecodedObject(key
);
6317 value
= getDecodedObject(value
);
6318 o
->ptr
= zipmapSet(o
->ptr
,
6319 key
->ptr
,sdslen(key
->ptr
),
6320 value
->ptr
,sdslen(value
->ptr
), &update
);
6322 decrRefCount(value
);
6324 /* Check if the zipmap needs to be upgraded to a real hash table */
6325 if (zipmapLen(o
->ptr
) > server
.hash_max_zipmap_entries
)
6326 convertToRealHash(o
);
6328 if (dictReplace(o
->ptr
,key
,value
)) {
6335 incrRefCount(value
);
6340 /* Delete an element from a hash.
6341 * Return 1 on deleted and 0 on not found. */
6342 static int hashDelete(robj
*o
, robj
*key
) {
6344 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6345 key
= getDecodedObject(key
);
6346 o
->ptr
= zipmapDel(o
->ptr
,key
->ptr
,sdslen(key
->ptr
), &deleted
);
6349 deleted
= dictDelete((dict
*)o
->ptr
,key
) == DICT_OK
;
6350 /* Always check if the dictionary needs a resize after a delete. */
6351 if (deleted
&& htNeedsResize(o
->ptr
)) dictResize(o
->ptr
);
6356 /* Return the number of elements in a hash. */
6357 static unsigned long hashLength(robj
*o
) {
6358 return (o
->encoding
== REDIS_ENCODING_ZIPMAP
) ?
6359 zipmapLen((unsigned char*)o
->ptr
) : dictSize((dict
*)o
->ptr
);
6362 /* Structure to hold hash iteration abstration. Note that iteration over
6363 * hashes involves both fields and values. Because it is possible that
6364 * not both are required, store pointers in the iterator to avoid
6365 * unnecessary memory allocation for fields/values. */
6369 unsigned char *zk
, *zv
;
6370 unsigned int zklen
, zvlen
;
6376 static hashIterator
*hashInitIterator(robj
*subject
) {
6377 hashIterator
*hi
= zmalloc(sizeof(hashIterator
));
6378 hi
->encoding
= subject
->encoding
;
6379 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6380 hi
->zi
= zipmapRewind(subject
->ptr
);
6381 } else if (hi
->encoding
== REDIS_ENCODING_HT
) {
6382 hi
->di
= dictGetIterator(subject
->ptr
);
6389 static void hashReleaseIterator(hashIterator
*hi
) {
6390 if (hi
->encoding
== REDIS_ENCODING_HT
) {
6391 dictReleaseIterator(hi
->di
);
6396 /* Move to the next entry in the hash. Return REDIS_OK when the next entry
6397 * could be found and REDIS_ERR when the iterator reaches the end. */
6398 static int hashNext(hashIterator
*hi
) {
6399 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6400 if ((hi
->zi
= zipmapNext(hi
->zi
, &hi
->zk
, &hi
->zklen
,
6401 &hi
->zv
, &hi
->zvlen
)) == NULL
) return REDIS_ERR
;
6403 if ((hi
->de
= dictNext(hi
->di
)) == NULL
) return REDIS_ERR
;
6408 /* Get key or value object at current iteration position.
6409 * This increases the refcount of the field object by 1. */
6410 static robj
*hashCurrent(hashIterator
*hi
, int what
) {
6412 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6413 if (what
& REDIS_HASH_KEY
) {
6414 o
= createStringObject((char*)hi
->zk
,hi
->zklen
);
6416 o
= createStringObject((char*)hi
->zv
,hi
->zvlen
);
6419 if (what
& REDIS_HASH_KEY
) {
6420 o
= dictGetEntryKey(hi
->de
);
6422 o
= dictGetEntryVal(hi
->de
);
6429 static robj
*hashLookupWriteOrCreate(redisClient
*c
, robj
*key
) {
6430 robj
*o
= lookupKeyWrite(c
->db
,key
);
6432 o
= createHashObject();
6433 dictAdd(c
->db
->dict
,key
,o
);
6436 if (o
->type
!= REDIS_HASH
) {
6437 addReply(c
,shared
.wrongtypeerr
);
6444 /* ============================= Hash commands ============================== */
6445 static void hsetCommand(redisClient
*c
) {
6449 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6450 hashTryConversion(o
,c
->argv
,2,3);
6451 hashTryObjectEncoding(o
,&c
->argv
[2], &c
->argv
[3]);
6452 update
= hashSet(o
,c
->argv
[2],c
->argv
[3]);
6453 addReply(c
, update
? shared
.czero
: shared
.cone
);
6457 static void hsetnxCommand(redisClient
*c
) {
6459 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6460 hashTryConversion(o
,c
->argv
,2,3);
6462 if (hashExists(o
, c
->argv
[2])) {
6463 addReply(c
, shared
.czero
);
6465 hashTryObjectEncoding(o
,&c
->argv
[2], &c
->argv
[3]);
6466 hashSet(o
,c
->argv
[2],c
->argv
[3]);
6467 addReply(c
, shared
.cone
);
6472 static void hmsetCommand(redisClient
*c
) {
6476 if ((c
->argc
% 2) == 1) {
6477 addReplySds(c
,sdsnew("-ERR wrong number of arguments for HMSET\r\n"));
6481 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6482 hashTryConversion(o
,c
->argv
,2,c
->argc
-1);
6483 for (i
= 2; i
< c
->argc
; i
+= 2) {
6484 hashTryObjectEncoding(o
,&c
->argv
[i
], &c
->argv
[i
+1]);
6485 hashSet(o
,c
->argv
[i
],c
->argv
[i
+1]);
6487 addReply(c
, shared
.ok
);
6491 static void hincrbyCommand(redisClient
*c
) {
6492 long long value
, incr
;
6493 robj
*o
, *current
, *new;
6495 if (getLongLongFromObjectOrReply(c
,c
->argv
[3],&incr
,NULL
) != REDIS_OK
) return;
6496 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6497 if ((current
= hashGet(o
,c
->argv
[2])) != NULL
) {
6498 if (getLongLongFromObjectOrReply(c
,current
,&value
,
6499 "hash value is not an integer") != REDIS_OK
) {
6500 decrRefCount(current
);
6503 decrRefCount(current
);
6509 new = createStringObjectFromLongLong(value
);
6510 hashTryObjectEncoding(o
,&c
->argv
[2],NULL
);
6511 hashSet(o
,c
->argv
[2],new);
6513 addReplyLongLong(c
,value
);
6517 static void hgetCommand(redisClient
*c
) {
6519 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6520 checkType(c
,o
,REDIS_HASH
)) return;
6522 if ((value
= hashGet(o
,c
->argv
[2])) != NULL
) {
6523 addReplyBulk(c
,value
);
6524 decrRefCount(value
);
6526 addReply(c
,shared
.nullbulk
);
6530 static void hmgetCommand(redisClient
*c
) {
6533 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
6534 if (o
!= NULL
&& o
->type
!= REDIS_HASH
) {
6535 addReply(c
,shared
.wrongtypeerr
);
6538 /* Note the check for o != NULL happens inside the loop. This is
6539 * done because objects that cannot be found are considered to be
6540 * an empty hash. The reply should then be a series of NULLs. */
6541 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-2));
6542 for (i
= 2; i
< c
->argc
; i
++) {
6543 if (o
!= NULL
&& (value
= hashGet(o
,c
->argv
[i
])) != NULL
) {
6544 addReplyBulk(c
,value
);
6545 decrRefCount(value
);
6547 addReply(c
,shared
.nullbulk
);
6552 static void hdelCommand(redisClient
*c
) {
6554 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6555 checkType(c
,o
,REDIS_HASH
)) return;
6557 if (hashDelete(o
,c
->argv
[2])) {
6558 if (hashLength(o
) == 0) deleteKey(c
->db
,c
->argv
[1]);
6559 addReply(c
,shared
.cone
);
6562 addReply(c
,shared
.czero
);
6566 static void hlenCommand(redisClient
*c
) {
6568 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6569 checkType(c
,o
,REDIS_HASH
)) return;
6571 addReplyUlong(c
,hashLength(o
));
6574 static void genericHgetallCommand(redisClient
*c
, int flags
) {
6575 robj
*o
, *lenobj
, *obj
;
6576 unsigned long count
= 0;
6579 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
6580 || checkType(c
,o
,REDIS_HASH
)) return;
6582 lenobj
= createObject(REDIS_STRING
,NULL
);
6584 decrRefCount(lenobj
);
6586 hi
= hashInitIterator(o
);
6587 while (hashNext(hi
) != REDIS_ERR
) {
6588 if (flags
& REDIS_HASH_KEY
) {
6589 obj
= hashCurrent(hi
,REDIS_HASH_KEY
);
6590 addReplyBulk(c
,obj
);
6594 if (flags
& REDIS_HASH_VALUE
) {
6595 obj
= hashCurrent(hi
,REDIS_HASH_VALUE
);
6596 addReplyBulk(c
,obj
);
6601 hashReleaseIterator(hi
);
6603 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",count
);
6606 static void hkeysCommand(redisClient
*c
) {
6607 genericHgetallCommand(c
,REDIS_HASH_KEY
);
6610 static void hvalsCommand(redisClient
*c
) {
6611 genericHgetallCommand(c
,REDIS_HASH_VALUE
);
6614 static void hgetallCommand(redisClient
*c
) {
6615 genericHgetallCommand(c
,REDIS_HASH_KEY
|REDIS_HASH_VALUE
);
6618 static void hexistsCommand(redisClient
*c
) {
6620 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6621 checkType(c
,o
,REDIS_HASH
)) return;
6623 addReply(c
, hashExists(o
,c
->argv
[2]) ? shared
.cone
: shared
.czero
);
6626 static void convertToRealHash(robj
*o
) {
6627 unsigned char *key
, *val
, *p
, *zm
= o
->ptr
;
6628 unsigned int klen
, vlen
;
6629 dict
*dict
= dictCreate(&hashDictType
,NULL
);
6631 assert(o
->type
== REDIS_HASH
&& o
->encoding
!= REDIS_ENCODING_HT
);
6632 p
= zipmapRewind(zm
);
6633 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
6634 robj
*keyobj
, *valobj
;
6636 keyobj
= createStringObject((char*)key
,klen
);
6637 valobj
= createStringObject((char*)val
,vlen
);
6638 keyobj
= tryObjectEncoding(keyobj
);
6639 valobj
= tryObjectEncoding(valobj
);
6640 dictAdd(dict
,keyobj
,valobj
);
6642 o
->encoding
= REDIS_ENCODING_HT
;
6647 /* ========================= Non type-specific commands ==================== */
6649 static void flushdbCommand(redisClient
*c
) {
6650 server
.dirty
+= dictSize(c
->db
->dict
);
6651 dictEmpty(c
->db
->dict
);
6652 dictEmpty(c
->db
->expires
);
6653 addReply(c
,shared
.ok
);
6656 static void flushallCommand(redisClient
*c
) {
6657 server
.dirty
+= emptyDb();
6658 addReply(c
,shared
.ok
);
6659 if (server
.bgsavechildpid
!= -1) {
6660 kill(server
.bgsavechildpid
,SIGKILL
);
6661 rdbRemoveTempFile(server
.bgsavechildpid
);
6663 rdbSave(server
.dbfilename
);
6667 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
6668 redisSortOperation
*so
= zmalloc(sizeof(*so
));
6670 so
->pattern
= pattern
;
6674 /* Return the value associated to the key with a name obtained
6675 * substituting the first occurence of '*' in 'pattern' with 'subst'.
6676 * The returned object will always have its refcount increased by 1
6677 * when it is non-NULL. */
6678 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
6681 robj keyobj
, fieldobj
, *o
;
6682 int prefixlen
, sublen
, postfixlen
, fieldlen
;
6683 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
6687 char buf
[REDIS_SORTKEY_MAX
+1];
6688 } keyname
, fieldname
;
6690 /* If the pattern is "#" return the substitution object itself in order
6691 * to implement the "SORT ... GET #" feature. */
6692 spat
= pattern
->ptr
;
6693 if (spat
[0] == '#' && spat
[1] == '\0') {
6694 incrRefCount(subst
);
6698 /* The substitution object may be specially encoded. If so we create
6699 * a decoded object on the fly. Otherwise getDecodedObject will just
6700 * increment the ref count, that we'll decrement later. */
6701 subst
= getDecodedObject(subst
);
6704 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
6705 p
= strchr(spat
,'*');
6707 decrRefCount(subst
);
6711 /* Find out if we're dealing with a hash dereference. */
6712 if ((f
= strstr(p
+1, "->")) != NULL
) {
6713 fieldlen
= sdslen(spat
)-(f
-spat
);
6714 /* this also copies \0 character */
6715 memcpy(fieldname
.buf
,f
+2,fieldlen
-1);
6716 fieldname
.len
= fieldlen
-2;
6722 sublen
= sdslen(ssub
);
6723 postfixlen
= sdslen(spat
)-(prefixlen
+1)-fieldlen
;
6724 memcpy(keyname
.buf
,spat
,prefixlen
);
6725 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
6726 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
6727 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
6728 keyname
.len
= prefixlen
+sublen
+postfixlen
;
6729 decrRefCount(subst
);
6731 /* Lookup substituted key */
6732 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2));
6733 o
= lookupKeyRead(db
,&keyobj
);
6734 if (o
== NULL
) return NULL
;
6737 if (o
->type
!= REDIS_HASH
|| fieldname
.len
< 1) return NULL
;
6739 /* Retrieve value from hash by the field name. This operation
6740 * already increases the refcount of the returned object. */
6741 initStaticStringObject(fieldobj
,((char*)&fieldname
)+(sizeof(long)*2));
6742 o
= hashGet(o
, &fieldobj
);
6744 if (o
->type
!= REDIS_STRING
) return NULL
;
6746 /* Every object that this function returns needs to have its refcount
6747 * increased. sortCommand decreases it again. */
6754 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
6755 * the additional parameter is not standard but a BSD-specific we have to
6756 * pass sorting parameters via the global 'server' structure */
6757 static int sortCompare(const void *s1
, const void *s2
) {
6758 const redisSortObject
*so1
= s1
, *so2
= s2
;
6761 if (!server
.sort_alpha
) {
6762 /* Numeric sorting. Here it's trivial as we precomputed scores */
6763 if (so1
->u
.score
> so2
->u
.score
) {
6765 } else if (so1
->u
.score
< so2
->u
.score
) {
6771 /* Alphanumeric sorting */
6772 if (server
.sort_bypattern
) {
6773 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
6774 /* At least one compare object is NULL */
6775 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
6777 else if (so1
->u
.cmpobj
== NULL
)
6782 /* We have both the objects, use strcoll */
6783 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
6786 /* Compare elements directly. */
6787 cmp
= compareStringObjects(so1
->obj
,so2
->obj
);
6790 return server
.sort_desc
? -cmp
: cmp
;
6793 /* The SORT command is the most complex command in Redis. Warning: this code
6794 * is optimized for speed and a bit less for readability */
6795 static void sortCommand(redisClient
*c
) {
6798 int desc
= 0, alpha
= 0;
6799 int limit_start
= 0, limit_count
= -1, start
, end
;
6800 int j
, dontsort
= 0, vectorlen
;
6801 int getop
= 0; /* GET operation counter */
6802 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
6803 redisSortObject
*vector
; /* Resulting vector to sort */
6805 /* Lookup the key to sort. It must be of the right types */
6806 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
6807 if (sortval
== NULL
) {
6808 addReply(c
,shared
.emptymultibulk
);
6811 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
6812 sortval
->type
!= REDIS_ZSET
)
6814 addReply(c
,shared
.wrongtypeerr
);
6818 /* Create a list of operations to perform for every sorted element.
6819 * Operations can be GET/DEL/INCR/DECR */
6820 operations
= listCreate();
6821 listSetFreeMethod(operations
,zfree
);
6824 /* Now we need to protect sortval incrementing its count, in the future
6825 * SORT may have options able to overwrite/delete keys during the sorting
6826 * and the sorted key itself may get destroied */
6827 incrRefCount(sortval
);
6829 /* The SORT command has an SQL-alike syntax, parse it */
6830 while(j
< c
->argc
) {
6831 int leftargs
= c
->argc
-j
-1;
6832 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
6834 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
6836 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
6838 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
6839 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
6840 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
6842 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
6843 storekey
= c
->argv
[j
+1];
6845 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
6846 sortby
= c
->argv
[j
+1];
6847 /* If the BY pattern does not contain '*', i.e. it is constant,
6848 * we don't need to sort nor to lookup the weight keys. */
6849 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
6851 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
6852 listAddNodeTail(operations
,createSortOperation(
6853 REDIS_SORT_GET
,c
->argv
[j
+1]));
6857 decrRefCount(sortval
);
6858 listRelease(operations
);
6859 addReply(c
,shared
.syntaxerr
);
6865 /* Load the sorting vector with all the objects to sort */
6866 switch(sortval
->type
) {
6867 case REDIS_LIST
: vectorlen
= listLength((list
*)sortval
->ptr
); break;
6868 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
6869 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
6870 default: vectorlen
= 0; redisPanic("Bad SORT type"); /* Avoid GCC warning */
6872 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
6875 if (sortval
->type
== REDIS_LIST
) {
6876 list
*list
= sortval
->ptr
;
6880 listRewind(list
,&li
);
6881 while((ln
= listNext(&li
))) {
6882 robj
*ele
= ln
->value
;
6883 vector
[j
].obj
= ele
;
6884 vector
[j
].u
.score
= 0;
6885 vector
[j
].u
.cmpobj
= NULL
;
6893 if (sortval
->type
== REDIS_SET
) {
6896 zset
*zs
= sortval
->ptr
;
6900 di
= dictGetIterator(set
);
6901 while((setele
= dictNext(di
)) != NULL
) {
6902 vector
[j
].obj
= dictGetEntryKey(setele
);
6903 vector
[j
].u
.score
= 0;
6904 vector
[j
].u
.cmpobj
= NULL
;
6907 dictReleaseIterator(di
);
6909 redisAssert(j
== vectorlen
);
6911 /* Now it's time to load the right scores in the sorting vector */
6912 if (dontsort
== 0) {
6913 for (j
= 0; j
< vectorlen
; j
++) {
6916 /* lookup value to sort by */
6917 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
6918 if (!byval
) continue;
6920 /* use object itself to sort by */
6921 byval
= vector
[j
].obj
;
6925 if (sortby
) vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
6927 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
6928 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
6929 } else if (byval
->encoding
== REDIS_ENCODING_INT
) {
6930 /* Don't need to decode the object if it's
6931 * integer-encoded (the only encoding supported) so
6932 * far. We can just cast it */
6933 vector
[j
].u
.score
= (long)byval
->ptr
;
6935 redisAssert(1 != 1);
6939 /* when the object was retrieved using lookupKeyByPattern,
6940 * its refcount needs to be decreased. */
6942 decrRefCount(byval
);
6947 /* We are ready to sort the vector... perform a bit of sanity check
6948 * on the LIMIT option too. We'll use a partial version of quicksort. */
6949 start
= (limit_start
< 0) ? 0 : limit_start
;
6950 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
6951 if (start
>= vectorlen
) {
6952 start
= vectorlen
-1;
6955 if (end
>= vectorlen
) end
= vectorlen
-1;
6957 if (dontsort
== 0) {
6958 server
.sort_desc
= desc
;
6959 server
.sort_alpha
= alpha
;
6960 server
.sort_bypattern
= sortby
? 1 : 0;
6961 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
6962 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
6964 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
6967 /* Send command output to the output buffer, performing the specified
6968 * GET/DEL/INCR/DECR operations if any. */
6969 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
6970 if (storekey
== NULL
) {
6971 /* STORE option not specified, sent the sorting result to client */
6972 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
6973 for (j
= start
; j
<= end
; j
++) {
6977 if (!getop
) addReplyBulk(c
,vector
[j
].obj
);
6978 listRewind(operations
,&li
);
6979 while((ln
= listNext(&li
))) {
6980 redisSortOperation
*sop
= ln
->value
;
6981 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
6984 if (sop
->type
== REDIS_SORT_GET
) {
6986 addReply(c
,shared
.nullbulk
);
6988 addReplyBulk(c
,val
);
6992 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
6997 robj
*listObject
= createListObject();
6998 list
*listPtr
= (list
*) listObject
->ptr
;
7000 /* STORE option specified, set the sorting result as a List object */
7001 for (j
= start
; j
<= end
; j
++) {
7006 listAddNodeTail(listPtr
,vector
[j
].obj
);
7007 incrRefCount(vector
[j
].obj
);
7009 listRewind(operations
,&li
);
7010 while((ln
= listNext(&li
))) {
7011 redisSortOperation
*sop
= ln
->value
;
7012 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
7015 if (sop
->type
== REDIS_SORT_GET
) {
7017 listAddNodeTail(listPtr
,createStringObject("",0));
7019 /* We should do a incrRefCount on val because it is
7020 * added to the list, but also a decrRefCount because
7021 * it is returned by lookupKeyByPattern. This results
7022 * in doing nothing at all. */
7023 listAddNodeTail(listPtr
,val
);
7026 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
7030 if (dictReplace(c
->db
->dict
,storekey
,listObject
)) {
7031 incrRefCount(storekey
);
7033 /* Note: we add 1 because the DB is dirty anyway since even if the
7034 * SORT result is empty a new key is set and maybe the old content
7036 server
.dirty
+= 1+outputlen
;
7037 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
7041 decrRefCount(sortval
);
7042 listRelease(operations
);
7043 for (j
= 0; j
< vectorlen
; j
++) {
7044 if (alpha
&& vector
[j
].u
.cmpobj
)
7045 decrRefCount(vector
[j
].u
.cmpobj
);
7050 /* Convert an amount of bytes into a human readable string in the form
7051 * of 100B, 2G, 100M, 4K, and so forth. */
7052 static void bytesToHuman(char *s
, unsigned long long n
) {
7057 sprintf(s
,"%lluB",n
);
7059 } else if (n
< (1024*1024)) {
7060 d
= (double)n
/(1024);
7061 sprintf(s
,"%.2fK",d
);
7062 } else if (n
< (1024LL*1024*1024)) {
7063 d
= (double)n
/(1024*1024);
7064 sprintf(s
,"%.2fM",d
);
7065 } else if (n
< (1024LL*1024*1024*1024)) {
7066 d
= (double)n
/(1024LL*1024*1024);
7067 sprintf(s
,"%.2fG",d
);
7071 /* Create the string returned by the INFO command. This is decoupled
7072 * by the INFO command itself as we need to report the same information
7073 * on memory corruption problems. */
7074 static sds
genRedisInfoString(void) {
7076 time_t uptime
= time(NULL
)-server
.stat_starttime
;
7080 bytesToHuman(hmem
,zmalloc_used_memory());
7081 info
= sdscatprintf(sdsempty(),
7082 "redis_version:%s\r\n"
7084 "multiplexing_api:%s\r\n"
7085 "process_id:%ld\r\n"
7086 "uptime_in_seconds:%ld\r\n"
7087 "uptime_in_days:%ld\r\n"
7088 "connected_clients:%d\r\n"
7089 "connected_slaves:%d\r\n"
7090 "blocked_clients:%d\r\n"
7091 "used_memory:%zu\r\n"
7092 "used_memory_human:%s\r\n"
7093 "changes_since_last_save:%lld\r\n"
7094 "bgsave_in_progress:%d\r\n"
7095 "last_save_time:%ld\r\n"
7096 "bgrewriteaof_in_progress:%d\r\n"
7097 "total_connections_received:%lld\r\n"
7098 "total_commands_processed:%lld\r\n"
7099 "expired_keys:%lld\r\n"
7100 "hash_max_zipmap_entries:%ld\r\n"
7101 "hash_max_zipmap_value:%ld\r\n"
7102 "pubsub_channels:%ld\r\n"
7103 "pubsub_patterns:%u\r\n"
7107 (sizeof(long) == 8) ? "64" : "32",
7112 listLength(server
.clients
)-listLength(server
.slaves
),
7113 listLength(server
.slaves
),
7114 server
.blpop_blocked_clients
,
7115 zmalloc_used_memory(),
7118 server
.bgsavechildpid
!= -1,
7120 server
.bgrewritechildpid
!= -1,
7121 server
.stat_numconnections
,
7122 server
.stat_numcommands
,
7123 server
.stat_expiredkeys
,
7124 server
.hash_max_zipmap_entries
,
7125 server
.hash_max_zipmap_value
,
7126 dictSize(server
.pubsub_channels
),
7127 listLength(server
.pubsub_patterns
),
7128 server
.vm_enabled
!= 0,
7129 server
.masterhost
== NULL
? "master" : "slave"
7131 if (server
.masterhost
) {
7132 info
= sdscatprintf(info
,
7133 "master_host:%s\r\n"
7134 "master_port:%d\r\n"
7135 "master_link_status:%s\r\n"
7136 "master_last_io_seconds_ago:%d\r\n"
7139 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
7141 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
7144 if (server
.vm_enabled
) {
7146 info
= sdscatprintf(info
,
7147 "vm_conf_max_memory:%llu\r\n"
7148 "vm_conf_page_size:%llu\r\n"
7149 "vm_conf_pages:%llu\r\n"
7150 "vm_stats_used_pages:%llu\r\n"
7151 "vm_stats_swapped_objects:%llu\r\n"
7152 "vm_stats_swappin_count:%llu\r\n"
7153 "vm_stats_swappout_count:%llu\r\n"
7154 "vm_stats_io_newjobs_len:%lu\r\n"
7155 "vm_stats_io_processing_len:%lu\r\n"
7156 "vm_stats_io_processed_len:%lu\r\n"
7157 "vm_stats_io_active_threads:%lu\r\n"
7158 "vm_stats_blocked_clients:%lu\r\n"
7159 ,(unsigned long long) server
.vm_max_memory
,
7160 (unsigned long long) server
.vm_page_size
,
7161 (unsigned long long) server
.vm_pages
,
7162 (unsigned long long) server
.vm_stats_used_pages
,
7163 (unsigned long long) server
.vm_stats_swapped_objects
,
7164 (unsigned long long) server
.vm_stats_swapins
,
7165 (unsigned long long) server
.vm_stats_swapouts
,
7166 (unsigned long) listLength(server
.io_newjobs
),
7167 (unsigned long) listLength(server
.io_processing
),
7168 (unsigned long) listLength(server
.io_processed
),
7169 (unsigned long) server
.io_active_threads
,
7170 (unsigned long) server
.vm_blocked_clients
7174 for (j
= 0; j
< server
.dbnum
; j
++) {
7175 long long keys
, vkeys
;
7177 keys
= dictSize(server
.db
[j
].dict
);
7178 vkeys
= dictSize(server
.db
[j
].expires
);
7179 if (keys
|| vkeys
) {
7180 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
7187 static void infoCommand(redisClient
*c
) {
7188 sds info
= genRedisInfoString();
7189 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
7190 (unsigned long)sdslen(info
)));
7191 addReplySds(c
,info
);
7192 addReply(c
,shared
.crlf
);
7195 static void monitorCommand(redisClient
*c
) {
7196 /* ignore MONITOR if aleady slave or in monitor mode */
7197 if (c
->flags
& REDIS_SLAVE
) return;
7199 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
7201 listAddNodeTail(server
.monitors
,c
);
7202 addReply(c
,shared
.ok
);
7205 /* ================================= Expire ================================= */
7206 static int removeExpire(redisDb
*db
, robj
*key
) {
7207 if (dictDelete(db
->expires
,key
) == DICT_OK
) {
7214 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
7215 if (dictAdd(db
->expires
,key
,(void*)when
) == DICT_ERR
) {
7223 /* Return the expire time of the specified key, or -1 if no expire
7224 * is associated with this key (i.e. the key is non volatile) */
7225 static time_t getExpire(redisDb
*db
, robj
*key
) {
7228 /* No expire? return ASAP */
7229 if (dictSize(db
->expires
) == 0 ||
7230 (de
= dictFind(db
->expires
,key
)) == NULL
) return -1;
7232 return (time_t) dictGetEntryVal(de
);
7235 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
7239 /* No expire? return ASAP */
7240 if (dictSize(db
->expires
) == 0 ||
7241 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
7243 /* Lookup the expire */
7244 when
= (time_t) dictGetEntryVal(de
);
7245 if (time(NULL
) <= when
) return 0;
7247 /* Delete the key */
7248 dictDelete(db
->expires
,key
);
7249 server
.stat_expiredkeys
++;
7250 return dictDelete(db
->dict
,key
) == DICT_OK
;
7253 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
7256 /* No expire? return ASAP */
7257 if (dictSize(db
->expires
) == 0 ||
7258 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
7260 /* Delete the key */
7262 server
.stat_expiredkeys
++;
7263 dictDelete(db
->expires
,key
);
7264 return dictDelete(db
->dict
,key
) == DICT_OK
;
7267 static void expireGenericCommand(redisClient
*c
, robj
*key
, robj
*param
, long offset
) {
7271 if (getLongFromObjectOrReply(c
, param
, &seconds
, NULL
) != REDIS_OK
) return;
7275 de
= dictFind(c
->db
->dict
,key
);
7277 addReply(c
,shared
.czero
);
7281 if (deleteKey(c
->db
,key
)) server
.dirty
++;
7282 addReply(c
, shared
.cone
);
7285 time_t when
= time(NULL
)+seconds
;
7286 if (setExpire(c
->db
,key
,when
)) {
7287 addReply(c
,shared
.cone
);
7290 addReply(c
,shared
.czero
);
7296 static void expireCommand(redisClient
*c
) {
7297 expireGenericCommand(c
,c
->argv
[1],c
->argv
[2],0);
7300 static void expireatCommand(redisClient
*c
) {
7301 expireGenericCommand(c
,c
->argv
[1],c
->argv
[2],time(NULL
));
7304 static void ttlCommand(redisClient
*c
) {
7308 expire
= getExpire(c
->db
,c
->argv
[1]);
7310 ttl
= (int) (expire
-time(NULL
));
7311 if (ttl
< 0) ttl
= -1;
7313 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
7316 /* ================================ MULTI/EXEC ============================== */
7318 /* Client state initialization for MULTI/EXEC */
7319 static void initClientMultiState(redisClient
*c
) {
7320 c
->mstate
.commands
= NULL
;
7321 c
->mstate
.count
= 0;
7324 /* Release all the resources associated with MULTI/EXEC state */
7325 static void freeClientMultiState(redisClient
*c
) {
7328 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7330 multiCmd
*mc
= c
->mstate
.commands
+j
;
7332 for (i
= 0; i
< mc
->argc
; i
++)
7333 decrRefCount(mc
->argv
[i
]);
7336 zfree(c
->mstate
.commands
);
7339 /* Add a new command into the MULTI commands queue */
7340 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
7344 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
7345 sizeof(multiCmd
)*(c
->mstate
.count
+1));
7346 mc
= c
->mstate
.commands
+c
->mstate
.count
;
7349 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
7350 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
7351 for (j
= 0; j
< c
->argc
; j
++)
7352 incrRefCount(mc
->argv
[j
]);
7356 static void multiCommand(redisClient
*c
) {
7357 c
->flags
|= REDIS_MULTI
;
7358 addReply(c
,shared
.ok
);
7361 static void discardCommand(redisClient
*c
) {
7362 if (!(c
->flags
& REDIS_MULTI
)) {
7363 addReplySds(c
,sdsnew("-ERR DISCARD without MULTI\r\n"));
7367 freeClientMultiState(c
);
7368 initClientMultiState(c
);
7369 c
->flags
&= (~REDIS_MULTI
);
7370 addReply(c
,shared
.ok
);
7373 /* Send a MULTI command to all the slaves and AOF file. Check the execCommand
7374 * implememntation for more information. */
7375 static void execCommandReplicateMulti(redisClient
*c
) {
7376 struct redisCommand
*cmd
;
7377 robj
*multistring
= createStringObject("MULTI",5);
7379 cmd
= lookupCommand("multi");
7380 if (server
.appendonly
)
7381 feedAppendOnlyFile(cmd
,c
->db
->id
,&multistring
,1);
7382 if (listLength(server
.slaves
))
7383 replicationFeedSlaves(server
.slaves
,c
->db
->id
,&multistring
,1);
7384 decrRefCount(multistring
);
7387 static void execCommand(redisClient
*c
) {
7392 if (!(c
->flags
& REDIS_MULTI
)) {
7393 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
7397 /* Replicate a MULTI request now that we are sure the block is executed.
7398 * This way we'll deliver the MULTI/..../EXEC block as a whole and
7399 * both the AOF and the replication link will have the same consistency
7400 * and atomicity guarantees. */
7401 execCommandReplicateMulti(c
);
7403 /* Exec all the queued commands */
7404 orig_argv
= c
->argv
;
7405 orig_argc
= c
->argc
;
7406 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
7407 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7408 c
->argc
= c
->mstate
.commands
[j
].argc
;
7409 c
->argv
= c
->mstate
.commands
[j
].argv
;
7410 call(c
,c
->mstate
.commands
[j
].cmd
);
7412 c
->argv
= orig_argv
;
7413 c
->argc
= orig_argc
;
7414 freeClientMultiState(c
);
7415 initClientMultiState(c
);
7416 c
->flags
&= (~REDIS_MULTI
);
7417 /* Make sure the EXEC command is always replicated / AOF, since we
7418 * always send the MULTI command (we can't know beforehand if the
7419 * next operations will contain at least a modification to the DB). */
7423 /* =========================== Blocking Operations ========================= */
7425 /* Currently Redis blocking operations support is limited to list POP ops,
7426 * so the current implementation is not fully generic, but it is also not
7427 * completely specific so it will not require a rewrite to support new
7428 * kind of blocking operations in the future.
7430 * Still it's important to note that list blocking operations can be already
7431 * used as a notification mechanism in order to implement other blocking
7432 * operations at application level, so there must be a very strong evidence
7433 * of usefulness and generality before new blocking operations are implemented.
7435 * This is how the current blocking POP works, we use BLPOP as example:
7436 * - If the user calls BLPOP and the key exists and contains a non empty list
7437 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
7438 * if there is not to block.
7439 * - If instead BLPOP is called and the key does not exists or the list is
7440 * empty we need to block. In order to do so we remove the notification for
7441 * new data to read in the client socket (so that we'll not serve new
7442 * requests if the blocking request is not served). Also we put the client
7443 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
7444 * blocking for this keys.
7445 * - If a PUSH operation against a key with blocked clients waiting is
7446 * performed, we serve the first in the list: basically instead to push
7447 * the new element inside the list we return it to the (first / oldest)
7448 * blocking client, unblock the client, and remove it form the list.
7450 * The above comment and the source code should be enough in order to understand
7451 * the implementation and modify / fix it later.
7454 /* Set a client in blocking mode for the specified key, with the specified
7456 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
7461 c
->blockingkeys
= zmalloc(sizeof(robj
*)*numkeys
);
7462 c
->blockingkeysnum
= numkeys
;
7463 c
->blockingto
= timeout
;
7464 for (j
= 0; j
< numkeys
; j
++) {
7465 /* Add the key in the client structure, to map clients -> keys */
7466 c
->blockingkeys
[j
] = keys
[j
];
7467 incrRefCount(keys
[j
]);
7469 /* And in the other "side", to map keys -> clients */
7470 de
= dictFind(c
->db
->blockingkeys
,keys
[j
]);
7474 /* For every key we take a list of clients blocked for it */
7476 retval
= dictAdd(c
->db
->blockingkeys
,keys
[j
],l
);
7477 incrRefCount(keys
[j
]);
7478 assert(retval
== DICT_OK
);
7480 l
= dictGetEntryVal(de
);
7482 listAddNodeTail(l
,c
);
7484 /* Mark the client as a blocked client */
7485 c
->flags
|= REDIS_BLOCKED
;
7486 server
.blpop_blocked_clients
++;
7489 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
7490 static void unblockClientWaitingData(redisClient
*c
) {
7495 assert(c
->blockingkeys
!= NULL
);
7496 /* The client may wait for multiple keys, so unblock it for every key. */
7497 for (j
= 0; j
< c
->blockingkeysnum
; j
++) {
7498 /* Remove this client from the list of clients waiting for this key. */
7499 de
= dictFind(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
7501 l
= dictGetEntryVal(de
);
7502 listDelNode(l
,listSearchKey(l
,c
));
7503 /* If the list is empty we need to remove it to avoid wasting memory */
7504 if (listLength(l
) == 0)
7505 dictDelete(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
7506 decrRefCount(c
->blockingkeys
[j
]);
7508 /* Cleanup the client structure */
7509 zfree(c
->blockingkeys
);
7510 c
->blockingkeys
= NULL
;
7511 c
->flags
&= (~REDIS_BLOCKED
);
7512 server
.blpop_blocked_clients
--;
7513 /* We want to process data if there is some command waiting
7514 * in the input buffer. Note that this is safe even if
7515 * unblockClientWaitingData() gets called from freeClient() because
7516 * freeClient() will be smart enough to call this function
7517 * *after* c->querybuf was set to NULL. */
7518 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
7521 /* This should be called from any function PUSHing into lists.
7522 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
7523 * 'ele' is the element pushed.
7525 * If the function returns 0 there was no client waiting for a list push
7528 * If the function returns 1 there was a client waiting for a list push
7529 * against this key, the element was passed to this client thus it's not
7530 * needed to actually add it to the list and the caller should return asap. */
7531 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
7532 struct dictEntry
*de
;
7533 redisClient
*receiver
;
7537 de
= dictFind(c
->db
->blockingkeys
,key
);
7538 if (de
== NULL
) return 0;
7539 l
= dictGetEntryVal(de
);
7542 receiver
= ln
->value
;
7544 addReplySds(receiver
,sdsnew("*2\r\n"));
7545 addReplyBulk(receiver
,key
);
7546 addReplyBulk(receiver
,ele
);
7547 unblockClientWaitingData(receiver
);
7551 /* Blocking RPOP/LPOP */
7552 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
7557 for (j
= 1; j
< c
->argc
-1; j
++) {
7558 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
7560 if (o
->type
!= REDIS_LIST
) {
7561 addReply(c
,shared
.wrongtypeerr
);
7564 list
*list
= o
->ptr
;
7565 if (listLength(list
) != 0) {
7566 /* If the list contains elements fall back to the usual
7567 * non-blocking POP operation */
7568 robj
*argv
[2], **orig_argv
;
7571 /* We need to alter the command arguments before to call
7572 * popGenericCommand() as the command takes a single key. */
7573 orig_argv
= c
->argv
;
7574 orig_argc
= c
->argc
;
7575 argv
[1] = c
->argv
[j
];
7579 /* Also the return value is different, we need to output
7580 * the multi bulk reply header and the key name. The
7581 * "real" command will add the last element (the value)
7582 * for us. If this souds like an hack to you it's just
7583 * because it is... */
7584 addReplySds(c
,sdsnew("*2\r\n"));
7585 addReplyBulk(c
,argv
[1]);
7586 popGenericCommand(c
,where
);
7588 /* Fix the client structure with the original stuff */
7589 c
->argv
= orig_argv
;
7590 c
->argc
= orig_argc
;
7596 /* If the list is empty or the key does not exists we must block */
7597 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
7598 if (timeout
> 0) timeout
+= time(NULL
);
7599 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
7602 static void blpopCommand(redisClient
*c
) {
7603 blockingPopGenericCommand(c
,REDIS_HEAD
);
7606 static void brpopCommand(redisClient
*c
) {
7607 blockingPopGenericCommand(c
,REDIS_TAIL
);
7610 /* =============================== Replication ============================= */
7612 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7613 ssize_t nwritten
, ret
= size
;
7614 time_t start
= time(NULL
);
7618 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
7619 nwritten
= write(fd
,ptr
,size
);
7620 if (nwritten
== -1) return -1;
7624 if ((time(NULL
)-start
) > timeout
) {
7632 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7633 ssize_t nread
, totread
= 0;
7634 time_t start
= time(NULL
);
7638 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
7639 nread
= read(fd
,ptr
,size
);
7640 if (nread
== -1) return -1;
7645 if ((time(NULL
)-start
) > timeout
) {
7653 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7660 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
7663 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
7674 static void syncCommand(redisClient
*c
) {
7675 /* ignore SYNC if aleady slave or in monitor mode */
7676 if (c
->flags
& REDIS_SLAVE
) return;
7678 /* SYNC can't be issued when the server has pending data to send to
7679 * the client about already issued commands. We need a fresh reply
7680 * buffer registering the differences between the BGSAVE and the current
7681 * dataset, so that we can copy to other slaves if needed. */
7682 if (listLength(c
->reply
) != 0) {
7683 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
7687 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
7688 /* Here we need to check if there is a background saving operation
7689 * in progress, or if it is required to start one */
7690 if (server
.bgsavechildpid
!= -1) {
7691 /* Ok a background save is in progress. Let's check if it is a good
7692 * one for replication, i.e. if there is another slave that is
7693 * registering differences since the server forked to save */
7698 listRewind(server
.slaves
,&li
);
7699 while((ln
= listNext(&li
))) {
7701 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
7704 /* Perfect, the server is already registering differences for
7705 * another slave. Set the right state, and copy the buffer. */
7706 listRelease(c
->reply
);
7707 c
->reply
= listDup(slave
->reply
);
7708 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7709 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
7711 /* No way, we need to wait for the next BGSAVE in order to
7712 * register differences */
7713 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7714 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
7717 /* Ok we don't have a BGSAVE in progress, let's start one */
7718 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
7719 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7720 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
7721 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
7724 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7727 c
->flags
|= REDIS_SLAVE
;
7729 listAddNodeTail(server
.slaves
,c
);
7733 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
7734 redisClient
*slave
= privdata
;
7736 REDIS_NOTUSED(mask
);
7737 char buf
[REDIS_IOBUF_LEN
];
7738 ssize_t nwritten
, buflen
;
7740 if (slave
->repldboff
== 0) {
7741 /* Write the bulk write count before to transfer the DB. In theory here
7742 * we don't know how much room there is in the output buffer of the
7743 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
7744 * operations) will never be smaller than the few bytes we need. */
7747 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
7749 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
7757 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
7758 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
7760 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
7761 (buflen
== 0) ? "premature EOF" : strerror(errno
));
7765 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
7766 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
7771 slave
->repldboff
+= nwritten
;
7772 if (slave
->repldboff
== slave
->repldbsize
) {
7773 close(slave
->repldbfd
);
7774 slave
->repldbfd
= -1;
7775 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7776 slave
->replstate
= REDIS_REPL_ONLINE
;
7777 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
7778 sendReplyToClient
, slave
) == AE_ERR
) {
7782 addReplySds(slave
,sdsempty());
7783 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
7787 /* This function is called at the end of every backgrond saving.
7788 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
7789 * otherwise REDIS_ERR is passed to the function.
7791 * The goal of this function is to handle slaves waiting for a successful
7792 * background saving in order to perform non-blocking synchronization. */
7793 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
7795 int startbgsave
= 0;
7798 listRewind(server
.slaves
,&li
);
7799 while((ln
= listNext(&li
))) {
7800 redisClient
*slave
= ln
->value
;
7802 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
7804 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7805 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
7806 struct redis_stat buf
;
7808 if (bgsaveerr
!= REDIS_OK
) {
7810 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
7813 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
7814 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
7816 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
7819 slave
->repldboff
= 0;
7820 slave
->repldbsize
= buf
.st_size
;
7821 slave
->replstate
= REDIS_REPL_SEND_BULK
;
7822 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7823 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
7830 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7833 listRewind(server
.slaves
,&li
);
7834 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
7835 while((ln
= listNext(&li
))) {
7836 redisClient
*slave
= ln
->value
;
7838 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
7845 static int syncWithMaster(void) {
7846 char buf
[1024], tmpfile
[256], authcmd
[1024];
7848 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
7849 int dfd
, maxtries
= 5;
7852 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
7857 /* AUTH with the master if required. */
7858 if(server
.masterauth
) {
7859 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
7860 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
7862 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
7866 /* Read the AUTH result. */
7867 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7869 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
7873 if (buf
[0] != '+') {
7875 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
7880 /* Issue the SYNC command */
7881 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
7883 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
7887 /* Read the bulk write count */
7888 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7890 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
7894 if (buf
[0] != '$') {
7896 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
7899 dumpsize
= strtol(buf
+1,NULL
,10);
7900 redisLog(REDIS_NOTICE
,"Receiving %ld bytes data dump from MASTER",dumpsize
);
7901 /* Read the bulk write data on a temp file */
7903 snprintf(tmpfile
,256,
7904 "temp-%d.%ld.rdb",(int)time(NULL
),(long int)getpid());
7905 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
|O_EXCL
,0644);
7906 if (dfd
!= -1) break;
7911 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
7915 int nread
, nwritten
;
7917 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
7919 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
7925 nwritten
= write(dfd
,buf
,nread
);
7926 if (nwritten
== -1) {
7927 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
7935 if (rename(tmpfile
,server
.dbfilename
) == -1) {
7936 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
7942 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
7943 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
7947 server
.master
= createClient(fd
);
7948 server
.master
->flags
|= REDIS_MASTER
;
7949 server
.master
->authenticated
= 1;
7950 server
.replstate
= REDIS_REPL_CONNECTED
;
7954 static void slaveofCommand(redisClient
*c
) {
7955 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
7956 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
7957 if (server
.masterhost
) {
7958 sdsfree(server
.masterhost
);
7959 server
.masterhost
= NULL
;
7960 if (server
.master
) freeClient(server
.master
);
7961 server
.replstate
= REDIS_REPL_NONE
;
7962 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
7965 sdsfree(server
.masterhost
);
7966 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
7967 server
.masterport
= atoi(c
->argv
[2]->ptr
);
7968 if (server
.master
) freeClient(server
.master
);
7969 server
.replstate
= REDIS_REPL_CONNECT
;
7970 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
7971 server
.masterhost
, server
.masterport
);
7973 addReply(c
,shared
.ok
);
7976 /* ============================ Maxmemory directive ======================== */
7978 /* Try to free one object form the pre-allocated objects free list.
7979 * This is useful under low mem conditions as by default we take 1 million
7980 * free objects allocated. On success REDIS_OK is returned, otherwise
7982 static int tryFreeOneObjectFromFreelist(void) {
7985 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
7986 if (listLength(server
.objfreelist
)) {
7987 listNode
*head
= listFirst(server
.objfreelist
);
7988 o
= listNodeValue(head
);
7989 listDelNode(server
.objfreelist
,head
);
7990 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7994 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7999 /* This function gets called when 'maxmemory' is set on the config file to limit
8000 * the max memory used by the server, and we are out of memory.
8001 * This function will try to, in order:
8003 * - Free objects from the free list
8004 * - Try to remove keys with an EXPIRE set
8006 * It is not possible to free enough memory to reach used-memory < maxmemory
8007 * the server will start refusing commands that will enlarge even more the
8010 static void freeMemoryIfNeeded(void) {
8011 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
8012 int j
, k
, freed
= 0;
8014 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
8015 for (j
= 0; j
< server
.dbnum
; j
++) {
8017 robj
*minkey
= NULL
;
8018 struct dictEntry
*de
;
8020 if (dictSize(server
.db
[j
].expires
)) {
8022 /* From a sample of three keys drop the one nearest to
8023 * the natural expire */
8024 for (k
= 0; k
< 3; k
++) {
8027 de
= dictGetRandomKey(server
.db
[j
].expires
);
8028 t
= (time_t) dictGetEntryVal(de
);
8029 if (minttl
== -1 || t
< minttl
) {
8030 minkey
= dictGetEntryKey(de
);
8034 deleteKey(server
.db
+j
,minkey
);
8037 if (!freed
) return; /* nothing to free... */
8041 /* ============================== Append Only file ========================== */
8043 /* Write the append only file buffer on disk.
8045 * Since we are required to write the AOF before replying to the client,
8046 * and the only way the client socket can get a write is entering when the
8047 * the event loop, we accumulate all the AOF writes in a memory
8048 * buffer and write it on disk using this function just before entering
8049 * the event loop again. */
8050 static void flushAppendOnlyFile(void) {
8054 if (sdslen(server
.aofbuf
) == 0) return;
8056 /* We want to perform a single write. This should be guaranteed atomic
8057 * at least if the filesystem we are writing is a real physical one.
8058 * While this will save us against the server being killed I don't think
8059 * there is much to do about the whole server stopping for power problems
8061 nwritten
= write(server
.appendfd
,server
.aofbuf
,sdslen(server
.aofbuf
));
8062 if (nwritten
!= (signed)sdslen(server
.aofbuf
)) {
8063 /* Ooops, we are in troubles. The best thing to do for now is
8064 * aborting instead of giving the illusion that everything is
8065 * working as expected. */
8066 if (nwritten
== -1) {
8067 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
8069 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
8073 sdsfree(server
.aofbuf
);
8074 server
.aofbuf
= sdsempty();
8076 /* Fsync if needed */
8078 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
8079 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
8080 now
-server
.lastfsync
> 1))
8082 /* aof_fsync is defined as fdatasync() for Linux in order to avoid
8083 * flushing metadata. */
8084 aof_fsync(server
.appendfd
); /* Let's try to get this data on the disk */
8085 server
.lastfsync
= now
;
8089 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
8090 sds buf
= sdsempty();
8094 /* The DB this command was targetting is not the same as the last command
8095 * we appendend. To issue a SELECT command is needed. */
8096 if (dictid
!= server
.appendseldb
) {
8099 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
8100 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
8101 (unsigned long)strlen(seldb
),seldb
);
8102 server
.appendseldb
= dictid
;
8105 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
8106 * EXPIREs into EXPIREATs calls */
8107 if (cmd
->proc
== expireCommand
) {
8110 tmpargv
[0] = createStringObject("EXPIREAT",8);
8111 tmpargv
[1] = argv
[1];
8112 incrRefCount(argv
[1]);
8113 when
= time(NULL
)+strtol(argv
[2]->ptr
,NULL
,10);
8114 tmpargv
[2] = createObject(REDIS_STRING
,
8115 sdscatprintf(sdsempty(),"%ld",when
));
8119 /* Append the actual command */
8120 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
8121 for (j
= 0; j
< argc
; j
++) {
8124 o
= getDecodedObject(o
);
8125 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
8126 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
8127 buf
= sdscatlen(buf
,"\r\n",2);
8131 /* Free the objects from the modified argv for EXPIREAT */
8132 if (cmd
->proc
== expireCommand
) {
8133 for (j
= 0; j
< 3; j
++)
8134 decrRefCount(argv
[j
]);
8137 /* Append to the AOF buffer. This will be flushed on disk just before
8138 * of re-entering the event loop, so before the client will get a
8139 * positive reply about the operation performed. */
8140 server
.aofbuf
= sdscatlen(server
.aofbuf
,buf
,sdslen(buf
));
8142 /* If a background append only file rewriting is in progress we want to
8143 * accumulate the differences between the child DB and the current one
8144 * in a buffer, so that when the child process will do its work we
8145 * can append the differences to the new append only file. */
8146 if (server
.bgrewritechildpid
!= -1)
8147 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
8152 /* In Redis commands are always executed in the context of a client, so in
8153 * order to load the append only file we need to create a fake client. */
8154 static struct redisClient
*createFakeClient(void) {
8155 struct redisClient
*c
= zmalloc(sizeof(*c
));
8159 c
->querybuf
= sdsempty();
8163 /* We set the fake client as a slave waiting for the synchronization
8164 * so that Redis will not try to send replies to this client. */
8165 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
8166 c
->reply
= listCreate();
8167 listSetFreeMethod(c
->reply
,decrRefCount
);
8168 listSetDupMethod(c
->reply
,dupClientReplyValue
);
8169 initClientMultiState(c
);
8173 static void freeFakeClient(struct redisClient
*c
) {
8174 sdsfree(c
->querybuf
);
8175 listRelease(c
->reply
);
8176 freeClientMultiState(c
);
8180 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
8181 * error (the append only file is zero-length) REDIS_ERR is returned. On
8182 * fatal error an error message is logged and the program exists. */
8183 int loadAppendOnlyFile(char *filename
) {
8184 struct redisClient
*fakeClient
;
8185 FILE *fp
= fopen(filename
,"r");
8186 struct redis_stat sb
;
8187 unsigned long long loadedkeys
= 0;
8188 int appendonly
= server
.appendonly
;
8190 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
8194 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
8198 /* Temporarily disable AOF, to prevent EXEC from feeding a MULTI
8199 * to the same file we're about to read. */
8200 server
.appendonly
= 0;
8202 fakeClient
= createFakeClient();
8209 struct redisCommand
*cmd
;
8211 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
8217 if (buf
[0] != '*') goto fmterr
;
8219 argv
= zmalloc(sizeof(robj
*)*argc
);
8220 for (j
= 0; j
< argc
; j
++) {
8221 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
8222 if (buf
[0] != '$') goto fmterr
;
8223 len
= strtol(buf
+1,NULL
,10);
8224 argsds
= sdsnewlen(NULL
,len
);
8225 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
8226 argv
[j
] = createObject(REDIS_STRING
,argsds
);
8227 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
8230 /* Command lookup */
8231 cmd
= lookupCommand(argv
[0]->ptr
);
8233 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
8236 /* Try object encoding */
8237 if (cmd
->flags
& REDIS_CMD_BULK
)
8238 argv
[argc
-1] = tryObjectEncoding(argv
[argc
-1]);
8239 /* Run the command in the context of a fake client */
8240 fakeClient
->argc
= argc
;
8241 fakeClient
->argv
= argv
;
8242 cmd
->proc(fakeClient
);
8243 /* Discard the reply objects list from the fake client */
8244 while(listLength(fakeClient
->reply
))
8245 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
8246 /* Clean up, ready for the next command */
8247 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
8249 /* Handle swapping while loading big datasets when VM is on */
8251 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
8252 while (zmalloc_used_memory() > server
.vm_max_memory
) {
8253 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
8258 /* This point can only be reached when EOF is reached without errors.
8259 * If the client is in the middle of a MULTI/EXEC, log error and quit. */
8260 if (fakeClient
->flags
& REDIS_MULTI
) goto readerr
;
8263 freeFakeClient(fakeClient
);
8264 server
.appendonly
= appendonly
;
8269 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
8271 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
8275 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
8279 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
8280 static int fwriteBulkObject(FILE *fp
, robj
*obj
) {
8284 /* Avoid the incr/decr ref count business if possible to help
8285 * copy-on-write (we are often in a child process when this function
8287 * Also makes sure that key objects don't get incrRefCount-ed when VM
8289 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
8290 obj
= getDecodedObject(obj
);
8293 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
8294 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
8295 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
8297 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
8298 if (decrrc
) decrRefCount(obj
);
8301 if (decrrc
) decrRefCount(obj
);
8305 /* Write binary-safe string into a file in the bulkformat
8306 * $<count>\r\n<payload>\r\n */
8307 static int fwriteBulkString(FILE *fp
, char *s
, unsigned long len
) {
8310 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(unsigned long)len
);
8311 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8312 if (len
&& fwrite(s
,len
,1,fp
) == 0) return 0;
8313 if (fwrite("\r\n",2,1,fp
) == 0) return 0;
8317 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
8318 static int fwriteBulkDouble(FILE *fp
, double d
) {
8319 char buf
[128], dbuf
[128];
8321 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
8322 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
8323 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8324 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
8328 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
8329 static int fwriteBulkLong(FILE *fp
, long l
) {
8330 char buf
[128], lbuf
[128];
8332 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
8333 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
8334 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8335 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
8339 /* Write a sequence of commands able to fully rebuild the dataset into
8340 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
8341 static int rewriteAppendOnlyFile(char *filename
) {
8342 dictIterator
*di
= NULL
;
8347 time_t now
= time(NULL
);
8349 /* Note that we have to use a different temp name here compared to the
8350 * one used by rewriteAppendOnlyFileBackground() function. */
8351 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
8352 fp
= fopen(tmpfile
,"w");
8354 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
8357 for (j
= 0; j
< server
.dbnum
; j
++) {
8358 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
8359 redisDb
*db
= server
.db
+j
;
8361 if (dictSize(d
) == 0) continue;
8362 di
= dictGetIterator(d
);
8368 /* SELECT the new DB */
8369 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
8370 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
8372 /* Iterate this DB writing every entry */
8373 while((de
= dictNext(di
)) != NULL
) {
8378 key
= dictGetEntryKey(de
);
8379 /* If the value for this key is swapped, load a preview in memory.
8380 * We use a "swapped" flag to remember if we need to free the
8381 * value object instead to just increment the ref count anyway
8382 * in order to avoid copy-on-write of pages if we are forked() */
8383 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
8384 key
->storage
== REDIS_VM_SWAPPING
) {
8385 o
= dictGetEntryVal(de
);
8388 o
= vmPreviewObject(key
);
8391 expiretime
= getExpire(db
,key
);
8393 /* Save the key and associated value */
8394 if (o
->type
== REDIS_STRING
) {
8395 /* Emit a SET command */
8396 char cmd
[]="*3\r\n$3\r\nSET\r\n";
8397 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8399 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8400 if (fwriteBulkObject(fp
,o
) == 0) goto werr
;
8401 } else if (o
->type
== REDIS_LIST
) {
8402 /* Emit the RPUSHes needed to rebuild the list */
8403 list
*list
= o
->ptr
;
8407 listRewind(list
,&li
);
8408 while((ln
= listNext(&li
))) {
8409 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
8410 robj
*eleobj
= listNodeValue(ln
);
8412 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8413 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8414 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8416 } else if (o
->type
== REDIS_SET
) {
8417 /* Emit the SADDs needed to rebuild the set */
8419 dictIterator
*di
= dictGetIterator(set
);
8422 while((de
= dictNext(di
)) != NULL
) {
8423 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
8424 robj
*eleobj
= dictGetEntryKey(de
);
8426 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8427 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8428 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8430 dictReleaseIterator(di
);
8431 } else if (o
->type
== REDIS_ZSET
) {
8432 /* Emit the ZADDs needed to rebuild the sorted set */
8434 dictIterator
*di
= dictGetIterator(zs
->dict
);
8437 while((de
= dictNext(di
)) != NULL
) {
8438 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
8439 robj
*eleobj
= dictGetEntryKey(de
);
8440 double *score
= dictGetEntryVal(de
);
8442 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8443 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8444 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
8445 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8447 dictReleaseIterator(di
);
8448 } else if (o
->type
== REDIS_HASH
) {
8449 char cmd
[]="*4\r\n$4\r\nHSET\r\n";
8451 /* Emit the HSETs needed to rebuild the hash */
8452 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
8453 unsigned char *p
= zipmapRewind(o
->ptr
);
8454 unsigned char *field
, *val
;
8455 unsigned int flen
, vlen
;
8457 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
8458 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8459 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8460 if (fwriteBulkString(fp
,(char*)field
,flen
) == -1)
8462 if (fwriteBulkString(fp
,(char*)val
,vlen
) == -1)
8466 dictIterator
*di
= dictGetIterator(o
->ptr
);
8469 while((de
= dictNext(di
)) != NULL
) {
8470 robj
*field
= dictGetEntryKey(de
);
8471 robj
*val
= dictGetEntryVal(de
);
8473 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8474 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8475 if (fwriteBulkObject(fp
,field
) == -1) return -1;
8476 if (fwriteBulkObject(fp
,val
) == -1) return -1;
8478 dictReleaseIterator(di
);
8481 redisPanic("Unknown object type");
8483 /* Save the expire time */
8484 if (expiretime
!= -1) {
8485 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
8486 /* If this key is already expired skip it */
8487 if (expiretime
< now
) continue;
8488 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8489 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8490 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
8492 if (swapped
) decrRefCount(o
);
8494 dictReleaseIterator(di
);
8497 /* Make sure data will not remain on the OS's output buffers */
8502 /* Use RENAME to make sure the DB file is changed atomically only
8503 * if the generate DB file is ok. */
8504 if (rename(tmpfile
,filename
) == -1) {
8505 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
8509 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
8515 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
8516 if (di
) dictReleaseIterator(di
);
8520 /* This is how rewriting of the append only file in background works:
8522 * 1) The user calls BGREWRITEAOF
8523 * 2) Redis calls this function, that forks():
8524 * 2a) the child rewrite the append only file in a temp file.
8525 * 2b) the parent accumulates differences in server.bgrewritebuf.
8526 * 3) When the child finished '2a' exists.
8527 * 4) The parent will trap the exit code, if it's OK, will append the
8528 * data accumulated into server.bgrewritebuf into the temp file, and
8529 * finally will rename(2) the temp file in the actual file name.
8530 * The the new file is reopened as the new append only file. Profit!
8532 static int rewriteAppendOnlyFileBackground(void) {
8535 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
8536 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
8537 if ((childpid
= fork()) == 0) {
8541 if (server
.vm_enabled
) vmReopenSwapFile();
8543 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
8544 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
8551 if (childpid
== -1) {
8552 redisLog(REDIS_WARNING
,
8553 "Can't rewrite append only file in background: fork: %s",
8557 redisLog(REDIS_NOTICE
,
8558 "Background append only file rewriting started by pid %d",childpid
);
8559 server
.bgrewritechildpid
= childpid
;
8560 updateDictResizePolicy();
8561 /* We set appendseldb to -1 in order to force the next call to the
8562 * feedAppendOnlyFile() to issue a SELECT command, so the differences
8563 * accumulated by the parent into server.bgrewritebuf will start
8564 * with a SELECT statement and it will be safe to merge. */
8565 server
.appendseldb
= -1;
8568 return REDIS_OK
; /* unreached */
8571 static void bgrewriteaofCommand(redisClient
*c
) {
8572 if (server
.bgrewritechildpid
!= -1) {
8573 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
8576 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
8577 char *status
= "+Background append only file rewriting started\r\n";
8578 addReplySds(c
,sdsnew(status
));
8580 addReply(c
,shared
.err
);
8584 static void aofRemoveTempFile(pid_t childpid
) {
8587 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
8591 /* Virtual Memory is composed mainly of two subsystems:
8592 * - Blocking Virutal Memory
8593 * - Threaded Virtual Memory I/O
8594 * The two parts are not fully decoupled, but functions are split among two
8595 * different sections of the source code (delimited by comments) in order to
8596 * make more clear what functionality is about the blocking VM and what about
8597 * the threaded (not blocking) VM.
8601 * Redis VM is a blocking VM (one that blocks reading swapped values from
8602 * disk into memory when a value swapped out is needed in memory) that is made
8603 * unblocking by trying to examine the command argument vector in order to
8604 * load in background values that will likely be needed in order to exec
8605 * the command. The command is executed only once all the relevant keys
8606 * are loaded into memory.
8608 * This basically is almost as simple of a blocking VM, but almost as parallel
8609 * as a fully non-blocking VM.
8612 /* =================== Virtual Memory - Blocking Side ====================== */
8614 static void vmInit(void) {
8620 if (server
.vm_max_threads
!= 0)
8621 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
8623 redisLog(REDIS_NOTICE
,"Using '%s' as swap file",server
.vm_swap_file
);
8624 /* Try to open the old swap file, otherwise create it */
8625 if ((server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b")) == NULL
) {
8626 server
.vm_fp
= fopen(server
.vm_swap_file
,"w+b");
8628 if (server
.vm_fp
== NULL
) {
8629 redisLog(REDIS_WARNING
,
8630 "Can't open the swap file: %s. Exiting.",
8634 server
.vm_fd
= fileno(server
.vm_fp
);
8635 /* Lock the swap file for writing, this is useful in order to avoid
8636 * another instance to use the same swap file for a config error. */
8637 fl
.l_type
= F_WRLCK
;
8638 fl
.l_whence
= SEEK_SET
;
8639 fl
.l_start
= fl
.l_len
= 0;
8640 if (fcntl(server
.vm_fd
,F_SETLK
,&fl
) == -1) {
8641 redisLog(REDIS_WARNING
,
8642 "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
));
8646 server
.vm_next_page
= 0;
8647 server
.vm_near_pages
= 0;
8648 server
.vm_stats_used_pages
= 0;
8649 server
.vm_stats_swapped_objects
= 0;
8650 server
.vm_stats_swapouts
= 0;
8651 server
.vm_stats_swapins
= 0;
8652 totsize
= server
.vm_pages
*server
.vm_page_size
;
8653 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
8654 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
8655 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
8659 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
8661 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
8662 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
8663 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
8664 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
8666 /* Initialize threaded I/O (used by Virtual Memory) */
8667 server
.io_newjobs
= listCreate();
8668 server
.io_processing
= listCreate();
8669 server
.io_processed
= listCreate();
8670 server
.io_ready_clients
= listCreate();
8671 pthread_mutex_init(&server
.io_mutex
,NULL
);
8672 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
8673 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
8674 server
.io_active_threads
= 0;
8675 if (pipe(pipefds
) == -1) {
8676 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
8680 server
.io_ready_pipe_read
= pipefds
[0];
8681 server
.io_ready_pipe_write
= pipefds
[1];
8682 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
8683 /* LZF requires a lot of stack */
8684 pthread_attr_init(&server
.io_threads_attr
);
8685 pthread_attr_getstacksize(&server
.io_threads_attr
, &stacksize
);
8686 while (stacksize
< REDIS_THREAD_STACK_SIZE
) stacksize
*= 2;
8687 pthread_attr_setstacksize(&server
.io_threads_attr
, stacksize
);
8688 /* Listen for events in the threaded I/O pipe */
8689 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
8690 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
8691 oom("creating file event");
8694 /* Mark the page as used */
8695 static void vmMarkPageUsed(off_t page
) {
8696 off_t byte
= page
/8;
8698 redisAssert(vmFreePage(page
) == 1);
8699 server
.vm_bitmap
[byte
] |= 1<<bit
;
8702 /* Mark N contiguous pages as used, with 'page' being the first. */
8703 static void vmMarkPagesUsed(off_t page
, off_t count
) {
8706 for (j
= 0; j
< count
; j
++)
8707 vmMarkPageUsed(page
+j
);
8708 server
.vm_stats_used_pages
+= count
;
8709 redisLog(REDIS_DEBUG
,"Mark USED pages: %lld pages at %lld\n",
8710 (long long)count
, (long long)page
);
8713 /* Mark the page as free */
8714 static void vmMarkPageFree(off_t page
) {
8715 off_t byte
= page
/8;
8717 redisAssert(vmFreePage(page
) == 0);
8718 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
8721 /* Mark N contiguous pages as free, with 'page' being the first. */
8722 static void vmMarkPagesFree(off_t page
, off_t count
) {
8725 for (j
= 0; j
< count
; j
++)
8726 vmMarkPageFree(page
+j
);
8727 server
.vm_stats_used_pages
-= count
;
8728 redisLog(REDIS_DEBUG
,"Mark FREE pages: %lld pages at %lld\n",
8729 (long long)count
, (long long)page
);
8732 /* Test if the page is free */
8733 static int vmFreePage(off_t page
) {
8734 off_t byte
= page
/8;
8736 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
8739 /* Find N contiguous free pages storing the first page of the cluster in *first.
8740 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
8741 * REDIS_ERR is returned.
8743 * This function uses a simple algorithm: we try to allocate
8744 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
8745 * again from the start of the swap file searching for free spaces.
8747 * If it looks pretty clear that there are no free pages near our offset
8748 * we try to find less populated places doing a forward jump of
8749 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
8750 * without hurry, and then we jump again and so forth...
8752 * This function can be improved using a free list to avoid to guess
8753 * too much, since we could collect data about freed pages.
8755 * note: I implemented this function just after watching an episode of
8756 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
8758 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
8759 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
8761 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
8762 server
.vm_near_pages
= 0;
8763 server
.vm_next_page
= 0;
8765 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
8766 base
= server
.vm_next_page
;
8768 while(offset
< server
.vm_pages
) {
8769 off_t
this = base
+offset
;
8771 /* If we overflow, restart from page zero */
8772 if (this >= server
.vm_pages
) {
8773 this -= server
.vm_pages
;
8775 /* Just overflowed, what we found on tail is no longer
8776 * interesting, as it's no longer contiguous. */
8780 if (vmFreePage(this)) {
8781 /* This is a free page */
8783 /* Already got N free pages? Return to the caller, with success */
8785 *first
= this-(n
-1);
8786 server
.vm_next_page
= this+1;
8787 redisLog(REDIS_DEBUG
, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n
, (long long) *first
);
8791 /* The current one is not a free page */
8795 /* Fast-forward if the current page is not free and we already
8796 * searched enough near this place. */
8798 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
8799 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
8801 /* Note that even if we rewind after the jump, we are don't need
8802 * to make sure numfree is set to zero as we only jump *if* it
8803 * is set to zero. */
8805 /* Otherwise just check the next page */
8812 /* Write the specified object at the specified page of the swap file */
8813 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
8814 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8815 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8816 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8817 redisLog(REDIS_WARNING
,
8818 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
8822 rdbSaveObject(server
.vm_fp
,o
);
8823 fflush(server
.vm_fp
);
8824 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8828 /* Swap the 'val' object relative to 'key' into disk. Store all the information
8829 * needed to later retrieve the object into the key object.
8830 * If we can't find enough contiguous empty pages to swap the object on disk
8831 * REDIS_ERR is returned. */
8832 static int vmSwapObjectBlocking(robj
*key
, robj
*val
) {
8833 off_t pages
= rdbSavedObjectPages(val
,NULL
);
8836 assert(key
->storage
== REDIS_VM_MEMORY
);
8837 assert(key
->refcount
== 1);
8838 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
8839 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return REDIS_ERR
;
8840 key
->vm
.page
= page
;
8841 key
->vm
.usedpages
= pages
;
8842 key
->storage
= REDIS_VM_SWAPPED
;
8843 key
->vtype
= val
->type
;
8844 decrRefCount(val
); /* Deallocate the object from memory. */
8845 vmMarkPagesUsed(page
,pages
);
8846 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
8847 (unsigned char*) key
->ptr
,
8848 (unsigned long long) page
, (unsigned long long) pages
);
8849 server
.vm_stats_swapped_objects
++;
8850 server
.vm_stats_swapouts
++;
8854 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
8857 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8858 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8859 redisLog(REDIS_WARNING
,
8860 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
8864 o
= rdbLoadObject(type
,server
.vm_fp
);
8866 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno
));
8869 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8873 /* Load the value object relative to the 'key' object from swap to memory.
8874 * The newly allocated object is returned.
8876 * If preview is true the unserialized object is returned to the caller but
8877 * no changes are made to the key object, nor the pages are marked as freed */
8878 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
8881 redisAssert(key
->storage
== REDIS_VM_SWAPPED
|| key
->storage
== REDIS_VM_LOADING
);
8882 val
= vmReadObjectFromSwap(key
->vm
.page
,key
->vtype
);
8884 key
->storage
= REDIS_VM_MEMORY
;
8885 key
->vm
.atime
= server
.unixtime
;
8886 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8887 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
8888 (unsigned char*) key
->ptr
);
8889 server
.vm_stats_swapped_objects
--;
8891 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
8892 (unsigned char*) key
->ptr
);
8894 server
.vm_stats_swapins
++;
8898 /* Plain object loading, from swap to memory */
8899 static robj
*vmLoadObject(robj
*key
) {
8900 /* If we are loading the object in background, stop it, we
8901 * need to load this object synchronously ASAP. */
8902 if (key
->storage
== REDIS_VM_LOADING
)
8903 vmCancelThreadedIOJob(key
);
8904 return vmGenericLoadObject(key
,0);
8907 /* Just load the value on disk, without to modify the key.
8908 * This is useful when we want to perform some operation on the value
8909 * without to really bring it from swap to memory, like while saving the
8910 * dataset or rewriting the append only log. */
8911 static robj
*vmPreviewObject(robj
*key
) {
8912 return vmGenericLoadObject(key
,1);
8915 /* How a good candidate is this object for swapping?
8916 * The better candidate it is, the greater the returned value.
8918 * Currently we try to perform a fast estimation of the object size in
8919 * memory, and combine it with aging informations.
8921 * Basically swappability = idle-time * log(estimated size)
8923 * Bigger objects are preferred over smaller objects, but not
8924 * proportionally, this is why we use the logarithm. This algorithm is
8925 * just a first try and will probably be tuned later. */
8926 static double computeObjectSwappability(robj
*o
) {
8927 time_t age
= server
.unixtime
- o
->vm
.atime
;
8931 struct dictEntry
*de
;
8934 if (age
<= 0) return 0;
8937 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
8940 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
8945 listNode
*ln
= listFirst(l
);
8947 asize
= sizeof(list
);
8949 robj
*ele
= ln
->value
;
8952 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8953 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8955 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
8960 z
= (o
->type
== REDIS_ZSET
);
8961 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
8963 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
8964 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
8969 de
= dictGetRandomKey(d
);
8970 ele
= dictGetEntryKey(de
);
8971 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8972 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8974 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
8975 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
8979 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
8980 unsigned char *p
= zipmapRewind((unsigned char*)o
->ptr
);
8981 unsigned int len
= zipmapLen((unsigned char*)o
->ptr
);
8982 unsigned int klen
, vlen
;
8983 unsigned char *key
, *val
;
8985 if ((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) == NULL
) {
8989 asize
= len
*(klen
+vlen
+3);
8990 } else if (o
->encoding
== REDIS_ENCODING_HT
) {
8992 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
8997 de
= dictGetRandomKey(d
);
8998 ele
= dictGetEntryKey(de
);
8999 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9000 (sizeof(*o
)+sdslen(ele
->ptr
)) :
9002 ele
= dictGetEntryVal(de
);
9003 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9004 (sizeof(*o
)+sdslen(ele
->ptr
)) :
9006 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
9011 return (double)age
*log(1+asize
);
9014 /* Try to swap an object that's a good candidate for swapping.
9015 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
9016 * to swap any object at all.
9018 * If 'usethreaded' is true, Redis will try to swap the object in background
9019 * using I/O threads. */
9020 static int vmSwapOneObject(int usethreads
) {
9022 struct dictEntry
*best
= NULL
;
9023 double best_swappability
= 0;
9024 redisDb
*best_db
= NULL
;
9027 for (j
= 0; j
< server
.dbnum
; j
++) {
9028 redisDb
*db
= server
.db
+j
;
9029 /* Why maxtries is set to 100?
9030 * Because this way (usually) we'll find 1 object even if just 1% - 2%
9031 * are swappable objects */
9034 if (dictSize(db
->dict
) == 0) continue;
9035 for (i
= 0; i
< 5; i
++) {
9037 double swappability
;
9039 if (maxtries
) maxtries
--;
9040 de
= dictGetRandomKey(db
->dict
);
9041 key
= dictGetEntryKey(de
);
9042 val
= dictGetEntryVal(de
);
9043 /* Only swap objects that are currently in memory.
9045 * Also don't swap shared objects if threaded VM is on, as we
9046 * try to ensure that the main thread does not touch the
9047 * object while the I/O thread is using it, but we can't
9048 * control other keys without adding additional mutex. */
9049 if (key
->storage
!= REDIS_VM_MEMORY
||
9050 (server
.vm_max_threads
!= 0 && val
->refcount
!= 1)) {
9051 if (maxtries
) i
--; /* don't count this try */
9054 swappability
= computeObjectSwappability(val
);
9055 if (!best
|| swappability
> best_swappability
) {
9057 best_swappability
= swappability
;
9062 if (best
== NULL
) return REDIS_ERR
;
9063 key
= dictGetEntryKey(best
);
9064 val
= dictGetEntryVal(best
);
9066 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
9067 key
->ptr
, best_swappability
);
9069 /* Unshare the key if needed */
9070 if (key
->refcount
> 1) {
9071 robj
*newkey
= dupStringObject(key
);
9073 key
= dictGetEntryKey(best
) = newkey
;
9077 vmSwapObjectThreaded(key
,val
,best_db
);
9080 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
9081 dictGetEntryVal(best
) = NULL
;
9089 static int vmSwapOneObjectBlocking() {
9090 return vmSwapOneObject(0);
9093 static int vmSwapOneObjectThreaded() {
9094 return vmSwapOneObject(1);
9097 /* Return true if it's safe to swap out objects in a given moment.
9098 * Basically we don't want to swap objects out while there is a BGSAVE
9099 * or a BGAEOREWRITE running in backgroud. */
9100 static int vmCanSwapOut(void) {
9101 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
9104 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
9105 * and was deleted. Otherwise 0 is returned. */
9106 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
9110 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
9111 foundkey
= dictGetEntryKey(de
);
9112 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
9117 /* =================== Virtual Memory - Threaded I/O ======================= */
9119 static void freeIOJob(iojob
*j
) {
9120 if ((j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
9121 j
->type
== REDIS_IOJOB_DO_SWAP
||
9122 j
->type
== REDIS_IOJOB_LOAD
) && j
->val
!= NULL
)
9123 decrRefCount(j
->val
);
9124 /* We don't decrRefCount the j->key field as we did't incremented
9125 * the count creating IO Jobs. This is because the key field here is
9126 * just used as an indentifier and if a key is removed the Job should
9127 * never be touched again. */
9131 /* Every time a thread finished a Job, it writes a byte into the write side
9132 * of an unix pipe in order to "awake" the main thread, and this function
9134 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
9138 int retval
, processed
= 0, toprocess
= -1, trytoswap
= 1;
9140 REDIS_NOTUSED(mask
);
9141 REDIS_NOTUSED(privdata
);
9143 /* For every byte we read in the read side of the pipe, there is one
9144 * I/O job completed to process. */
9145 while((retval
= read(fd
,buf
,1)) == 1) {
9149 struct dictEntry
*de
;
9151 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
9153 /* Get the processed element (the oldest one) */
9155 assert(listLength(server
.io_processed
) != 0);
9156 if (toprocess
== -1) {
9157 toprocess
= (listLength(server
.io_processed
)*REDIS_MAX_COMPLETED_JOBS_PROCESSED
)/100;
9158 if (toprocess
<= 0) toprocess
= 1;
9160 ln
= listFirst(server
.io_processed
);
9162 listDelNode(server
.io_processed
,ln
);
9164 /* If this job is marked as canceled, just ignore it */
9169 /* Post process it in the main thread, as there are things we
9170 * can do just here to avoid race conditions and/or invasive locks */
9171 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
);
9172 de
= dictFind(j
->db
->dict
,j
->key
);
9174 key
= dictGetEntryKey(de
);
9175 if (j
->type
== REDIS_IOJOB_LOAD
) {
9178 /* Key loaded, bring it at home */
9179 key
->storage
= REDIS_VM_MEMORY
;
9180 key
->vm
.atime
= server
.unixtime
;
9181 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
9182 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
9183 (unsigned char*) key
->ptr
);
9184 server
.vm_stats_swapped_objects
--;
9185 server
.vm_stats_swapins
++;
9186 dictGetEntryVal(de
) = j
->val
;
9187 incrRefCount(j
->val
);
9190 /* Handle clients waiting for this key to be loaded. */
9191 handleClientsBlockedOnSwappedKey(db
,key
);
9192 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
9193 /* Now we know the amount of pages required to swap this object.
9194 * Let's find some space for it, and queue this task again
9195 * rebranded as REDIS_IOJOB_DO_SWAP. */
9196 if (!vmCanSwapOut() ||
9197 vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
)
9199 /* Ooops... no space or we can't swap as there is
9200 * a fork()ed Redis trying to save stuff on disk. */
9202 key
->storage
= REDIS_VM_MEMORY
; /* undo operation */
9204 /* Note that we need to mark this pages as used now,
9205 * if the job will be canceled, we'll mark them as freed
9207 vmMarkPagesUsed(j
->page
,j
->pages
);
9208 j
->type
= REDIS_IOJOB_DO_SWAP
;
9213 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
9216 /* Key swapped. We can finally free some memory. */
9217 if (key
->storage
!= REDIS_VM_SWAPPING
) {
9218 printf("key->storage: %d\n",key
->storage
);
9219 printf("key->name: %s\n",(char*)key
->ptr
);
9220 printf("key->refcount: %d\n",key
->refcount
);
9221 printf("val: %p\n",(void*)j
->val
);
9222 printf("val->type: %d\n",j
->val
->type
);
9223 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
9225 redisAssert(key
->storage
== REDIS_VM_SWAPPING
);
9226 val
= dictGetEntryVal(de
);
9227 key
->vm
.page
= j
->page
;
9228 key
->vm
.usedpages
= j
->pages
;
9229 key
->storage
= REDIS_VM_SWAPPED
;
9230 key
->vtype
= j
->val
->type
;
9231 decrRefCount(val
); /* Deallocate the object from memory. */
9232 dictGetEntryVal(de
) = NULL
;
9233 redisLog(REDIS_DEBUG
,
9234 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
9235 (unsigned char*) key
->ptr
,
9236 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
9237 server
.vm_stats_swapped_objects
++;
9238 server
.vm_stats_swapouts
++;
9240 /* Put a few more swap requests in queue if we are still
9242 if (trytoswap
&& vmCanSwapOut() &&
9243 zmalloc_used_memory() > server
.vm_max_memory
)
9248 more
= listLength(server
.io_newjobs
) <
9249 (unsigned) server
.vm_max_threads
;
9251 /* Don't waste CPU time if swappable objects are rare. */
9252 if (vmSwapOneObjectThreaded() == REDIS_ERR
) {
9260 if (processed
== toprocess
) return;
9262 if (retval
< 0 && errno
!= EAGAIN
) {
9263 redisLog(REDIS_WARNING
,
9264 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
9269 static void lockThreadedIO(void) {
9270 pthread_mutex_lock(&server
.io_mutex
);
9273 static void unlockThreadedIO(void) {
9274 pthread_mutex_unlock(&server
.io_mutex
);
9277 /* Remove the specified object from the threaded I/O queue if still not
9278 * processed, otherwise make sure to flag it as canceled. */
9279 static void vmCancelThreadedIOJob(robj
*o
) {
9281 server
.io_newjobs
, /* 0 */
9282 server
.io_processing
, /* 1 */
9283 server
.io_processed
/* 2 */
9287 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
9290 /* Search for a matching key in one of the queues */
9291 for (i
= 0; i
< 3; i
++) {
9295 listRewind(lists
[i
],&li
);
9296 while ((ln
= listNext(&li
)) != NULL
) {
9297 iojob
*job
= ln
->value
;
9299 if (job
->canceled
) continue; /* Skip this, already canceled. */
9300 if (job
->key
== o
) {
9301 redisLog(REDIS_DEBUG
,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
9302 (void*)job
, (char*)o
->ptr
, job
->type
, i
);
9303 /* Mark the pages as free since the swap didn't happened
9304 * or happened but is now discarded. */
9305 if (i
!= 1 && job
->type
== REDIS_IOJOB_DO_SWAP
)
9306 vmMarkPagesFree(job
->page
,job
->pages
);
9307 /* Cancel the job. It depends on the list the job is
9310 case 0: /* io_newjobs */
9311 /* If the job was yet not processed the best thing to do
9312 * is to remove it from the queue at all */
9314 listDelNode(lists
[i
],ln
);
9316 case 1: /* io_processing */
9317 /* Oh Shi- the thread is messing with the Job:
9319 * Probably it's accessing the object if this is a
9320 * PREPARE_SWAP or DO_SWAP job.
9321 * If it's a LOAD job it may be reading from disk and
9322 * if we don't wait for the job to terminate before to
9323 * cancel it, maybe in a few microseconds data can be
9324 * corrupted in this pages. So the short story is:
9326 * Better to wait for the job to move into the
9327 * next queue (processed)... */
9329 /* We try again and again until the job is completed. */
9331 /* But let's wait some time for the I/O thread
9332 * to finish with this job. After all this condition
9333 * should be very rare. */
9336 case 2: /* io_processed */
9337 /* The job was already processed, that's easy...
9338 * just mark it as canceled so that we'll ignore it
9339 * when processing completed jobs. */
9343 /* Finally we have to adjust the storage type of the object
9344 * in order to "UNDO" the operaiton. */
9345 if (o
->storage
== REDIS_VM_LOADING
)
9346 o
->storage
= REDIS_VM_SWAPPED
;
9347 else if (o
->storage
== REDIS_VM_SWAPPING
)
9348 o
->storage
= REDIS_VM_MEMORY
;
9355 assert(1 != 1); /* We should never reach this */
9358 static void *IOThreadEntryPoint(void *arg
) {
9363 pthread_detach(pthread_self());
9365 /* Get a new job to process */
9367 if (listLength(server
.io_newjobs
) == 0) {
9368 /* No new jobs in queue, exit. */
9369 redisLog(REDIS_DEBUG
,"Thread %ld exiting, nothing to do",
9370 (long) pthread_self());
9371 server
.io_active_threads
--;
9375 ln
= listFirst(server
.io_newjobs
);
9377 listDelNode(server
.io_newjobs
,ln
);
9378 /* Add the job in the processing queue */
9379 j
->thread
= pthread_self();
9380 listAddNodeTail(server
.io_processing
,j
);
9381 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
9383 redisLog(REDIS_DEBUG
,"Thread %ld got a new job (type %d): %p about key '%s'",
9384 (long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
9386 /* Process the Job */
9387 if (j
->type
== REDIS_IOJOB_LOAD
) {
9388 j
->val
= vmReadObjectFromSwap(j
->page
,j
->key
->vtype
);
9389 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
9390 FILE *fp
= fopen("/dev/null","w+");
9391 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
9393 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
9394 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
9398 /* Done: insert the job into the processed queue */
9399 redisLog(REDIS_DEBUG
,"Thread %ld completed the job: %p (key %s)",
9400 (long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
9402 listDelNode(server
.io_processing
,ln
);
9403 listAddNodeTail(server
.io_processed
,j
);
9406 /* Signal the main thread there is new stuff to process */
9407 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
9409 return NULL
; /* never reached */
9412 static void spawnIOThread(void) {
9414 sigset_t mask
, omask
;
9418 sigaddset(&mask
,SIGCHLD
);
9419 sigaddset(&mask
,SIGHUP
);
9420 sigaddset(&mask
,SIGPIPE
);
9421 pthread_sigmask(SIG_SETMASK
, &mask
, &omask
);
9422 while ((err
= pthread_create(&thread
,&server
.io_threads_attr
,IOThreadEntryPoint
,NULL
)) != 0) {
9423 redisLog(REDIS_WARNING
,"Unable to spawn an I/O thread: %s",
9427 pthread_sigmask(SIG_SETMASK
, &omask
, NULL
);
9428 server
.io_active_threads
++;
9431 /* We need to wait for the last thread to exit before we are able to
9432 * fork() in order to BGSAVE or BGREWRITEAOF. */
9433 static void waitEmptyIOJobsQueue(void) {
9435 int io_processed_len
;
9438 if (listLength(server
.io_newjobs
) == 0 &&
9439 listLength(server
.io_processing
) == 0 &&
9440 server
.io_active_threads
== 0)
9445 /* While waiting for empty jobs queue condition we post-process some
9446 * finshed job, as I/O threads may be hanging trying to write against
9447 * the io_ready_pipe_write FD but there are so much pending jobs that
9449 io_processed_len
= listLength(server
.io_processed
);
9451 if (io_processed_len
) {
9452 vmThreadedIOCompletedJob(NULL
,server
.io_ready_pipe_read
,NULL
,0);
9453 usleep(1000); /* 1 millisecond */
9455 usleep(10000); /* 10 milliseconds */
9460 static void vmReopenSwapFile(void) {
9461 /* Note: we don't close the old one as we are in the child process
9462 * and don't want to mess at all with the original file object. */
9463 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
9464 if (server
.vm_fp
== NULL
) {
9465 redisLog(REDIS_WARNING
,"Can't re-open the VM swap file: %s. Exiting.",
9466 server
.vm_swap_file
);
9469 server
.vm_fd
= fileno(server
.vm_fp
);
9472 /* This function must be called while with threaded IO locked */
9473 static void queueIOJob(iojob
*j
) {
9474 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
9475 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
9476 listAddNodeTail(server
.io_newjobs
,j
);
9477 if (server
.io_active_threads
< server
.vm_max_threads
)
9481 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
9484 assert(key
->storage
== REDIS_VM_MEMORY
);
9485 assert(key
->refcount
== 1);
9487 j
= zmalloc(sizeof(*j
));
9488 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
9494 j
->thread
= (pthread_t
) -1;
9495 key
->storage
= REDIS_VM_SWAPPING
;
9503 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
9505 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
9506 * If there is not already a job loading the key, it is craeted.
9507 * The key is added to the io_keys list in the client structure, and also
9508 * in the hash table mapping swapped keys to waiting clients, that is,
9509 * server.io_waited_keys. */
9510 static int waitForSwappedKey(redisClient
*c
, robj
*key
) {
9511 struct dictEntry
*de
;
9515 /* If the key does not exist or is already in RAM we don't need to
9516 * block the client at all. */
9517 de
= dictFind(c
->db
->dict
,key
);
9518 if (de
== NULL
) return 0;
9519 o
= dictGetEntryKey(de
);
9520 if (o
->storage
== REDIS_VM_MEMORY
) {
9522 } else if (o
->storage
== REDIS_VM_SWAPPING
) {
9523 /* We were swapping the key, undo it! */
9524 vmCancelThreadedIOJob(o
);
9528 /* OK: the key is either swapped, or being loaded just now. */
9530 /* Add the key to the list of keys this client is waiting for.
9531 * This maps clients to keys they are waiting for. */
9532 listAddNodeTail(c
->io_keys
,key
);
9535 /* Add the client to the swapped keys => clients waiting map. */
9536 de
= dictFind(c
->db
->io_keys
,key
);
9540 /* For every key we take a list of clients blocked for it */
9542 retval
= dictAdd(c
->db
->io_keys
,key
,l
);
9544 assert(retval
== DICT_OK
);
9546 l
= dictGetEntryVal(de
);
9548 listAddNodeTail(l
,c
);
9550 /* Are we already loading the key from disk? If not create a job */
9551 if (o
->storage
== REDIS_VM_SWAPPED
) {
9554 o
->storage
= REDIS_VM_LOADING
;
9555 j
= zmalloc(sizeof(*j
));
9556 j
->type
= REDIS_IOJOB_LOAD
;
9559 j
->key
->vtype
= o
->vtype
;
9560 j
->page
= o
->vm
.page
;
9563 j
->thread
= (pthread_t
) -1;
9571 /* Preload keys needed for the ZUNION and ZINTER commands. */
9572 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
) {
9574 num
= atoi(c
->argv
[2]->ptr
);
9575 for (i
= 0; i
< num
; i
++) {
9576 waitForSwappedKey(c
,c
->argv
[3+i
]);
9580 /* Is this client attempting to run a command against swapped keys?
9581 * If so, block it ASAP, load the keys in background, then resume it.
9583 * The important idea about this function is that it can fail! If keys will
9584 * still be swapped when the client is resumed, this key lookups will
9585 * just block loading keys from disk. In practical terms this should only
9586 * happen with SORT BY command or if there is a bug in this function.
9588 * Return 1 if the client is marked as blocked, 0 if the client can
9589 * continue as the keys it is going to access appear to be in memory. */
9590 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
) {
9593 if (cmd
->vm_preload_proc
!= NULL
) {
9594 cmd
->vm_preload_proc(c
);
9596 if (cmd
->vm_firstkey
== 0) return 0;
9597 last
= cmd
->vm_lastkey
;
9598 if (last
< 0) last
= c
->argc
+last
;
9599 for (j
= cmd
->vm_firstkey
; j
<= last
; j
+= cmd
->vm_keystep
)
9600 waitForSwappedKey(c
,c
->argv
[j
]);
9603 /* If the client was blocked for at least one key, mark it as blocked. */
9604 if (listLength(c
->io_keys
)) {
9605 c
->flags
|= REDIS_IO_WAIT
;
9606 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
9607 server
.vm_blocked_clients
++;
9614 /* Remove the 'key' from the list of blocked keys for a given client.
9616 * The function returns 1 when there are no longer blocking keys after
9617 * the current one was removed (and the client can be unblocked). */
9618 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
) {
9622 struct dictEntry
*de
;
9624 /* Remove the key from the list of keys this client is waiting for. */
9625 listRewind(c
->io_keys
,&li
);
9626 while ((ln
= listNext(&li
)) != NULL
) {
9627 if (compareStringObjects(ln
->value
,key
) == 0) {
9628 listDelNode(c
->io_keys
,ln
);
9634 /* Remove the client form the key => waiting clients map. */
9635 de
= dictFind(c
->db
->io_keys
,key
);
9637 l
= dictGetEntryVal(de
);
9638 ln
= listSearchKey(l
,c
);
9641 if (listLength(l
) == 0)
9642 dictDelete(c
->db
->io_keys
,key
);
9644 return listLength(c
->io_keys
) == 0;
9647 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
) {
9648 struct dictEntry
*de
;
9653 de
= dictFind(db
->io_keys
,key
);
9656 l
= dictGetEntryVal(de
);
9657 len
= listLength(l
);
9658 /* Note: we can't use something like while(listLength(l)) as the list
9659 * can be freed by the calling function when we remove the last element. */
9662 redisClient
*c
= ln
->value
;
9664 if (dontWaitForSwappedKey(c
,key
)) {
9665 /* Put the client in the list of clients ready to go as we
9666 * loaded all the keys about it. */
9667 listAddNodeTail(server
.io_ready_clients
,c
);
9672 /* =========================== Remote Configuration ========================= */
9674 static void configSetCommand(redisClient
*c
) {
9675 robj
*o
= getDecodedObject(c
->argv
[3]);
9676 if (!strcasecmp(c
->argv
[2]->ptr
,"dbfilename")) {
9677 zfree(server
.dbfilename
);
9678 server
.dbfilename
= zstrdup(o
->ptr
);
9679 } else if (!strcasecmp(c
->argv
[2]->ptr
,"requirepass")) {
9680 zfree(server
.requirepass
);
9681 server
.requirepass
= zstrdup(o
->ptr
);
9682 } else if (!strcasecmp(c
->argv
[2]->ptr
,"masterauth")) {
9683 zfree(server
.masterauth
);
9684 server
.masterauth
= zstrdup(o
->ptr
);
9685 } else if (!strcasecmp(c
->argv
[2]->ptr
,"maxmemory")) {
9686 server
.maxmemory
= strtoll(o
->ptr
, NULL
, 10);
9688 addReplySds(c
,sdscatprintf(sdsempty(),
9689 "-ERR not supported CONFIG parameter %s\r\n",
9690 (char*)c
->argv
[2]->ptr
));
9695 addReply(c
,shared
.ok
);
9698 static void configGetCommand(redisClient
*c
) {
9699 robj
*o
= getDecodedObject(c
->argv
[2]);
9700 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
9701 char *pattern
= o
->ptr
;
9705 decrRefCount(lenobj
);
9707 if (stringmatch(pattern
,"dbfilename",0)) {
9708 addReplyBulkCString(c
,"dbfilename");
9709 addReplyBulkCString(c
,server
.dbfilename
);
9712 if (stringmatch(pattern
,"requirepass",0)) {
9713 addReplyBulkCString(c
,"requirepass");
9714 addReplyBulkCString(c
,server
.requirepass
);
9717 if (stringmatch(pattern
,"masterauth",0)) {
9718 addReplyBulkCString(c
,"masterauth");
9719 addReplyBulkCString(c
,server
.masterauth
);
9722 if (stringmatch(pattern
,"maxmemory",0)) {
9725 snprintf(buf
,128,"%llu\n",server
.maxmemory
);
9726 addReplyBulkCString(c
,"maxmemory");
9727 addReplyBulkCString(c
,buf
);
9731 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%d\r\n",matches
*2);
9734 static void configCommand(redisClient
*c
) {
9735 if (!strcasecmp(c
->argv
[1]->ptr
,"set")) {
9736 if (c
->argc
!= 4) goto badarity
;
9737 configSetCommand(c
);
9738 } else if (!strcasecmp(c
->argv
[1]->ptr
,"get")) {
9739 if (c
->argc
!= 3) goto badarity
;
9740 configGetCommand(c
);
9741 } else if (!strcasecmp(c
->argv
[1]->ptr
,"resetstat")) {
9742 if (c
->argc
!= 2) goto badarity
;
9743 server
.stat_numcommands
= 0;
9744 server
.stat_numconnections
= 0;
9745 server
.stat_expiredkeys
= 0;
9746 server
.stat_starttime
= time(NULL
);
9747 addReply(c
,shared
.ok
);
9749 addReplySds(c
,sdscatprintf(sdsempty(),
9750 "-ERR CONFIG subcommand must be one of GET, SET, RESETSTAT\r\n"));
9755 addReplySds(c
,sdscatprintf(sdsempty(),
9756 "-ERR Wrong number of arguments for CONFIG %s\r\n",
9757 (char*) c
->argv
[1]->ptr
));
9760 /* =========================== Pubsub implementation ======================== */
9762 static void freePubsubPattern(void *p
) {
9763 pubsubPattern
*pat
= p
;
9765 decrRefCount(pat
->pattern
);
9769 static int listMatchPubsubPattern(void *a
, void *b
) {
9770 pubsubPattern
*pa
= a
, *pb
= b
;
9772 return (pa
->client
== pb
->client
) &&
9773 (compareStringObjects(pa
->pattern
,pb
->pattern
) == 0);
9776 /* Subscribe a client to a channel. Returns 1 if the operation succeeded, or
9777 * 0 if the client was already subscribed to that channel. */
9778 static int pubsubSubscribeChannel(redisClient
*c
, robj
*channel
) {
9779 struct dictEntry
*de
;
9780 list
*clients
= NULL
;
9783 /* Add the channel to the client -> channels hash table */
9784 if (dictAdd(c
->pubsub_channels
,channel
,NULL
) == DICT_OK
) {
9786 incrRefCount(channel
);
9787 /* Add the client to the channel -> list of clients hash table */
9788 de
= dictFind(server
.pubsub_channels
,channel
);
9790 clients
= listCreate();
9791 dictAdd(server
.pubsub_channels
,channel
,clients
);
9792 incrRefCount(channel
);
9794 clients
= dictGetEntryVal(de
);
9796 listAddNodeTail(clients
,c
);
9798 /* Notify the client */
9799 addReply(c
,shared
.mbulk3
);
9800 addReply(c
,shared
.subscribebulk
);
9801 addReplyBulk(c
,channel
);
9802 addReplyLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
9806 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9807 * 0 if the client was not subscribed to the specified channel. */
9808 static int pubsubUnsubscribeChannel(redisClient
*c
, robj
*channel
, int notify
) {
9809 struct dictEntry
*de
;
9814 /* Remove the channel from the client -> channels hash table */
9815 incrRefCount(channel
); /* channel may be just a pointer to the same object
9816 we have in the hash tables. Protect it... */
9817 if (dictDelete(c
->pubsub_channels
,channel
) == DICT_OK
) {
9819 /* Remove the client from the channel -> clients list hash table */
9820 de
= dictFind(server
.pubsub_channels
,channel
);
9822 clients
= dictGetEntryVal(de
);
9823 ln
= listSearchKey(clients
,c
);
9825 listDelNode(clients
,ln
);
9826 if (listLength(clients
) == 0) {
9827 /* Free the list and associated hash entry at all if this was
9828 * the latest client, so that it will be possible to abuse
9829 * Redis PUBSUB creating millions of channels. */
9830 dictDelete(server
.pubsub_channels
,channel
);
9833 /* Notify the client */
9835 addReply(c
,shared
.mbulk3
);
9836 addReply(c
,shared
.unsubscribebulk
);
9837 addReplyBulk(c
,channel
);
9838 addReplyLong(c
,dictSize(c
->pubsub_channels
)+
9839 listLength(c
->pubsub_patterns
));
9842 decrRefCount(channel
); /* it is finally safe to release it */
9846 /* Subscribe a client to a pattern. Returns 1 if the operation succeeded, or 0 if the clinet was already subscribed to that pattern. */
9847 static int pubsubSubscribePattern(redisClient
*c
, robj
*pattern
) {
9850 if (listSearchKey(c
->pubsub_patterns
,pattern
) == NULL
) {
9853 listAddNodeTail(c
->pubsub_patterns
,pattern
);
9854 incrRefCount(pattern
);
9855 pat
= zmalloc(sizeof(*pat
));
9856 pat
->pattern
= getDecodedObject(pattern
);
9858 listAddNodeTail(server
.pubsub_patterns
,pat
);
9860 /* Notify the client */
9861 addReply(c
,shared
.mbulk3
);
9862 addReply(c
,shared
.psubscribebulk
);
9863 addReplyBulk(c
,pattern
);
9864 addReplyLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
9868 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9869 * 0 if the client was not subscribed to the specified channel. */
9870 static int pubsubUnsubscribePattern(redisClient
*c
, robj
*pattern
, int notify
) {
9875 incrRefCount(pattern
); /* Protect the object. May be the same we remove */
9876 if ((ln
= listSearchKey(c
->pubsub_patterns
,pattern
)) != NULL
) {
9878 listDelNode(c
->pubsub_patterns
,ln
);
9880 pat
.pattern
= pattern
;
9881 ln
= listSearchKey(server
.pubsub_patterns
,&pat
);
9882 listDelNode(server
.pubsub_patterns
,ln
);
9884 /* Notify the client */
9886 addReply(c
,shared
.mbulk3
);
9887 addReply(c
,shared
.punsubscribebulk
);
9888 addReplyBulk(c
,pattern
);
9889 addReplyLong(c
,dictSize(c
->pubsub_channels
)+
9890 listLength(c
->pubsub_patterns
));
9892 decrRefCount(pattern
);
9896 /* Unsubscribe from all the channels. Return the number of channels the
9897 * client was subscribed from. */
9898 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
) {
9899 dictIterator
*di
= dictGetIterator(c
->pubsub_channels
);
9903 while((de
= dictNext(di
)) != NULL
) {
9904 robj
*channel
= dictGetEntryKey(de
);
9906 count
+= pubsubUnsubscribeChannel(c
,channel
,notify
);
9908 dictReleaseIterator(di
);
9912 /* Unsubscribe from all the patterns. Return the number of patterns the
9913 * client was subscribed from. */
9914 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
) {
9919 listRewind(c
->pubsub_patterns
,&li
);
9920 while ((ln
= listNext(&li
)) != NULL
) {
9921 robj
*pattern
= ln
->value
;
9923 count
+= pubsubUnsubscribePattern(c
,pattern
,notify
);
9928 /* Publish a message */
9929 static int pubsubPublishMessage(robj
*channel
, robj
*message
) {
9931 struct dictEntry
*de
;
9935 /* Send to clients listening for that channel */
9936 de
= dictFind(server
.pubsub_channels
,channel
);
9938 list
*list
= dictGetEntryVal(de
);
9942 listRewind(list
,&li
);
9943 while ((ln
= listNext(&li
)) != NULL
) {
9944 redisClient
*c
= ln
->value
;
9946 addReply(c
,shared
.mbulk3
);
9947 addReply(c
,shared
.messagebulk
);
9948 addReplyBulk(c
,channel
);
9949 addReplyBulk(c
,message
);
9953 /* Send to clients listening to matching channels */
9954 if (listLength(server
.pubsub_patterns
)) {
9955 listRewind(server
.pubsub_patterns
,&li
);
9956 channel
= getDecodedObject(channel
);
9957 while ((ln
= listNext(&li
)) != NULL
) {
9958 pubsubPattern
*pat
= ln
->value
;
9960 if (stringmatchlen((char*)pat
->pattern
->ptr
,
9961 sdslen(pat
->pattern
->ptr
),
9962 (char*)channel
->ptr
,
9963 sdslen(channel
->ptr
),0)) {
9964 addReply(pat
->client
,shared
.mbulk4
);
9965 addReply(pat
->client
,shared
.pmessagebulk
);
9966 addReplyBulk(pat
->client
,pat
->pattern
);
9967 addReplyBulk(pat
->client
,channel
);
9968 addReplyBulk(pat
->client
,message
);
9972 decrRefCount(channel
);
9977 static void subscribeCommand(redisClient
*c
) {
9980 for (j
= 1; j
< c
->argc
; j
++)
9981 pubsubSubscribeChannel(c
,c
->argv
[j
]);
9984 static void unsubscribeCommand(redisClient
*c
) {
9986 pubsubUnsubscribeAllChannels(c
,1);
9991 for (j
= 1; j
< c
->argc
; j
++)
9992 pubsubUnsubscribeChannel(c
,c
->argv
[j
],1);
9996 static void psubscribeCommand(redisClient
*c
) {
9999 for (j
= 1; j
< c
->argc
; j
++)
10000 pubsubSubscribePattern(c
,c
->argv
[j
]);
10003 static void punsubscribeCommand(redisClient
*c
) {
10004 if (c
->argc
== 1) {
10005 pubsubUnsubscribeAllPatterns(c
,1);
10010 for (j
= 1; j
< c
->argc
; j
++)
10011 pubsubUnsubscribePattern(c
,c
->argv
[j
],1);
10015 static void publishCommand(redisClient
*c
) {
10016 int receivers
= pubsubPublishMessage(c
->argv
[1],c
->argv
[2]);
10017 addReplyLong(c
,receivers
);
10020 /* ================================= Debugging ============================== */
10022 static void debugCommand(redisClient
*c
) {
10023 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
10024 *((char*)-1) = 'x';
10025 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
10026 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
10027 addReply(c
,shared
.err
);
10031 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
10032 addReply(c
,shared
.err
);
10035 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
10036 addReply(c
,shared
.ok
);
10037 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
10039 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
10040 addReply(c
,shared
.err
);
10043 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
10044 addReply(c
,shared
.ok
);
10045 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
10046 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
10050 addReply(c
,shared
.nokeyerr
);
10053 key
= dictGetEntryKey(de
);
10054 val
= dictGetEntryVal(de
);
10055 if (!server
.vm_enabled
|| (key
->storage
== REDIS_VM_MEMORY
||
10056 key
->storage
== REDIS_VM_SWAPPING
)) {
10060 if (val
->encoding
< (sizeof(strencoding
)/sizeof(char*))) {
10061 strenc
= strencoding
[val
->encoding
];
10063 snprintf(buf
,64,"unknown encoding %d\n", val
->encoding
);
10066 addReplySds(c
,sdscatprintf(sdsempty(),
10067 "+Key at:%p refcount:%d, value at:%p refcount:%d "
10068 "encoding:%s serializedlength:%lld\r\n",
10069 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
10070 strenc
, (long long) rdbSavedObjectLen(val
,NULL
)));
10072 addReplySds(c
,sdscatprintf(sdsempty(),
10073 "+Key at:%p refcount:%d, value swapped at: page %llu "
10074 "using %llu pages\r\n",
10075 (void*)key
, key
->refcount
, (unsigned long long) key
->vm
.page
,
10076 (unsigned long long) key
->vm
.usedpages
));
10078 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapin") && c
->argc
== 3) {
10079 lookupKeyRead(c
->db
,c
->argv
[2]);
10080 addReply(c
,shared
.ok
);
10081 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
10082 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
10085 if (!server
.vm_enabled
) {
10086 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
10090 addReply(c
,shared
.nokeyerr
);
10093 key
= dictGetEntryKey(de
);
10094 val
= dictGetEntryVal(de
);
10095 /* If the key is shared we want to create a copy */
10096 if (key
->refcount
> 1) {
10097 robj
*newkey
= dupStringObject(key
);
10099 key
= dictGetEntryKey(de
) = newkey
;
10102 if (key
->storage
!= REDIS_VM_MEMORY
) {
10103 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
10104 } else if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
10105 dictGetEntryVal(de
) = NULL
;
10106 addReply(c
,shared
.ok
);
10108 addReply(c
,shared
.err
);
10110 } else if (!strcasecmp(c
->argv
[1]->ptr
,"populate") && c
->argc
== 3) {
10115 if (getLongFromObjectOrReply(c
, c
->argv
[2], &keys
, NULL
) != REDIS_OK
)
10117 for (j
= 0; j
< keys
; j
++) {
10118 snprintf(buf
,sizeof(buf
),"key:%lu",j
);
10119 key
= createStringObject(buf
,strlen(buf
));
10120 if (lookupKeyRead(c
->db
,key
) != NULL
) {
10124 snprintf(buf
,sizeof(buf
),"value:%lu",j
);
10125 val
= createStringObject(buf
,strlen(buf
));
10126 dictAdd(c
->db
->dict
,key
,val
);
10128 addReply(c
,shared
.ok
);
10130 addReplySds(c
,sdsnew(
10131 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPIN <key>|SWAPOUT <key>|RELOAD]\r\n"));
10135 static void _redisAssert(char *estr
, char *file
, int line
) {
10136 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
10137 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true\n",file
,line
,estr
);
10138 #ifdef HAVE_BACKTRACE
10139 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
10140 *((char*)-1) = 'x';
10144 static void _redisPanic(char *msg
, char *file
, int line
) {
10145 redisLog(REDIS_WARNING
,"!!! Software Failure. Press left mouse button to continue");
10146 redisLog(REDIS_WARNING
,"Guru Meditation: %s #%s:%d",msg
,file
,line
);
10147 #ifdef HAVE_BACKTRACE
10148 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
10149 *((char*)-1) = 'x';
10153 /* =================================== Main! ================================ */
10156 int linuxOvercommitMemoryValue(void) {
10157 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
10160 if (!fp
) return -1;
10161 if (fgets(buf
,64,fp
) == NULL
) {
10170 void linuxOvercommitMemoryWarning(void) {
10171 if (linuxOvercommitMemoryValue() == 0) {
10172 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.");
10175 #endif /* __linux__ */
10177 static void daemonize(void) {
10181 if (fork() != 0) exit(0); /* parent exits */
10182 setsid(); /* create a new session */
10184 /* Every output goes to /dev/null. If Redis is daemonized but
10185 * the 'logfile' is set to 'stdout' in the configuration file
10186 * it will not log at all. */
10187 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
10188 dup2(fd
, STDIN_FILENO
);
10189 dup2(fd
, STDOUT_FILENO
);
10190 dup2(fd
, STDERR_FILENO
);
10191 if (fd
> STDERR_FILENO
) close(fd
);
10193 /* Try to write the pid file */
10194 fp
= fopen(server
.pidfile
,"w");
10196 fprintf(fp
,"%d\n",getpid());
10201 static void version() {
10202 printf("Redis server version %s\n", REDIS_VERSION
);
10206 static void usage() {
10207 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
10208 fprintf(stderr
," ./redis-server - (read config from stdin)\n");
10212 int main(int argc
, char **argv
) {
10215 initServerConfig();
10217 if (strcmp(argv
[1], "-v") == 0 ||
10218 strcmp(argv
[1], "--version") == 0) version();
10219 if (strcmp(argv
[1], "--help") == 0) usage();
10220 resetServerSaveParams();
10221 loadServerConfig(argv
[1]);
10222 } else if ((argc
> 2)) {
10225 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'");
10227 if (server
.daemonize
) daemonize();
10229 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
10231 linuxOvercommitMemoryWarning();
10233 start
= time(NULL
);
10234 if (server
.appendonly
) {
10235 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
10236 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %ld seconds",time(NULL
)-start
);
10238 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
10239 redisLog(REDIS_NOTICE
,"DB loaded from disk: %ld seconds",time(NULL
)-start
);
10241 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
10242 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
10244 aeDeleteEventLoop(server
.el
);
10248 /* ============================= Backtrace support ========================= */
10250 #ifdef HAVE_BACKTRACE
10251 static char *findFuncName(void *pointer
, unsigned long *offset
);
10253 static void *getMcontextEip(ucontext_t
*uc
) {
10254 #if defined(__FreeBSD__)
10255 return (void*) uc
->uc_mcontext
.mc_eip
;
10256 #elif defined(__dietlibc__)
10257 return (void*) uc
->uc_mcontext
.eip
;
10258 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
10260 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
10262 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
10264 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
10265 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
10266 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
10268 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
10270 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
10271 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
10272 #elif defined(__ia64__) /* Linux IA64 */
10273 return (void*) uc
->uc_mcontext
.sc_ip
;
10279 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
10281 char **messages
= NULL
;
10282 int i
, trace_size
= 0;
10283 unsigned long offset
=0;
10284 ucontext_t
*uc
= (ucontext_t
*) secret
;
10286 REDIS_NOTUSED(info
);
10288 redisLog(REDIS_WARNING
,
10289 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
10290 infostring
= genRedisInfoString();
10291 redisLog(REDIS_WARNING
, "%s",infostring
);
10292 /* It's not safe to sdsfree() the returned string under memory
10293 * corruption conditions. Let it leak as we are going to abort */
10295 trace_size
= backtrace(trace
, 100);
10296 /* overwrite sigaction with caller's address */
10297 if (getMcontextEip(uc
) != NULL
) {
10298 trace
[1] = getMcontextEip(uc
);
10300 messages
= backtrace_symbols(trace
, trace_size
);
10302 for (i
=1; i
<trace_size
; ++i
) {
10303 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
10305 p
= strchr(messages
[i
],'+');
10306 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
10307 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
10309 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
10312 /* free(messages); Don't call free() with possibly corrupted memory. */
10316 static void setupSigSegvAction(void) {
10317 struct sigaction act
;
10319 sigemptyset (&act
.sa_mask
);
10320 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
10321 * is used. Otherwise, sa_handler is used */
10322 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
10323 act
.sa_sigaction
= segvHandler
;
10324 sigaction (SIGSEGV
, &act
, NULL
);
10325 sigaction (SIGBUS
, &act
, NULL
);
10326 sigaction (SIGFPE
, &act
, NULL
);
10327 sigaction (SIGILL
, &act
, NULL
);
10328 sigaction (SIGBUS
, &act
, NULL
);
10332 #include "staticsymbols.h"
10333 /* This function try to convert a pointer into a function name. It's used in
10334 * oreder to provide a backtrace under segmentation fault that's able to
10335 * display functions declared as static (otherwise the backtrace is useless). */
10336 static char *findFuncName(void *pointer
, unsigned long *offset
){
10338 unsigned long off
, minoff
= 0;
10340 /* Try to match against the Symbol with the smallest offset */
10341 for (i
=0; symsTable
[i
].pointer
; i
++) {
10342 unsigned long lp
= (unsigned long) pointer
;
10344 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
10345 off
=lp
-symsTable
[i
].pointer
;
10346 if (ret
< 0 || off
< minoff
) {
10352 if (ret
== -1) return NULL
;
10354 return symsTable
[ret
].name
;
10356 #else /* HAVE_BACKTRACE */
10357 static void setupSigSegvAction(void) {
10359 #endif /* HAVE_BACKTRACE */