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 "2.1.1"
45 #endif /* HAVE_BACKTRACE */
53 #include <arpa/inet.h>
57 #include <sys/resource.h>
65 #include "solarisfixes.h"
69 #include "ae.h" /* Event driven programming library */
70 #include "sds.h" /* Dynamic safe strings */
71 #include "anet.h" /* Networking the easy way */
72 #include "dict.h" /* Hash tables */
73 #include "adlist.h" /* Linked lists */
74 #include "zmalloc.h" /* total memory usage aware version of malloc/free */
75 #include "lzf.h" /* LZF compression library */
76 #include "pqsort.h" /* Partial qsort for SORT+LIMIT */
77 #include "zipmap.h" /* Compact dictionary-alike data structure */
78 #include "ziplist.h" /* Compact list data structure */
79 #include "sha1.h" /* SHA1 is used for DEBUG DIGEST */
80 #include "release.h" /* Release and/or git repository information */
86 /* Static server configuration */
87 #define REDIS_SERVERPORT 6379 /* TCP port */
88 #define REDIS_MAXIDLETIME (60*5) /* default client timeout */
89 #define REDIS_IOBUF_LEN 1024
90 #define REDIS_LOADBUF_LEN 1024
91 #define REDIS_STATIC_ARGS 8
92 #define REDIS_DEFAULT_DBNUM 16
93 #define REDIS_CONFIGLINE_MAX 1024
94 #define REDIS_OBJFREELIST_MAX 1000000 /* Max number of objects to cache */
95 #define REDIS_MAX_SYNC_TIME 60 /* Slave can't take more to sync */
96 #define REDIS_EXPIRELOOKUPS_PER_CRON 10 /* lookup 10 expires per loop */
97 #define REDIS_MAX_WRITE_PER_EVENT (1024*64)
98 #define REDIS_REQUEST_MAX_SIZE (1024*1024*256) /* max bytes in inline command */
100 /* If more then REDIS_WRITEV_THRESHOLD write packets are pending use writev */
101 #define REDIS_WRITEV_THRESHOLD 3
102 /* Max number of iovecs used for each writev call */
103 #define REDIS_WRITEV_IOVEC_COUNT 256
105 /* Hash table parameters */
106 #define REDIS_HT_MINFILL 10 /* Minimal hash table fill 10% */
109 #define REDIS_CMD_BULK 1 /* Bulk write command */
110 #define REDIS_CMD_INLINE 2 /* Inline command */
111 /* REDIS_CMD_DENYOOM reserves a longer comment: all the commands marked with
112 this flags will return an error when the 'maxmemory' option is set in the
113 config file and the server is using more than maxmemory bytes of memory.
114 In short this commands are denied on low memory conditions. */
115 #define REDIS_CMD_DENYOOM 4
116 #define REDIS_CMD_FORCE_REPLICATION 8 /* Force replication even if dirty is 0 */
119 #define REDIS_STRING 0
125 /* Objects encoding. Some kind of objects like Strings and Hashes can be
126 * internally represented in multiple ways. The 'encoding' field of the object
127 * is set to one of this fields for this object. */
128 #define REDIS_ENCODING_RAW 0 /* Raw representation */
129 #define REDIS_ENCODING_INT 1 /* Encoded as integer */
130 #define REDIS_ENCODING_HT 2 /* Encoded as hash table */
131 #define REDIS_ENCODING_ZIPMAP 3 /* Encoded as zipmap */
132 #define REDIS_ENCODING_LIST 4 /* Encoded as zipmap */
133 #define REDIS_ENCODING_ZIPLIST 5 /* Encoded as ziplist */
135 static char* strencoding
[] = {
136 "raw", "int", "zipmap", "hashtable"
139 /* Object types only used for dumping to disk */
140 #define REDIS_EXPIRETIME 253
141 #define REDIS_SELECTDB 254
142 #define REDIS_EOF 255
144 /* Defines related to the dump file format. To store 32 bits lengths for short
145 * keys requires a lot of space, so we check the most significant 2 bits of
146 * the first byte to interpreter the length:
148 * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
149 * 01|000000 00000000 => 01, the len is 14 byes, 6 bits + 8 bits of next byte
150 * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
151 * 11|000000 this means: specially encoded object will follow. The six bits
152 * number specify the kind of object that follows.
153 * See the REDIS_RDB_ENC_* defines.
155 * Lenghts up to 63 are stored using a single byte, most DB keys, and may
156 * values, will fit inside. */
157 #define REDIS_RDB_6BITLEN 0
158 #define REDIS_RDB_14BITLEN 1
159 #define REDIS_RDB_32BITLEN 2
160 #define REDIS_RDB_ENCVAL 3
161 #define REDIS_RDB_LENERR UINT_MAX
163 /* When a length of a string object stored on disk has the first two bits
164 * set, the remaining two bits specify a special encoding for the object
165 * accordingly to the following defines: */
166 #define REDIS_RDB_ENC_INT8 0 /* 8 bit signed integer */
167 #define REDIS_RDB_ENC_INT16 1 /* 16 bit signed integer */
168 #define REDIS_RDB_ENC_INT32 2 /* 32 bit signed integer */
169 #define REDIS_RDB_ENC_LZF 3 /* string compressed with FASTLZ */
171 /* Virtual memory object->where field. */
172 #define REDIS_VM_MEMORY 0 /* The object is on memory */
173 #define REDIS_VM_SWAPPED 1 /* The object is on disk */
174 #define REDIS_VM_SWAPPING 2 /* Redis is swapping this object on disk */
175 #define REDIS_VM_LOADING 3 /* Redis is loading this object from disk */
177 /* Virtual memory static configuration stuff.
178 * Check vmFindContiguousPages() to know more about this magic numbers. */
179 #define REDIS_VM_MAX_NEAR_PAGES 65536
180 #define REDIS_VM_MAX_RANDOM_JUMP 4096
181 #define REDIS_VM_MAX_THREADS 32
182 #define REDIS_THREAD_STACK_SIZE (1024*1024*4)
183 /* The following is the *percentage* of completed I/O jobs to process when the
184 * handelr is called. While Virtual Memory I/O operations are performed by
185 * threads, this operations must be processed by the main thread when completed
186 * in order to take effect. */
187 #define REDIS_MAX_COMPLETED_JOBS_PROCESSED 1
190 #define REDIS_SLAVE 1 /* This client is a slave server */
191 #define REDIS_MASTER 2 /* This client is a master server */
192 #define REDIS_MONITOR 4 /* This client is a slave monitor, see MONITOR */
193 #define REDIS_MULTI 8 /* This client is in a MULTI context */
194 #define REDIS_BLOCKED 16 /* The client is waiting in a blocking operation */
195 #define REDIS_IO_WAIT 32 /* The client is waiting for Virtual Memory I/O */
196 #define REDIS_DIRTY_CAS 64 /* Watched keys modified. EXEC will fail. */
198 /* Slave replication state - slave side */
199 #define REDIS_REPL_NONE 0 /* No active replication */
200 #define REDIS_REPL_CONNECT 1 /* Must connect to master */
201 #define REDIS_REPL_CONNECTED 2 /* Connected to master */
203 /* Slave replication state - from the point of view of master
204 * Note that in SEND_BULK and ONLINE state the slave receives new updates
205 * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
206 * to start the next background saving in order to send updates to it. */
207 #define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
208 #define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
209 #define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
210 #define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
212 /* List related stuff */
216 /* Sort operations */
217 #define REDIS_SORT_GET 0
218 #define REDIS_SORT_ASC 1
219 #define REDIS_SORT_DESC 2
220 #define REDIS_SORTKEY_MAX 1024
223 #define REDIS_DEBUG 0
224 #define REDIS_VERBOSE 1
225 #define REDIS_NOTICE 2
226 #define REDIS_WARNING 3
228 /* Anti-warning macro... */
229 #define REDIS_NOTUSED(V) ((void) V)
231 #define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
232 #define ZSKIPLIST_P 0.25 /* Skiplist P = 1/4 */
234 /* Append only defines */
235 #define APPENDFSYNC_NO 0
236 #define APPENDFSYNC_ALWAYS 1
237 #define APPENDFSYNC_EVERYSEC 2
239 /* Hashes related defaults */
240 #define REDIS_HASH_MAX_ZIPMAP_ENTRIES 64
241 #define REDIS_HASH_MAX_ZIPMAP_VALUE 512
243 /* We can print the stacktrace, so our assert is defined this way: */
244 #define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
245 #define redisPanic(_e) _redisPanic(#_e,__FILE__,__LINE__),_exit(1)
246 static void _redisAssert(char *estr
, char *file
, int line
);
247 static void _redisPanic(char *msg
, char *file
, int line
);
249 /*================================= Data types ============================== */
251 /* A redis object, that is a type able to hold a string / list / set */
253 /* The VM object structure */
254 struct redisObjectVM
{
255 off_t page
; /* the page at witch the object is stored on disk */
256 off_t usedpages
; /* number of pages used on disk */
257 time_t atime
; /* Last access time */
260 /* The actual Redis Object */
261 typedef struct redisObject
{
264 unsigned char encoding
;
265 unsigned char storage
; /* If this object is a key, where is the value?
266 * REDIS_VM_MEMORY, REDIS_VM_SWAPPED, ... */
267 unsigned char vtype
; /* If this object is a key, and value is swapped out,
268 * this is the type of the swapped out object. */
270 /* VM fields, this are only allocated if VM is active, otherwise the
271 * object allocation function will just allocate
272 * sizeof(redisObjct) minus sizeof(redisObjectVM), so using
273 * Redis without VM active will not have any overhead. */
274 struct redisObjectVM vm
;
277 /* Macro used to initalize a Redis object allocated on the stack.
278 * Note that this macro is taken near the structure definition to make sure
279 * we'll update it when the structure is changed, to avoid bugs like
280 * bug #85 introduced exactly in this way. */
281 #define initStaticStringObject(_var,_ptr) do { \
283 _var.type = REDIS_STRING; \
284 _var.encoding = REDIS_ENCODING_RAW; \
286 if (server.vm_enabled) _var.storage = REDIS_VM_MEMORY; \
289 typedef struct redisDb
{
290 dict
*dict
; /* The keyspace for this DB */
291 dict
*expires
; /* Timeout of keys with a timeout set */
292 dict
*blocking_keys
; /* Keys with clients waiting for data (BLPOP) */
293 dict
*io_keys
; /* Keys with clients waiting for VM I/O */
294 dict
*watched_keys
; /* WATCHED keys for MULTI/EXEC CAS */
298 /* Client MULTI/EXEC state */
299 typedef struct multiCmd
{
302 struct redisCommand
*cmd
;
305 typedef struct multiState
{
306 multiCmd
*commands
; /* Array of MULTI commands */
307 int count
; /* Total number of MULTI commands */
310 /* With multiplexing we need to take per-clinet state.
311 * Clients are taken in a liked list. */
312 typedef struct redisClient
{
317 robj
**argv
, **mbargv
;
319 int bulklen
; /* bulk read len. -1 if not in bulk read mode */
320 int multibulk
; /* multi bulk command format active */
323 time_t lastinteraction
; /* time of the last interaction, used for timeout */
324 int flags
; /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
325 int slaveseldb
; /* slave selected db, if this client is a slave */
326 int authenticated
; /* when requirepass is non-NULL */
327 int replstate
; /* replication state if this is a slave */
328 int repldbfd
; /* replication DB file descriptor */
329 long repldboff
; /* replication DB file offset */
330 off_t repldbsize
; /* replication DB file size */
331 multiState mstate
; /* MULTI/EXEC state */
332 robj
**blocking_keys
; /* The key we are waiting to terminate a blocking
333 * operation such as BLPOP. Otherwise NULL. */
334 int blocking_keys_num
; /* Number of blocking keys */
335 time_t blockingto
; /* Blocking operation timeout. If UNIX current time
336 * is >= blockingto then the operation timed out. */
337 list
*io_keys
; /* Keys this client is waiting to be loaded from the
338 * swap file in order to continue. */
339 list
*watched_keys
; /* Keys WATCHED for MULTI/EXEC CAS */
340 dict
*pubsub_channels
; /* channels a client is interested in (SUBSCRIBE) */
341 list
*pubsub_patterns
; /* patterns a client is interested in (SUBSCRIBE) */
349 /* Global server state structure */
354 long long dirty
; /* changes to DB from the last save */
356 list
*slaves
, *monitors
;
357 char neterr
[ANET_ERR_LEN
];
359 int cronloops
; /* number of times the cron function run */
360 list
*objfreelist
; /* A list of freed objects to avoid malloc() */
361 time_t lastsave
; /* Unix time of last save succeeede */
362 /* Fields used only for stats */
363 time_t stat_starttime
; /* server start time */
364 long long stat_numcommands
; /* number of processed commands */
365 long long stat_numconnections
; /* number of connections received */
366 long long stat_expiredkeys
; /* number of expired keys */
380 pid_t bgsavechildpid
;
381 pid_t bgrewritechildpid
;
382 sds bgrewritebuf
; /* buffer taken by parent during oppend only rewrite */
383 sds aofbuf
; /* AOF buffer, written before entering the event loop */
384 struct saveparam
*saveparams
;
389 char *appendfilename
;
393 /* Replication related */
398 redisClient
*master
; /* client that is master for this slave */
400 unsigned int maxclients
;
401 unsigned long long maxmemory
;
402 unsigned int blpop_blocked_clients
;
403 unsigned int vm_blocked_clients
;
404 /* Sort parameters - qsort_r() is only available under BSD so we
405 * have to take this state global, in order to pass it to sortCompare() */
409 /* Virtual memory configuration */
414 unsigned long long vm_max_memory
;
416 size_t hash_max_zipmap_entries
;
417 size_t hash_max_zipmap_value
;
418 /* Virtual memory state */
421 off_t vm_next_page
; /* Next probably empty page */
422 off_t vm_near_pages
; /* Number of pages allocated sequentially */
423 unsigned char *vm_bitmap
; /* Bitmap of free/used pages */
424 time_t unixtime
; /* Unix time sampled every second. */
425 /* Virtual memory I/O threads stuff */
426 /* An I/O thread process an element taken from the io_jobs queue and
427 * put the result of the operation in the io_done list. While the
428 * job is being processed, it's put on io_processing queue. */
429 list
*io_newjobs
; /* List of VM I/O jobs yet to be processed */
430 list
*io_processing
; /* List of VM I/O jobs being processed */
431 list
*io_processed
; /* List of VM I/O jobs already processed */
432 list
*io_ready_clients
; /* Clients ready to be unblocked. All keys loaded */
433 pthread_mutex_t io_mutex
; /* lock to access io_jobs/io_done/io_thread_job */
434 pthread_mutex_t obj_freelist_mutex
; /* safe redis objects creation/free */
435 pthread_mutex_t io_swapfile_mutex
; /* So we can lseek + write */
436 pthread_attr_t io_threads_attr
; /* attributes for threads creation */
437 int io_active_threads
; /* Number of running I/O threads */
438 int vm_max_threads
; /* Max number of I/O threads running at the same time */
439 /* Our main thread is blocked on the event loop, locking for sockets ready
440 * to be read or written, so when a threaded I/O operation is ready to be
441 * processed by the main thread, the I/O thread will use a unix pipe to
442 * awake the main thread. The followings are the two pipe FDs. */
443 int io_ready_pipe_read
;
444 int io_ready_pipe_write
;
445 /* Virtual memory stats */
446 unsigned long long vm_stats_used_pages
;
447 unsigned long long vm_stats_swapped_objects
;
448 unsigned long long vm_stats_swapouts
;
449 unsigned long long vm_stats_swapins
;
451 dict
*pubsub_channels
; /* Map channels to list of subscribed clients */
452 list
*pubsub_patterns
; /* A list of pubsub_patterns */
457 typedef struct pubsubPattern
{
462 typedef void redisCommandProc(redisClient
*c
);
463 typedef void redisVmPreloadProc(redisClient
*c
, struct redisCommand
*cmd
, int argc
, robj
**argv
);
464 struct redisCommand
{
466 redisCommandProc
*proc
;
469 /* Use a function to determine which keys need to be loaded
470 * in the background prior to executing this command. Takes precedence
471 * over vm_firstkey and others, ignored when NULL */
472 redisVmPreloadProc
*vm_preload_proc
;
473 /* What keys should be loaded in background when calling this command? */
474 int vm_firstkey
; /* The first argument that's a key (0 = no keys) */
475 int vm_lastkey
; /* THe last argument that's a key */
476 int vm_keystep
; /* The step between first and last key */
479 struct redisFunctionSym
{
481 unsigned long pointer
;
484 typedef struct _redisSortObject
{
492 typedef struct _redisSortOperation
{
495 } redisSortOperation
;
497 /* ZSETs use a specialized version of Skiplists */
499 typedef struct zskiplistNode
{
500 struct zskiplistNode
**forward
;
501 struct zskiplistNode
*backward
;
507 typedef struct zskiplist
{
508 struct zskiplistNode
*header
, *tail
;
509 unsigned long length
;
513 typedef struct zset
{
518 /* Our shared "common" objects */
520 #define REDIS_SHARED_INTEGERS 10000
521 struct sharedObjectsStruct
{
522 robj
*crlf
, *ok
, *err
, *emptybulk
, *czero
, *cone
, *pong
, *space
,
523 *colon
, *nullbulk
, *nullmultibulk
, *queued
,
524 *emptymultibulk
, *wrongtypeerr
, *nokeyerr
, *syntaxerr
, *sameobjecterr
,
525 *outofrangeerr
, *plus
,
526 *select0
, *select1
, *select2
, *select3
, *select4
,
527 *select5
, *select6
, *select7
, *select8
, *select9
,
528 *messagebulk
, *pmessagebulk
, *subscribebulk
, *unsubscribebulk
, *mbulk3
,
529 *mbulk4
, *psubscribebulk
, *punsubscribebulk
,
530 *integers
[REDIS_SHARED_INTEGERS
];
533 /* Global vars that are actally used as constants. The following double
534 * values are used for double on-disk serialization, and are initialized
535 * at runtime to avoid strange compiler optimizations. */
537 static double R_Zero
, R_PosInf
, R_NegInf
, R_Nan
;
539 /* VM threaded I/O request message */
540 #define REDIS_IOJOB_LOAD 0 /* Load from disk to memory */
541 #define REDIS_IOJOB_PREPARE_SWAP 1 /* Compute needed pages */
542 #define REDIS_IOJOB_DO_SWAP 2 /* Swap from memory to disk */
543 typedef struct iojob
{
544 int type
; /* Request type, REDIS_IOJOB_* */
545 redisDb
*db
;/* Redis database */
546 robj
*key
; /* This I/O request is about swapping this key */
547 robj
*val
; /* the value to swap for REDIS_IOREQ_*_SWAP, otherwise this
548 * field is populated by the I/O thread for REDIS_IOREQ_LOAD. */
549 off_t page
; /* Swap page where to read/write the object */
550 off_t pages
; /* Swap pages needed to save object. PREPARE_SWAP return val */
551 int canceled
; /* True if this command was canceled by blocking side of VM */
552 pthread_t thread
; /* ID of the thread processing this entry */
555 /*================================ Prototypes =============================== */
557 static void freeStringObject(robj
*o
);
558 static void freeListObject(robj
*o
);
559 static void freeSetObject(robj
*o
);
560 static void decrRefCount(void *o
);
561 static robj
*createObject(int type
, void *ptr
);
562 static void freeClient(redisClient
*c
);
563 static int rdbLoad(char *filename
);
564 static void addReply(redisClient
*c
, robj
*obj
);
565 static void addReplySds(redisClient
*c
, sds s
);
566 static void incrRefCount(robj
*o
);
567 static int rdbSaveBackground(char *filename
);
568 static robj
*createStringObject(char *ptr
, size_t len
);
569 static robj
*dupStringObject(robj
*o
);
570 static void replicationFeedSlaves(list
*slaves
, int dictid
, robj
**argv
, int argc
);
571 static void replicationFeedMonitors(list
*monitors
, int dictid
, robj
**argv
, int argc
);
572 static void flushAppendOnlyFile(void);
573 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
574 static int syncWithMaster(void);
575 static robj
*tryObjectEncoding(robj
*o
);
576 static robj
*getDecodedObject(robj
*o
);
577 static int removeExpire(redisDb
*db
, robj
*key
);
578 static int expireIfNeeded(redisDb
*db
, robj
*key
);
579 static int deleteIfVolatile(redisDb
*db
, robj
*key
);
580 static int deleteIfSwapped(redisDb
*db
, robj
*key
);
581 static int deleteKey(redisDb
*db
, robj
*key
);
582 static time_t getExpire(redisDb
*db
, robj
*key
);
583 static int setExpire(redisDb
*db
, robj
*key
, time_t when
);
584 static void updateSlavesWaitingBgsave(int bgsaveerr
);
585 static void freeMemoryIfNeeded(void);
586 static int processCommand(redisClient
*c
);
587 static void setupSigSegvAction(void);
588 static void rdbRemoveTempFile(pid_t childpid
);
589 static void aofRemoveTempFile(pid_t childpid
);
590 static size_t stringObjectLen(robj
*o
);
591 static void processInputBuffer(redisClient
*c
);
592 static zskiplist
*zslCreate(void);
593 static void zslFree(zskiplist
*zsl
);
594 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
);
595 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
596 static void initClientMultiState(redisClient
*c
);
597 static void freeClientMultiState(redisClient
*c
);
598 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
);
599 static void unblockClientWaitingData(redisClient
*c
);
600 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
);
601 static void vmInit(void);
602 static void vmMarkPagesFree(off_t page
, off_t count
);
603 static robj
*vmLoadObject(robj
*key
);
604 static robj
*vmPreviewObject(robj
*key
);
605 static int vmSwapOneObjectBlocking(void);
606 static int vmSwapOneObjectThreaded(void);
607 static int vmCanSwapOut(void);
608 static int tryFreeOneObjectFromFreelist(void);
609 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
610 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
611 static void vmCancelThreadedIOJob(robj
*o
);
612 static void lockThreadedIO(void);
613 static void unlockThreadedIO(void);
614 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
);
615 static void freeIOJob(iojob
*j
);
616 static void queueIOJob(iojob
*j
);
617 static int vmWriteObjectOnSwap(robj
*o
, off_t page
);
618 static robj
*vmReadObjectFromSwap(off_t page
, int type
);
619 static void waitEmptyIOJobsQueue(void);
620 static void vmReopenSwapFile(void);
621 static int vmFreePage(off_t page
);
622 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
, int argc
, robj
**argv
);
623 static void execBlockClientOnSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
, int argc
, robj
**argv
);
624 static int blockClientOnSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
);
625 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
);
626 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
);
627 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
628 static struct redisCommand
*lookupCommand(char *name
);
629 static void call(redisClient
*c
, struct redisCommand
*cmd
);
630 static void resetClient(redisClient
*c
);
631 static void convertToRealHash(robj
*o
);
632 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
);
633 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
);
634 static void freePubsubPattern(void *p
);
635 static int listMatchPubsubPattern(void *a
, void *b
);
636 static int compareStringObjects(robj
*a
, robj
*b
);
637 static int equalStringObjects(robj
*a
, robj
*b
);
639 static int rewriteAppendOnlyFileBackground(void);
640 static int vmSwapObjectBlocking(robj
*key
, robj
*val
);
641 static int prepareForShutdown();
642 static void touchWatchedKey(redisDb
*db
, robj
*key
);
643 static void touchWatchedKeysOnFlush(int dbid
);
644 static void unwatchAllKeys(redisClient
*c
);
646 static void authCommand(redisClient
*c
);
647 static void pingCommand(redisClient
*c
);
648 static void echoCommand(redisClient
*c
);
649 static void setCommand(redisClient
*c
);
650 static void setnxCommand(redisClient
*c
);
651 static void setexCommand(redisClient
*c
);
652 static void getCommand(redisClient
*c
);
653 static void delCommand(redisClient
*c
);
654 static void existsCommand(redisClient
*c
);
655 static void incrCommand(redisClient
*c
);
656 static void decrCommand(redisClient
*c
);
657 static void incrbyCommand(redisClient
*c
);
658 static void decrbyCommand(redisClient
*c
);
659 static void selectCommand(redisClient
*c
);
660 static void randomkeyCommand(redisClient
*c
);
661 static void keysCommand(redisClient
*c
);
662 static void dbsizeCommand(redisClient
*c
);
663 static void lastsaveCommand(redisClient
*c
);
664 static void saveCommand(redisClient
*c
);
665 static void bgsaveCommand(redisClient
*c
);
666 static void bgrewriteaofCommand(redisClient
*c
);
667 static void shutdownCommand(redisClient
*c
);
668 static void moveCommand(redisClient
*c
);
669 static void renameCommand(redisClient
*c
);
670 static void renamenxCommand(redisClient
*c
);
671 static void lpushCommand(redisClient
*c
);
672 static void rpushCommand(redisClient
*c
);
673 static void lpopCommand(redisClient
*c
);
674 static void rpopCommand(redisClient
*c
);
675 static void llenCommand(redisClient
*c
);
676 static void lindexCommand(redisClient
*c
);
677 static void lrangeCommand(redisClient
*c
);
678 static void ltrimCommand(redisClient
*c
);
679 static void typeCommand(redisClient
*c
);
680 static void lsetCommand(redisClient
*c
);
681 static void saddCommand(redisClient
*c
);
682 static void sremCommand(redisClient
*c
);
683 static void smoveCommand(redisClient
*c
);
684 static void sismemberCommand(redisClient
*c
);
685 static void scardCommand(redisClient
*c
);
686 static void spopCommand(redisClient
*c
);
687 static void srandmemberCommand(redisClient
*c
);
688 static void sinterCommand(redisClient
*c
);
689 static void sinterstoreCommand(redisClient
*c
);
690 static void sunionCommand(redisClient
*c
);
691 static void sunionstoreCommand(redisClient
*c
);
692 static void sdiffCommand(redisClient
*c
);
693 static void sdiffstoreCommand(redisClient
*c
);
694 static void syncCommand(redisClient
*c
);
695 static void flushdbCommand(redisClient
*c
);
696 static void flushallCommand(redisClient
*c
);
697 static void sortCommand(redisClient
*c
);
698 static void lremCommand(redisClient
*c
);
699 static void rpoplpushcommand(redisClient
*c
);
700 static void infoCommand(redisClient
*c
);
701 static void mgetCommand(redisClient
*c
);
702 static void monitorCommand(redisClient
*c
);
703 static void expireCommand(redisClient
*c
);
704 static void expireatCommand(redisClient
*c
);
705 static void getsetCommand(redisClient
*c
);
706 static void ttlCommand(redisClient
*c
);
707 static void slaveofCommand(redisClient
*c
);
708 static void debugCommand(redisClient
*c
);
709 static void msetCommand(redisClient
*c
);
710 static void msetnxCommand(redisClient
*c
);
711 static void zaddCommand(redisClient
*c
);
712 static void zincrbyCommand(redisClient
*c
);
713 static void zrangeCommand(redisClient
*c
);
714 static void zrangebyscoreCommand(redisClient
*c
);
715 static void zcountCommand(redisClient
*c
);
716 static void zrevrangeCommand(redisClient
*c
);
717 static void zcardCommand(redisClient
*c
);
718 static void zremCommand(redisClient
*c
);
719 static void zscoreCommand(redisClient
*c
);
720 static void zremrangebyscoreCommand(redisClient
*c
);
721 static void multiCommand(redisClient
*c
);
722 static void execCommand(redisClient
*c
);
723 static void discardCommand(redisClient
*c
);
724 static void blpopCommand(redisClient
*c
);
725 static void brpopCommand(redisClient
*c
);
726 static void appendCommand(redisClient
*c
);
727 static void substrCommand(redisClient
*c
);
728 static void zrankCommand(redisClient
*c
);
729 static void zrevrankCommand(redisClient
*c
);
730 static void hsetCommand(redisClient
*c
);
731 static void hsetnxCommand(redisClient
*c
);
732 static void hgetCommand(redisClient
*c
);
733 static void hmsetCommand(redisClient
*c
);
734 static void hmgetCommand(redisClient
*c
);
735 static void hdelCommand(redisClient
*c
);
736 static void hlenCommand(redisClient
*c
);
737 static void zremrangebyrankCommand(redisClient
*c
);
738 static void zunionstoreCommand(redisClient
*c
);
739 static void zinterstoreCommand(redisClient
*c
);
740 static void hkeysCommand(redisClient
*c
);
741 static void hvalsCommand(redisClient
*c
);
742 static void hgetallCommand(redisClient
*c
);
743 static void hexistsCommand(redisClient
*c
);
744 static void configCommand(redisClient
*c
);
745 static void hincrbyCommand(redisClient
*c
);
746 static void subscribeCommand(redisClient
*c
);
747 static void unsubscribeCommand(redisClient
*c
);
748 static void psubscribeCommand(redisClient
*c
);
749 static void punsubscribeCommand(redisClient
*c
);
750 static void publishCommand(redisClient
*c
);
751 static void watchCommand(redisClient
*c
);
752 static void unwatchCommand(redisClient
*c
);
754 /*================================= Globals ================================= */
757 static struct redisServer server
; /* server global state */
758 static struct redisCommand
*commandTable
;
759 static struct redisCommand readonlyCommandTable
[] = {
760 {"get",getCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
761 {"set",setCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
762 {"setnx",setnxCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
763 {"setex",setexCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
764 {"append",appendCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
765 {"substr",substrCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
766 {"del",delCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
767 {"exists",existsCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
768 {"incr",incrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
769 {"decr",decrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
770 {"mget",mgetCommand
,-2,REDIS_CMD_INLINE
,NULL
,1,-1,1},
771 {"rpush",rpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
772 {"lpush",lpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
773 {"rpop",rpopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
774 {"lpop",lpopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
775 {"brpop",brpopCommand
,-3,REDIS_CMD_INLINE
,NULL
,1,1,1},
776 {"blpop",blpopCommand
,-3,REDIS_CMD_INLINE
,NULL
,1,1,1},
777 {"llen",llenCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
778 {"lindex",lindexCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
779 {"lset",lsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
780 {"lrange",lrangeCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
781 {"ltrim",ltrimCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
782 {"lrem",lremCommand
,4,REDIS_CMD_BULK
,NULL
,1,1,1},
783 {"rpoplpush",rpoplpushcommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,2,1},
784 {"sadd",saddCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
785 {"srem",sremCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
786 {"smove",smoveCommand
,4,REDIS_CMD_BULK
,NULL
,1,2,1},
787 {"sismember",sismemberCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
788 {"scard",scardCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
789 {"spop",spopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
790 {"srandmember",srandmemberCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
791 {"sinter",sinterCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
792 {"sinterstore",sinterstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
793 {"sunion",sunionCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
794 {"sunionstore",sunionstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
795 {"sdiff",sdiffCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
796 {"sdiffstore",sdiffstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
797 {"smembers",sinterCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
798 {"zadd",zaddCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
799 {"zincrby",zincrbyCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
800 {"zrem",zremCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
801 {"zremrangebyscore",zremrangebyscoreCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
802 {"zremrangebyrank",zremrangebyrankCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
803 {"zunionstore",zunionstoreCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,zunionInterBlockClientOnSwappedKeys
,0,0,0},
804 {"zinterstore",zinterstoreCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,zunionInterBlockClientOnSwappedKeys
,0,0,0},
805 {"zrange",zrangeCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
806 {"zrangebyscore",zrangebyscoreCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
807 {"zcount",zcountCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
808 {"zrevrange",zrevrangeCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
809 {"zcard",zcardCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
810 {"zscore",zscoreCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
811 {"zrank",zrankCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
812 {"zrevrank",zrevrankCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
813 {"hset",hsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
814 {"hsetnx",hsetnxCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
815 {"hget",hgetCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
816 {"hmset",hmsetCommand
,-4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
817 {"hmget",hmgetCommand
,-3,REDIS_CMD_BULK
,NULL
,1,1,1},
818 {"hincrby",hincrbyCommand
,4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
819 {"hdel",hdelCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
820 {"hlen",hlenCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
821 {"hkeys",hkeysCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
822 {"hvals",hvalsCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
823 {"hgetall",hgetallCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
824 {"hexists",hexistsCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
825 {"incrby",incrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
826 {"decrby",decrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
827 {"getset",getsetCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
828 {"mset",msetCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,-1,2},
829 {"msetnx",msetnxCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,-1,2},
830 {"randomkey",randomkeyCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
831 {"select",selectCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
832 {"move",moveCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
833 {"rename",renameCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
834 {"renamenx",renamenxCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
835 {"expire",expireCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
836 {"expireat",expireatCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
837 {"keys",keysCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
838 {"dbsize",dbsizeCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
839 {"auth",authCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
840 {"ping",pingCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
841 {"echo",echoCommand
,2,REDIS_CMD_BULK
,NULL
,0,0,0},
842 {"save",saveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
843 {"bgsave",bgsaveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
844 {"bgrewriteaof",bgrewriteaofCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
845 {"shutdown",shutdownCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
846 {"lastsave",lastsaveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
847 {"type",typeCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
848 {"multi",multiCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
849 {"exec",execCommand
,1,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,execBlockClientOnSwappedKeys
,0,0,0},
850 {"discard",discardCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
851 {"sync",syncCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
852 {"flushdb",flushdbCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
853 {"flushall",flushallCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
854 {"sort",sortCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
855 {"info",infoCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
856 {"monitor",monitorCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
857 {"ttl",ttlCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
858 {"slaveof",slaveofCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
859 {"debug",debugCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
860 {"config",configCommand
,-2,REDIS_CMD_BULK
,NULL
,0,0,0},
861 {"subscribe",subscribeCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
862 {"unsubscribe",unsubscribeCommand
,-1,REDIS_CMD_INLINE
,NULL
,0,0,0},
863 {"psubscribe",psubscribeCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
864 {"punsubscribe",punsubscribeCommand
,-1,REDIS_CMD_INLINE
,NULL
,0,0,0},
865 {"publish",publishCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_FORCE_REPLICATION
,NULL
,0,0,0},
866 {"watch",watchCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
867 {"unwatch",unwatchCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0}
870 /*============================ Utility functions ============================ */
872 /* Glob-style pattern matching. */
873 static int stringmatchlen(const char *pattern
, int patternLen
,
874 const char *string
, int stringLen
, int nocase
)
879 while (pattern
[1] == '*') {
884 return 1; /* match */
886 if (stringmatchlen(pattern
+1, patternLen
-1,
887 string
, stringLen
, nocase
))
888 return 1; /* match */
892 return 0; /* no match */
896 return 0; /* no match */
906 not = pattern
[0] == '^';
913 if (pattern
[0] == '\\') {
916 if (pattern
[0] == string
[0])
918 } else if (pattern
[0] == ']') {
920 } else if (patternLen
== 0) {
924 } else if (pattern
[1] == '-' && patternLen
>= 3) {
925 int start
= pattern
[0];
926 int end
= pattern
[2];
934 start
= tolower(start
);
940 if (c
>= start
&& c
<= end
)
944 if (pattern
[0] == string
[0])
947 if (tolower((int)pattern
[0]) == tolower((int)string
[0]))
957 return 0; /* no match */
963 if (patternLen
>= 2) {
970 if (pattern
[0] != string
[0])
971 return 0; /* no match */
973 if (tolower((int)pattern
[0]) != tolower((int)string
[0]))
974 return 0; /* no match */
982 if (stringLen
== 0) {
983 while(*pattern
== '*') {
990 if (patternLen
== 0 && stringLen
== 0)
995 static int stringmatch(const char *pattern
, const char *string
, int nocase
) {
996 return stringmatchlen(pattern
,strlen(pattern
),string
,strlen(string
),nocase
);
999 /* Convert a string representing an amount of memory into the number of
1000 * bytes, so for instance memtoll("1Gi") will return 1073741824 that is
1003 * On parsing error, if *err is not NULL, it's set to 1, otherwise it's
1005 static long long memtoll(const char *p
, int *err
) {
1008 long mul
; /* unit multiplier */
1010 unsigned int digits
;
1013 /* Search the first non digit character. */
1016 while(*u
&& isdigit(*u
)) u
++;
1017 if (*u
== '\0' || !strcasecmp(u
,"b")) {
1019 } else if (!strcasecmp(u
,"k")) {
1021 } else if (!strcasecmp(u
,"kb")) {
1023 } else if (!strcasecmp(u
,"m")) {
1025 } else if (!strcasecmp(u
,"mb")) {
1027 } else if (!strcasecmp(u
,"g")) {
1028 mul
= 1000L*1000*1000;
1029 } else if (!strcasecmp(u
,"gb")) {
1030 mul
= 1024L*1024*1024;
1036 if (digits
>= sizeof(buf
)) {
1040 memcpy(buf
,p
,digits
);
1042 val
= strtoll(buf
,NULL
,10);
1046 /* Convert a long long into a string. Returns the number of
1047 * characters needed to represent the number, that can be shorter if passed
1048 * buffer length is not enough to store the whole number. */
1049 static int ll2string(char *s
, size_t len
, long long value
) {
1051 unsigned long long v
;
1054 if (len
== 0) return 0;
1055 v
= (value
< 0) ? -value
: value
;
1056 p
= buf
+31; /* point to the last character */
1061 if (value
< 0) *p
-- = '-';
1064 if (l
+1 > len
) l
= len
-1; /* Make sure it fits, including the nul term */
1070 static void redisLog(int level
, const char *fmt
, ...) {
1074 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
1078 if (level
>= server
.verbosity
) {
1084 strftime(buf
,64,"%d %b %H:%M:%S",localtime(&now
));
1085 fprintf(fp
,"[%d] %s %c ",(int)getpid(),buf
,c
[level
]);
1086 vfprintf(fp
, fmt
, ap
);
1092 if (server
.logfile
) fclose(fp
);
1095 /*====================== Hash table type implementation ==================== */
1097 /* This is an hash table type that uses the SDS dynamic strings libary as
1098 * keys and radis objects as values (objects can hold SDS strings,
1101 static void dictVanillaFree(void *privdata
, void *val
)
1103 DICT_NOTUSED(privdata
);
1107 static void dictListDestructor(void *privdata
, void *val
)
1109 DICT_NOTUSED(privdata
);
1110 listRelease((list
*)val
);
1113 static int sdsDictKeyCompare(void *privdata
, const void *key1
,
1117 DICT_NOTUSED(privdata
);
1119 l1
= sdslen((sds
)key1
);
1120 l2
= sdslen((sds
)key2
);
1121 if (l1
!= l2
) return 0;
1122 return memcmp(key1
, key2
, l1
) == 0;
1125 static void dictRedisObjectDestructor(void *privdata
, void *val
)
1127 DICT_NOTUSED(privdata
);
1129 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
1133 static int dictObjKeyCompare(void *privdata
, const void *key1
,
1136 const robj
*o1
= key1
, *o2
= key2
;
1137 return sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1140 static unsigned int dictObjHash(const void *key
) {
1141 const robj
*o
= key
;
1142 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1145 static int dictEncObjKeyCompare(void *privdata
, const void *key1
,
1148 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
1151 if (o1
->encoding
== REDIS_ENCODING_INT
&&
1152 o2
->encoding
== REDIS_ENCODING_INT
)
1153 return o1
->ptr
== o2
->ptr
;
1155 o1
= getDecodedObject(o1
);
1156 o2
= getDecodedObject(o2
);
1157 cmp
= sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1163 static unsigned int dictEncObjHash(const void *key
) {
1164 robj
*o
= (robj
*) key
;
1166 if (o
->encoding
== REDIS_ENCODING_RAW
) {
1167 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1169 if (o
->encoding
== REDIS_ENCODING_INT
) {
1173 len
= ll2string(buf
,32,(long)o
->ptr
);
1174 return dictGenHashFunction((unsigned char*)buf
, len
);
1178 o
= getDecodedObject(o
);
1179 hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1186 /* Sets type and expires */
1187 static dictType setDictType
= {
1188 dictEncObjHash
, /* hash function */
1191 dictEncObjKeyCompare
, /* key compare */
1192 dictRedisObjectDestructor
, /* key destructor */
1193 NULL
/* val destructor */
1196 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
1197 static dictType zsetDictType
= {
1198 dictEncObjHash
, /* hash function */
1201 dictEncObjKeyCompare
, /* key compare */
1202 dictRedisObjectDestructor
, /* key destructor */
1203 dictVanillaFree
/* val destructor of malloc(sizeof(double)) */
1207 static dictType dbDictType
= {
1208 dictObjHash
, /* hash function */
1211 dictObjKeyCompare
, /* key compare */
1212 dictRedisObjectDestructor
, /* key destructor */
1213 dictRedisObjectDestructor
/* val destructor */
1217 static dictType keyptrDictType
= {
1218 dictObjHash
, /* hash function */
1221 dictObjKeyCompare
, /* key compare */
1222 dictRedisObjectDestructor
, /* key destructor */
1223 NULL
/* val destructor */
1226 /* Hash type hash table (note that small hashes are represented with zimpaps) */
1227 static dictType hashDictType
= {
1228 dictEncObjHash
, /* hash function */
1231 dictEncObjKeyCompare
, /* key compare */
1232 dictRedisObjectDestructor
, /* key destructor */
1233 dictRedisObjectDestructor
/* val destructor */
1236 /* Keylist hash table type has unencoded redis objects as keys and
1237 * lists as values. It's used for blocking operations (BLPOP) and to
1238 * map swapped keys to a list of clients waiting for this keys to be loaded. */
1239 static dictType keylistDictType
= {
1240 dictObjHash
, /* hash function */
1243 dictObjKeyCompare
, /* key compare */
1244 dictRedisObjectDestructor
, /* key destructor */
1245 dictListDestructor
/* val destructor */
1248 static void version();
1250 /* ========================= Random utility functions ======================= */
1252 /* Redis generally does not try to recover from out of memory conditions
1253 * when allocating objects or strings, it is not clear if it will be possible
1254 * to report this condition to the client since the networking layer itself
1255 * is based on heap allocation for send buffers, so we simply abort.
1256 * At least the code will be simpler to read... */
1257 static void oom(const char *msg
) {
1258 redisLog(REDIS_WARNING
, "%s: Out of memory\n",msg
);
1263 /* ====================== Redis server networking stuff ===================== */
1264 static void closeTimedoutClients(void) {
1267 time_t now
= time(NULL
);
1270 listRewind(server
.clients
,&li
);
1271 while ((ln
= listNext(&li
)) != NULL
) {
1272 c
= listNodeValue(ln
);
1273 if (server
.maxidletime
&&
1274 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
1275 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
1276 dictSize(c
->pubsub_channels
) == 0 && /* no timeout for pubsub */
1277 listLength(c
->pubsub_patterns
) == 0 &&
1278 (now
- c
->lastinteraction
> server
.maxidletime
))
1280 redisLog(REDIS_VERBOSE
,"Closing idle client");
1282 } else if (c
->flags
& REDIS_BLOCKED
) {
1283 if (c
->blockingto
!= 0 && c
->blockingto
< now
) {
1284 addReply(c
,shared
.nullmultibulk
);
1285 unblockClientWaitingData(c
);
1291 static int htNeedsResize(dict
*dict
) {
1292 long long size
, used
;
1294 size
= dictSlots(dict
);
1295 used
= dictSize(dict
);
1296 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
1297 (used
*100/size
< REDIS_HT_MINFILL
));
1300 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1301 * we resize the hash table to save memory */
1302 static void tryResizeHashTables(void) {
1305 for (j
= 0; j
< server
.dbnum
; j
++) {
1306 if (htNeedsResize(server
.db
[j
].dict
))
1307 dictResize(server
.db
[j
].dict
);
1308 if (htNeedsResize(server
.db
[j
].expires
))
1309 dictResize(server
.db
[j
].expires
);
1313 /* Our hash table implementation performs rehashing incrementally while
1314 * we write/read from the hash table. Still if the server is idle, the hash
1315 * table will use two tables for a long time. So we try to use 1 millisecond
1316 * of CPU time at every serverCron() loop in order to rehash some key. */
1317 static void incrementallyRehash(void) {
1320 for (j
= 0; j
< server
.dbnum
; j
++) {
1321 if (dictIsRehashing(server
.db
[j
].dict
)) {
1322 dictRehashMilliseconds(server
.db
[j
].dict
,1);
1323 break; /* already used our millisecond for this loop... */
1328 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1329 void backgroundSaveDoneHandler(int statloc
) {
1330 int exitcode
= WEXITSTATUS(statloc
);
1331 int bysignal
= WIFSIGNALED(statloc
);
1333 if (!bysignal
&& exitcode
== 0) {
1334 redisLog(REDIS_NOTICE
,
1335 "Background saving terminated with success");
1337 server
.lastsave
= time(NULL
);
1338 } else if (!bysignal
&& exitcode
!= 0) {
1339 redisLog(REDIS_WARNING
, "Background saving error");
1341 redisLog(REDIS_WARNING
,
1342 "Background saving terminated by signal %d", WTERMSIG(statloc
));
1343 rdbRemoveTempFile(server
.bgsavechildpid
);
1345 server
.bgsavechildpid
= -1;
1346 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1347 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1348 updateSlavesWaitingBgsave(exitcode
== 0 ? REDIS_OK
: REDIS_ERR
);
1351 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1353 void backgroundRewriteDoneHandler(int statloc
) {
1354 int exitcode
= WEXITSTATUS(statloc
);
1355 int bysignal
= WIFSIGNALED(statloc
);
1357 if (!bysignal
&& exitcode
== 0) {
1361 redisLog(REDIS_NOTICE
,
1362 "Background append only file rewriting terminated with success");
1363 /* Now it's time to flush the differences accumulated by the parent */
1364 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) server
.bgrewritechildpid
);
1365 fd
= open(tmpfile
,O_WRONLY
|O_APPEND
);
1367 redisLog(REDIS_WARNING
, "Not able to open the temp append only file produced by the child: %s", strerror(errno
));
1370 /* Flush our data... */
1371 if (write(fd
,server
.bgrewritebuf
,sdslen(server
.bgrewritebuf
)) !=
1372 (signed) sdslen(server
.bgrewritebuf
)) {
1373 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
));
1377 redisLog(REDIS_NOTICE
,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server
.bgrewritebuf
));
1378 /* Now our work is to rename the temp file into the stable file. And
1379 * switch the file descriptor used by the server for append only. */
1380 if (rename(tmpfile
,server
.appendfilename
) == -1) {
1381 redisLog(REDIS_WARNING
,"Can't rename the temp append only file into the stable one: %s", strerror(errno
));
1385 /* Mission completed... almost */
1386 redisLog(REDIS_NOTICE
,"Append only file successfully rewritten.");
1387 if (server
.appendfd
!= -1) {
1388 /* If append only is actually enabled... */
1389 close(server
.appendfd
);
1390 server
.appendfd
= fd
;
1392 server
.appendseldb
= -1; /* Make sure it will issue SELECT */
1393 redisLog(REDIS_NOTICE
,"The new append only file was selected for future appends.");
1395 /* If append only is disabled we just generate a dump in this
1396 * format. Why not? */
1399 } else if (!bysignal
&& exitcode
!= 0) {
1400 redisLog(REDIS_WARNING
, "Background append only file rewriting error");
1402 redisLog(REDIS_WARNING
,
1403 "Background append only file rewriting terminated by signal %d",
1407 sdsfree(server
.bgrewritebuf
);
1408 server
.bgrewritebuf
= sdsempty();
1409 aofRemoveTempFile(server
.bgrewritechildpid
);
1410 server
.bgrewritechildpid
= -1;
1413 /* This function is called once a background process of some kind terminates,
1414 * as we want to avoid resizing the hash tables when there is a child in order
1415 * to play well with copy-on-write (otherwise when a resize happens lots of
1416 * memory pages are copied). The goal of this function is to update the ability
1417 * for dict.c to resize the hash tables accordingly to the fact we have o not
1418 * running childs. */
1419 static void updateDictResizePolicy(void) {
1420 if (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1)
1423 dictDisableResize();
1426 static int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
1427 int j
, loops
= server
.cronloops
++;
1428 REDIS_NOTUSED(eventLoop
);
1430 REDIS_NOTUSED(clientData
);
1432 /* We take a cached value of the unix time in the global state because
1433 * with virtual memory and aging there is to store the current time
1434 * in objects at every object access, and accuracy is not needed.
1435 * To access a global var is faster than calling time(NULL) */
1436 server
.unixtime
= time(NULL
);
1438 /* We received a SIGTERM, shutting down here in a safe way, as it is
1439 * not ok doing so inside the signal handler. */
1440 if (server
.shutdown_asap
) {
1441 if (prepareForShutdown() == REDIS_OK
) exit(0);
1442 redisLog(REDIS_WARNING
,"SIGTERM received but errors trying to shut down the server, check the logs for more information");
1445 /* Show some info about non-empty databases */
1446 for (j
= 0; j
< server
.dbnum
; j
++) {
1447 long long size
, used
, vkeys
;
1449 size
= dictSlots(server
.db
[j
].dict
);
1450 used
= dictSize(server
.db
[j
].dict
);
1451 vkeys
= dictSize(server
.db
[j
].expires
);
1452 if (!(loops
% 50) && (used
|| vkeys
)) {
1453 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
1454 /* dictPrintStats(server.dict); */
1458 /* We don't want to resize the hash tables while a bacground saving
1459 * is in progress: the saving child is created using fork() that is
1460 * implemented with a copy-on-write semantic in most modern systems, so
1461 * if we resize the HT while there is the saving child at work actually
1462 * a lot of memory movements in the parent will cause a lot of pages
1464 if (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1) {
1465 if (!(loops
% 10)) tryResizeHashTables();
1466 if (server
.activerehashing
) incrementallyRehash();
1469 /* Show information about connected clients */
1470 if (!(loops
% 50)) {
1471 redisLog(REDIS_VERBOSE
,"%d clients connected (%d slaves), %zu bytes in use",
1472 listLength(server
.clients
)-listLength(server
.slaves
),
1473 listLength(server
.slaves
),
1474 zmalloc_used_memory());
1477 /* Close connections of timedout clients */
1478 if ((server
.maxidletime
&& !(loops
% 100)) || server
.blpop_blocked_clients
)
1479 closeTimedoutClients();
1481 /* Check if a background saving or AOF rewrite in progress terminated */
1482 if (server
.bgsavechildpid
!= -1 || server
.bgrewritechildpid
!= -1) {
1486 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
1487 if (pid
== server
.bgsavechildpid
) {
1488 backgroundSaveDoneHandler(statloc
);
1490 backgroundRewriteDoneHandler(statloc
);
1492 updateDictResizePolicy();
1495 /* If there is not a background saving in progress check if
1496 * we have to save now */
1497 time_t now
= time(NULL
);
1498 for (j
= 0; j
< server
.saveparamslen
; j
++) {
1499 struct saveparam
*sp
= server
.saveparams
+j
;
1501 if (server
.dirty
>= sp
->changes
&&
1502 now
-server
.lastsave
> sp
->seconds
) {
1503 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
1504 sp
->changes
, sp
->seconds
);
1505 rdbSaveBackground(server
.dbfilename
);
1511 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1512 * will use few CPU cycles if there are few expiring keys, otherwise
1513 * it will get more aggressive to avoid that too much memory is used by
1514 * keys that can be removed from the keyspace. */
1515 for (j
= 0; j
< server
.dbnum
; j
++) {
1517 redisDb
*db
= server
.db
+j
;
1519 /* Continue to expire if at the end of the cycle more than 25%
1520 * of the keys were expired. */
1522 long num
= dictSize(db
->expires
);
1523 time_t now
= time(NULL
);
1526 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
1527 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
1532 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
1533 t
= (time_t) dictGetEntryVal(de
);
1535 deleteKey(db
,dictGetEntryKey(de
));
1537 server
.stat_expiredkeys
++;
1540 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
1543 /* Swap a few keys on disk if we are over the memory limit and VM
1544 * is enbled. Try to free objects from the free list first. */
1545 if (vmCanSwapOut()) {
1546 while (server
.vm_enabled
&& zmalloc_used_memory() >
1547 server
.vm_max_memory
)
1551 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
1552 retval
= (server
.vm_max_threads
== 0) ?
1553 vmSwapOneObjectBlocking() :
1554 vmSwapOneObjectThreaded();
1555 if (retval
== REDIS_ERR
&& !(loops
% 300) &&
1556 zmalloc_used_memory() >
1557 (server
.vm_max_memory
+server
.vm_max_memory
/10))
1559 redisLog(REDIS_WARNING
,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1561 /* Note that when using threade I/O we free just one object,
1562 * because anyway when the I/O thread in charge to swap this
1563 * object out will finish, the handler of completed jobs
1564 * will try to swap more objects if we are still out of memory. */
1565 if (retval
== REDIS_ERR
|| server
.vm_max_threads
> 0) break;
1569 /* Check if we should connect to a MASTER */
1570 if (server
.replstate
== REDIS_REPL_CONNECT
&& !(loops
% 10)) {
1571 redisLog(REDIS_NOTICE
,"Connecting to MASTER...");
1572 if (syncWithMaster() == REDIS_OK
) {
1573 redisLog(REDIS_NOTICE
,"MASTER <-> SLAVE sync succeeded");
1574 if (server
.appendonly
) rewriteAppendOnlyFileBackground();
1580 /* This function gets called every time Redis is entering the
1581 * main loop of the event driven library, that is, before to sleep
1582 * for ready file descriptors. */
1583 static void beforeSleep(struct aeEventLoop
*eventLoop
) {
1584 REDIS_NOTUSED(eventLoop
);
1586 /* Awake clients that got all the swapped keys they requested */
1587 if (server
.vm_enabled
&& listLength(server
.io_ready_clients
)) {
1591 listRewind(server
.io_ready_clients
,&li
);
1592 while((ln
= listNext(&li
))) {
1593 redisClient
*c
= ln
->value
;
1594 struct redisCommand
*cmd
;
1596 /* Resume the client. */
1597 listDelNode(server
.io_ready_clients
,ln
);
1598 c
->flags
&= (~REDIS_IO_WAIT
);
1599 server
.vm_blocked_clients
--;
1600 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
1601 readQueryFromClient
, c
);
1602 cmd
= lookupCommand(c
->argv
[0]->ptr
);
1603 assert(cmd
!= NULL
);
1606 /* There may be more data to process in the input buffer. */
1607 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0)
1608 processInputBuffer(c
);
1611 /* Write the AOF buffer on disk */
1612 flushAppendOnlyFile();
1615 static void createSharedObjects(void) {
1618 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1619 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1620 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1621 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1622 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1623 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1624 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1625 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1626 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1627 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1628 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1629 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1630 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1631 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1632 "-ERR no such key\r\n"));
1633 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1634 "-ERR syntax error\r\n"));
1635 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1636 "-ERR source and destination objects are the same\r\n"));
1637 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1638 "-ERR index out of range\r\n"));
1639 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1640 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1641 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1642 shared
.select0
= createStringObject("select 0\r\n",10);
1643 shared
.select1
= createStringObject("select 1\r\n",10);
1644 shared
.select2
= createStringObject("select 2\r\n",10);
1645 shared
.select3
= createStringObject("select 3\r\n",10);
1646 shared
.select4
= createStringObject("select 4\r\n",10);
1647 shared
.select5
= createStringObject("select 5\r\n",10);
1648 shared
.select6
= createStringObject("select 6\r\n",10);
1649 shared
.select7
= createStringObject("select 7\r\n",10);
1650 shared
.select8
= createStringObject("select 8\r\n",10);
1651 shared
.select9
= createStringObject("select 9\r\n",10);
1652 shared
.messagebulk
= createStringObject("$7\r\nmessage\r\n",13);
1653 shared
.pmessagebulk
= createStringObject("$8\r\npmessage\r\n",14);
1654 shared
.subscribebulk
= createStringObject("$9\r\nsubscribe\r\n",15);
1655 shared
.unsubscribebulk
= createStringObject("$11\r\nunsubscribe\r\n",18);
1656 shared
.psubscribebulk
= createStringObject("$10\r\npsubscribe\r\n",17);
1657 shared
.punsubscribebulk
= createStringObject("$12\r\npunsubscribe\r\n",19);
1658 shared
.mbulk3
= createStringObject("*3\r\n",4);
1659 shared
.mbulk4
= createStringObject("*4\r\n",4);
1660 for (j
= 0; j
< REDIS_SHARED_INTEGERS
; j
++) {
1661 shared
.integers
[j
] = createObject(REDIS_STRING
,(void*)(long)j
);
1662 shared
.integers
[j
]->encoding
= REDIS_ENCODING_INT
;
1666 static void appendServerSaveParams(time_t seconds
, int changes
) {
1667 server
.saveparams
= zrealloc(server
.saveparams
,sizeof(struct saveparam
)*(server
.saveparamslen
+1));
1668 server
.saveparams
[server
.saveparamslen
].seconds
= seconds
;
1669 server
.saveparams
[server
.saveparamslen
].changes
= changes
;
1670 server
.saveparamslen
++;
1673 static void resetServerSaveParams() {
1674 zfree(server
.saveparams
);
1675 server
.saveparams
= NULL
;
1676 server
.saveparamslen
= 0;
1679 static void initServerConfig() {
1680 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1681 server
.port
= REDIS_SERVERPORT
;
1682 server
.verbosity
= REDIS_VERBOSE
;
1683 server
.maxidletime
= REDIS_MAXIDLETIME
;
1684 server
.saveparams
= NULL
;
1685 server
.logfile
= NULL
; /* NULL = log on standard output */
1686 server
.bindaddr
= NULL
;
1687 server
.glueoutputbuf
= 1;
1688 server
.daemonize
= 0;
1689 server
.appendonly
= 0;
1690 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1691 server
.lastfsync
= time(NULL
);
1692 server
.appendfd
= -1;
1693 server
.appendseldb
= -1; /* Make sure the first time will not match */
1694 server
.pidfile
= zstrdup("/var/run/redis.pid");
1695 server
.dbfilename
= zstrdup("dump.rdb");
1696 server
.appendfilename
= zstrdup("appendonly.aof");
1697 server
.requirepass
= NULL
;
1698 server
.rdbcompression
= 1;
1699 server
.activerehashing
= 1;
1700 server
.maxclients
= 0;
1701 server
.blpop_blocked_clients
= 0;
1702 server
.maxmemory
= 0;
1703 server
.vm_enabled
= 0;
1704 server
.vm_swap_file
= zstrdup("/tmp/redis-%p.vm");
1705 server
.vm_page_size
= 256; /* 256 bytes per page */
1706 server
.vm_pages
= 1024*1024*100; /* 104 millions of pages */
1707 server
.vm_max_memory
= 1024LL*1024*1024*1; /* 1 GB of RAM */
1708 server
.vm_max_threads
= 4;
1709 server
.vm_blocked_clients
= 0;
1710 server
.hash_max_zipmap_entries
= REDIS_HASH_MAX_ZIPMAP_ENTRIES
;
1711 server
.hash_max_zipmap_value
= REDIS_HASH_MAX_ZIPMAP_VALUE
;
1712 server
.shutdown_asap
= 0;
1714 resetServerSaveParams();
1716 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1717 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1718 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1719 /* Replication related */
1721 server
.masterauth
= NULL
;
1722 server
.masterhost
= NULL
;
1723 server
.masterport
= 6379;
1724 server
.master
= NULL
;
1725 server
.replstate
= REDIS_REPL_NONE
;
1727 /* Double constants initialization */
1729 R_PosInf
= 1.0/R_Zero
;
1730 R_NegInf
= -1.0/R_Zero
;
1731 R_Nan
= R_Zero
/R_Zero
;
1734 static void initServer() {
1737 signal(SIGHUP
, SIG_IGN
);
1738 signal(SIGPIPE
, SIG_IGN
);
1739 setupSigSegvAction();
1741 server
.devnull
= fopen("/dev/null","w");
1742 if (server
.devnull
== NULL
) {
1743 redisLog(REDIS_WARNING
, "Can't open /dev/null: %s", server
.neterr
);
1746 server
.clients
= listCreate();
1747 server
.slaves
= listCreate();
1748 server
.monitors
= listCreate();
1749 server
.objfreelist
= listCreate();
1750 createSharedObjects();
1751 server
.el
= aeCreateEventLoop();
1752 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1753 server
.fd
= anetTcpServer(server
.neterr
, server
.port
, server
.bindaddr
);
1754 if (server
.fd
== -1) {
1755 redisLog(REDIS_WARNING
, "Opening TCP port: %s", server
.neterr
);
1758 for (j
= 0; j
< server
.dbnum
; j
++) {
1759 server
.db
[j
].dict
= dictCreate(&dbDictType
,NULL
);
1760 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1761 server
.db
[j
].blocking_keys
= dictCreate(&keylistDictType
,NULL
);
1762 server
.db
[j
].watched_keys
= dictCreate(&keylistDictType
,NULL
);
1763 if (server
.vm_enabled
)
1764 server
.db
[j
].io_keys
= dictCreate(&keylistDictType
,NULL
);
1765 server
.db
[j
].id
= j
;
1767 server
.pubsub_channels
= dictCreate(&keylistDictType
,NULL
);
1768 server
.pubsub_patterns
= listCreate();
1769 listSetFreeMethod(server
.pubsub_patterns
,freePubsubPattern
);
1770 listSetMatchMethod(server
.pubsub_patterns
,listMatchPubsubPattern
);
1771 server
.cronloops
= 0;
1772 server
.bgsavechildpid
= -1;
1773 server
.bgrewritechildpid
= -1;
1774 server
.bgrewritebuf
= sdsempty();
1775 server
.aofbuf
= sdsempty();
1776 server
.lastsave
= time(NULL
);
1778 server
.stat_numcommands
= 0;
1779 server
.stat_numconnections
= 0;
1780 server
.stat_expiredkeys
= 0;
1781 server
.stat_starttime
= time(NULL
);
1782 server
.unixtime
= time(NULL
);
1783 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1784 if (aeCreateFileEvent(server
.el
, server
.fd
, AE_READABLE
,
1785 acceptHandler
, NULL
) == AE_ERR
) oom("creating file event");
1787 if (server
.appendonly
) {
1788 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1789 if (server
.appendfd
== -1) {
1790 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1796 if (server
.vm_enabled
) vmInit();
1799 /* Empty the whole database */
1800 static long long emptyDb() {
1802 long long removed
= 0;
1804 for (j
= 0; j
< server
.dbnum
; j
++) {
1805 removed
+= dictSize(server
.db
[j
].dict
);
1806 dictEmpty(server
.db
[j
].dict
);
1807 dictEmpty(server
.db
[j
].expires
);
1812 static int yesnotoi(char *s
) {
1813 if (!strcasecmp(s
,"yes")) return 1;
1814 else if (!strcasecmp(s
,"no")) return 0;
1818 /* I agree, this is a very rudimental way to load a configuration...
1819 will improve later if the config gets more complex */
1820 static void loadServerConfig(char *filename
) {
1822 char buf
[REDIS_CONFIGLINE_MAX
+1], *err
= NULL
;
1826 if (filename
[0] == '-' && filename
[1] == '\0')
1829 if ((fp
= fopen(filename
,"r")) == NULL
) {
1830 redisLog(REDIS_WARNING
, "Fatal error, can't open config file '%s'", filename
);
1835 while(fgets(buf
,REDIS_CONFIGLINE_MAX
+1,fp
) != NULL
) {
1841 line
= sdstrim(line
," \t\r\n");
1843 /* Skip comments and blank lines*/
1844 if (line
[0] == '#' || line
[0] == '\0') {
1849 /* Split into arguments */
1850 argv
= sdssplitlen(line
,sdslen(line
)," ",1,&argc
);
1851 sdstolower(argv
[0]);
1853 /* Execute config directives */
1854 if (!strcasecmp(argv
[0],"timeout") && argc
== 2) {
1855 server
.maxidletime
= atoi(argv
[1]);
1856 if (server
.maxidletime
< 0) {
1857 err
= "Invalid timeout value"; goto loaderr
;
1859 } else if (!strcasecmp(argv
[0],"port") && argc
== 2) {
1860 server
.port
= atoi(argv
[1]);
1861 if (server
.port
< 1 || server
.port
> 65535) {
1862 err
= "Invalid port"; goto loaderr
;
1864 } else if (!strcasecmp(argv
[0],"bind") && argc
== 2) {
1865 server
.bindaddr
= zstrdup(argv
[1]);
1866 } else if (!strcasecmp(argv
[0],"save") && argc
== 3) {
1867 int seconds
= atoi(argv
[1]);
1868 int changes
= atoi(argv
[2]);
1869 if (seconds
< 1 || changes
< 0) {
1870 err
= "Invalid save parameters"; goto loaderr
;
1872 appendServerSaveParams(seconds
,changes
);
1873 } else if (!strcasecmp(argv
[0],"dir") && argc
== 2) {
1874 if (chdir(argv
[1]) == -1) {
1875 redisLog(REDIS_WARNING
,"Can't chdir to '%s': %s",
1876 argv
[1], strerror(errno
));
1879 } else if (!strcasecmp(argv
[0],"loglevel") && argc
== 2) {
1880 if (!strcasecmp(argv
[1],"debug")) server
.verbosity
= REDIS_DEBUG
;
1881 else if (!strcasecmp(argv
[1],"verbose")) server
.verbosity
= REDIS_VERBOSE
;
1882 else if (!strcasecmp(argv
[1],"notice")) server
.verbosity
= REDIS_NOTICE
;
1883 else if (!strcasecmp(argv
[1],"warning")) server
.verbosity
= REDIS_WARNING
;
1885 err
= "Invalid log level. Must be one of debug, notice, warning";
1888 } else if (!strcasecmp(argv
[0],"logfile") && argc
== 2) {
1891 server
.logfile
= zstrdup(argv
[1]);
1892 if (!strcasecmp(server
.logfile
,"stdout")) {
1893 zfree(server
.logfile
);
1894 server
.logfile
= NULL
;
1896 if (server
.logfile
) {
1897 /* Test if we are able to open the file. The server will not
1898 * be able to abort just for this problem later... */
1899 logfp
= fopen(server
.logfile
,"a");
1900 if (logfp
== NULL
) {
1901 err
= sdscatprintf(sdsempty(),
1902 "Can't open the log file: %s", strerror(errno
));
1907 } else if (!strcasecmp(argv
[0],"databases") && argc
== 2) {
1908 server
.dbnum
= atoi(argv
[1]);
1909 if (server
.dbnum
< 1) {
1910 err
= "Invalid number of databases"; goto loaderr
;
1912 } else if (!strcasecmp(argv
[0],"include") && argc
== 2) {
1913 loadServerConfig(argv
[1]);
1914 } else if (!strcasecmp(argv
[0],"maxclients") && argc
== 2) {
1915 server
.maxclients
= atoi(argv
[1]);
1916 } else if (!strcasecmp(argv
[0],"maxmemory") && argc
== 2) {
1917 server
.maxmemory
= memtoll(argv
[1],NULL
);
1918 } else if (!strcasecmp(argv
[0],"slaveof") && argc
== 3) {
1919 server
.masterhost
= sdsnew(argv
[1]);
1920 server
.masterport
= atoi(argv
[2]);
1921 server
.replstate
= REDIS_REPL_CONNECT
;
1922 } else if (!strcasecmp(argv
[0],"masterauth") && argc
== 2) {
1923 server
.masterauth
= zstrdup(argv
[1]);
1924 } else if (!strcasecmp(argv
[0],"glueoutputbuf") && argc
== 2) {
1925 if ((server
.glueoutputbuf
= yesnotoi(argv
[1])) == -1) {
1926 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1928 } else if (!strcasecmp(argv
[0],"rdbcompression") && argc
== 2) {
1929 if ((server
.rdbcompression
= yesnotoi(argv
[1])) == -1) {
1930 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1932 } else if (!strcasecmp(argv
[0],"activerehashing") && argc
== 2) {
1933 if ((server
.activerehashing
= yesnotoi(argv
[1])) == -1) {
1934 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1936 } else if (!strcasecmp(argv
[0],"daemonize") && argc
== 2) {
1937 if ((server
.daemonize
= yesnotoi(argv
[1])) == -1) {
1938 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1940 } else if (!strcasecmp(argv
[0],"appendonly") && argc
== 2) {
1941 if ((server
.appendonly
= yesnotoi(argv
[1])) == -1) {
1942 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1944 } else if (!strcasecmp(argv
[0],"appendfilename") && argc
== 2) {
1945 zfree(server
.appendfilename
);
1946 server
.appendfilename
= zstrdup(argv
[1]);
1947 } else if (!strcasecmp(argv
[0],"appendfsync") && argc
== 2) {
1948 if (!strcasecmp(argv
[1],"no")) {
1949 server
.appendfsync
= APPENDFSYNC_NO
;
1950 } else if (!strcasecmp(argv
[1],"always")) {
1951 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1952 } else if (!strcasecmp(argv
[1],"everysec")) {
1953 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1955 err
= "argument must be 'no', 'always' or 'everysec'";
1958 } else if (!strcasecmp(argv
[0],"requirepass") && argc
== 2) {
1959 server
.requirepass
= zstrdup(argv
[1]);
1960 } else if (!strcasecmp(argv
[0],"pidfile") && argc
== 2) {
1961 zfree(server
.pidfile
);
1962 server
.pidfile
= zstrdup(argv
[1]);
1963 } else if (!strcasecmp(argv
[0],"dbfilename") && argc
== 2) {
1964 zfree(server
.dbfilename
);
1965 server
.dbfilename
= zstrdup(argv
[1]);
1966 } else if (!strcasecmp(argv
[0],"vm-enabled") && argc
== 2) {
1967 if ((server
.vm_enabled
= yesnotoi(argv
[1])) == -1) {
1968 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1970 } else if (!strcasecmp(argv
[0],"vm-swap-file") && argc
== 2) {
1971 zfree(server
.vm_swap_file
);
1972 server
.vm_swap_file
= zstrdup(argv
[1]);
1973 } else if (!strcasecmp(argv
[0],"vm-max-memory") && argc
== 2) {
1974 server
.vm_max_memory
= memtoll(argv
[1],NULL
);
1975 } else if (!strcasecmp(argv
[0],"vm-page-size") && argc
== 2) {
1976 server
.vm_page_size
= memtoll(argv
[1], NULL
);
1977 } else if (!strcasecmp(argv
[0],"vm-pages") && argc
== 2) {
1978 server
.vm_pages
= memtoll(argv
[1], NULL
);
1979 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1980 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1981 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-entries") && argc
== 2){
1982 server
.hash_max_zipmap_entries
= memtoll(argv
[1], NULL
);
1983 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-value") && argc
== 2){
1984 server
.hash_max_zipmap_value
= memtoll(argv
[1], NULL
);
1986 err
= "Bad directive or wrong number of arguments"; goto loaderr
;
1988 for (j
= 0; j
< argc
; j
++)
1993 if (fp
!= stdin
) fclose(fp
);
1997 fprintf(stderr
, "\n*** FATAL CONFIG FILE ERROR ***\n");
1998 fprintf(stderr
, "Reading the configuration file, at line %d\n", linenum
);
1999 fprintf(stderr
, ">>> '%s'\n", line
);
2000 fprintf(stderr
, "%s\n", err
);
2004 static void freeClientArgv(redisClient
*c
) {
2007 for (j
= 0; j
< c
->argc
; j
++)
2008 decrRefCount(c
->argv
[j
]);
2009 for (j
= 0; j
< c
->mbargc
; j
++)
2010 decrRefCount(c
->mbargv
[j
]);
2015 static void freeClient(redisClient
*c
) {
2018 /* Note that if the client we are freeing is blocked into a blocking
2019 * call, we have to set querybuf to NULL *before* to call
2020 * unblockClientWaitingData() to avoid processInputBuffer() will get
2021 * called. Also it is important to remove the file events after
2022 * this, because this call adds the READABLE event. */
2023 sdsfree(c
->querybuf
);
2025 if (c
->flags
& REDIS_BLOCKED
)
2026 unblockClientWaitingData(c
);
2028 /* UNWATCH all the keys */
2030 listRelease(c
->watched_keys
);
2031 /* Unsubscribe from all the pubsub channels */
2032 pubsubUnsubscribeAllChannels(c
,0);
2033 pubsubUnsubscribeAllPatterns(c
,0);
2034 dictRelease(c
->pubsub_channels
);
2035 listRelease(c
->pubsub_patterns
);
2036 /* Obvious cleanup */
2037 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
2038 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2039 listRelease(c
->reply
);
2042 /* Remove from the list of clients */
2043 ln
= listSearchKey(server
.clients
,c
);
2044 redisAssert(ln
!= NULL
);
2045 listDelNode(server
.clients
,ln
);
2046 /* Remove from the list of clients that are now ready to be restarted
2047 * after waiting for swapped keys */
2048 if (c
->flags
& REDIS_IO_WAIT
&& listLength(c
->io_keys
) == 0) {
2049 ln
= listSearchKey(server
.io_ready_clients
,c
);
2051 listDelNode(server
.io_ready_clients
,ln
);
2052 server
.vm_blocked_clients
--;
2055 /* Remove from the list of clients waiting for swapped keys */
2056 while (server
.vm_enabled
&& listLength(c
->io_keys
)) {
2057 ln
= listFirst(c
->io_keys
);
2058 dontWaitForSwappedKey(c
,ln
->value
);
2060 listRelease(c
->io_keys
);
2061 /* Master/slave cleanup */
2062 if (c
->flags
& REDIS_SLAVE
) {
2063 if (c
->replstate
== REDIS_REPL_SEND_BULK
&& c
->repldbfd
!= -1)
2065 list
*l
= (c
->flags
& REDIS_MONITOR
) ? server
.monitors
: server
.slaves
;
2066 ln
= listSearchKey(l
,c
);
2067 redisAssert(ln
!= NULL
);
2070 if (c
->flags
& REDIS_MASTER
) {
2071 server
.master
= NULL
;
2072 server
.replstate
= REDIS_REPL_CONNECT
;
2074 /* Release memory */
2077 freeClientMultiState(c
);
2081 #define GLUEREPLY_UP_TO (1024)
2082 static void glueReplyBuffersIfNeeded(redisClient
*c
) {
2084 char buf
[GLUEREPLY_UP_TO
];
2089 listRewind(c
->reply
,&li
);
2090 while((ln
= listNext(&li
))) {
2094 objlen
= sdslen(o
->ptr
);
2095 if (copylen
+ objlen
<= GLUEREPLY_UP_TO
) {
2096 memcpy(buf
+copylen
,o
->ptr
,objlen
);
2098 listDelNode(c
->reply
,ln
);
2100 if (copylen
== 0) return;
2104 /* Now the output buffer is empty, add the new single element */
2105 o
= createObject(REDIS_STRING
,sdsnewlen(buf
,copylen
));
2106 listAddNodeHead(c
->reply
,o
);
2109 static void sendReplyToClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2110 redisClient
*c
= privdata
;
2111 int nwritten
= 0, totwritten
= 0, objlen
;
2114 REDIS_NOTUSED(mask
);
2116 /* Use writev() if we have enough buffers to send */
2117 if (!server
.glueoutputbuf
&&
2118 listLength(c
->reply
) > REDIS_WRITEV_THRESHOLD
&&
2119 !(c
->flags
& REDIS_MASTER
))
2121 sendReplyToClientWritev(el
, fd
, privdata
, mask
);
2125 while(listLength(c
->reply
)) {
2126 if (server
.glueoutputbuf
&& listLength(c
->reply
) > 1)
2127 glueReplyBuffersIfNeeded(c
);
2129 o
= listNodeValue(listFirst(c
->reply
));
2130 objlen
= sdslen(o
->ptr
);
2133 listDelNode(c
->reply
,listFirst(c
->reply
));
2137 if (c
->flags
& REDIS_MASTER
) {
2138 /* Don't reply to a master */
2139 nwritten
= objlen
- c
->sentlen
;
2141 nwritten
= write(fd
, ((char*)o
->ptr
)+c
->sentlen
, objlen
- c
->sentlen
);
2142 if (nwritten
<= 0) break;
2144 c
->sentlen
+= nwritten
;
2145 totwritten
+= nwritten
;
2146 /* If we fully sent the object on head go to the next one */
2147 if (c
->sentlen
== objlen
) {
2148 listDelNode(c
->reply
,listFirst(c
->reply
));
2151 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
2152 * bytes, in a single threaded server it's a good idea to serve
2153 * other clients as well, even if a very large request comes from
2154 * super fast link that is always able to accept data (in real world
2155 * scenario think about 'KEYS *' against the loopback interfae) */
2156 if (totwritten
> REDIS_MAX_WRITE_PER_EVENT
) break;
2158 if (nwritten
== -1) {
2159 if (errno
== EAGAIN
) {
2162 redisLog(REDIS_VERBOSE
,
2163 "Error writing to client: %s", strerror(errno
));
2168 if (totwritten
> 0) c
->lastinteraction
= time(NULL
);
2169 if (listLength(c
->reply
) == 0) {
2171 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2175 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
)
2177 redisClient
*c
= privdata
;
2178 int nwritten
= 0, totwritten
= 0, objlen
, willwrite
;
2180 struct iovec iov
[REDIS_WRITEV_IOVEC_COUNT
];
2181 int offset
, ion
= 0;
2183 REDIS_NOTUSED(mask
);
2186 while (listLength(c
->reply
)) {
2187 offset
= c
->sentlen
;
2191 /* fill-in the iov[] array */
2192 for(node
= listFirst(c
->reply
); node
; node
= listNextNode(node
)) {
2193 o
= listNodeValue(node
);
2194 objlen
= sdslen(o
->ptr
);
2196 if (totwritten
+ objlen
- offset
> REDIS_MAX_WRITE_PER_EVENT
)
2199 if(ion
== REDIS_WRITEV_IOVEC_COUNT
)
2200 break; /* no more iovecs */
2202 iov
[ion
].iov_base
= ((char*)o
->ptr
) + offset
;
2203 iov
[ion
].iov_len
= objlen
- offset
;
2204 willwrite
+= objlen
- offset
;
2205 offset
= 0; /* just for the first item */
2212 /* write all collected blocks at once */
2213 if((nwritten
= writev(fd
, iov
, ion
)) < 0) {
2214 if (errno
!= EAGAIN
) {
2215 redisLog(REDIS_VERBOSE
,
2216 "Error writing to client: %s", strerror(errno
));
2223 totwritten
+= nwritten
;
2224 offset
= c
->sentlen
;
2226 /* remove written robjs from c->reply */
2227 while (nwritten
&& listLength(c
->reply
)) {
2228 o
= listNodeValue(listFirst(c
->reply
));
2229 objlen
= sdslen(o
->ptr
);
2231 if(nwritten
>= objlen
- offset
) {
2232 listDelNode(c
->reply
, listFirst(c
->reply
));
2233 nwritten
-= objlen
- offset
;
2237 c
->sentlen
+= nwritten
;
2245 c
->lastinteraction
= time(NULL
);
2247 if (listLength(c
->reply
) == 0) {
2249 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2253 static int qsortRedisCommands(const void *r1
, const void *r2
) {
2255 ((struct redisCommand
*)r1
)->name
,
2256 ((struct redisCommand
*)r2
)->name
);
2259 static void sortCommandTable() {
2260 /* Copy and sort the read-only version of the command table */
2261 commandTable
= (struct redisCommand
*)malloc(sizeof(readonlyCommandTable
));
2262 memcpy(commandTable
,readonlyCommandTable
,sizeof(readonlyCommandTable
));
2264 sizeof(readonlyCommandTable
)/sizeof(struct redisCommand
),
2265 sizeof(struct redisCommand
),qsortRedisCommands
);
2268 static struct redisCommand
*lookupCommand(char *name
) {
2269 struct redisCommand tmp
= {name
,NULL
,0,0,NULL
,0,0,0};
2273 sizeof(readonlyCommandTable
)/sizeof(struct redisCommand
),
2274 sizeof(struct redisCommand
),
2275 qsortRedisCommands
);
2278 /* resetClient prepare the client to process the next command */
2279 static void resetClient(redisClient
*c
) {
2285 /* Call() is the core of Redis execution of a command */
2286 static void call(redisClient
*c
, struct redisCommand
*cmd
) {
2289 dirty
= server
.dirty
;
2291 dirty
= server
.dirty
-dirty
;
2293 if (server
.appendonly
&& dirty
)
2294 feedAppendOnlyFile(cmd
,c
->db
->id
,c
->argv
,c
->argc
);
2295 if ((dirty
|| cmd
->flags
& REDIS_CMD_FORCE_REPLICATION
) &&
2296 listLength(server
.slaves
))
2297 replicationFeedSlaves(server
.slaves
,c
->db
->id
,c
->argv
,c
->argc
);
2298 if (listLength(server
.monitors
))
2299 replicationFeedMonitors(server
.monitors
,c
->db
->id
,c
->argv
,c
->argc
);
2300 server
.stat_numcommands
++;
2303 /* If this function gets called we already read a whole
2304 * command, argments are in the client argv/argc fields.
2305 * processCommand() execute the command or prepare the
2306 * server for a bulk read from the client.
2308 * If 1 is returned the client is still alive and valid and
2309 * and other operations can be performed by the caller. Otherwise
2310 * if 0 is returned the client was destroied (i.e. after QUIT). */
2311 static int processCommand(redisClient
*c
) {
2312 struct redisCommand
*cmd
;
2314 /* Free some memory if needed (maxmemory setting) */
2315 if (server
.maxmemory
) freeMemoryIfNeeded();
2317 /* Handle the multi bulk command type. This is an alternative protocol
2318 * supported by Redis in order to receive commands that are composed of
2319 * multiple binary-safe "bulk" arguments. The latency of processing is
2320 * a bit higher but this allows things like multi-sets, so if this
2321 * protocol is used only for MSET and similar commands this is a big win. */
2322 if (c
->multibulk
== 0 && c
->argc
== 1 && ((char*)(c
->argv
[0]->ptr
))[0] == '*') {
2323 c
->multibulk
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2324 if (c
->multibulk
<= 0) {
2328 decrRefCount(c
->argv
[c
->argc
-1]);
2332 } else if (c
->multibulk
) {
2333 if (c
->bulklen
== -1) {
2334 if (((char*)c
->argv
[0]->ptr
)[0] != '$') {
2335 addReplySds(c
,sdsnew("-ERR multi bulk protocol error\r\n"));
2339 int bulklen
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2340 decrRefCount(c
->argv
[0]);
2341 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2343 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2348 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2352 c
->mbargv
= zrealloc(c
->mbargv
,(sizeof(robj
*))*(c
->mbargc
+1));
2353 c
->mbargv
[c
->mbargc
] = c
->argv
[0];
2357 if (c
->multibulk
== 0) {
2361 /* Here we need to swap the multi-bulk argc/argv with the
2362 * normal argc/argv of the client structure. */
2364 c
->argv
= c
->mbargv
;
2365 c
->mbargv
= auxargv
;
2368 c
->argc
= c
->mbargc
;
2369 c
->mbargc
= auxargc
;
2371 /* We need to set bulklen to something different than -1
2372 * in order for the code below to process the command without
2373 * to try to read the last argument of a bulk command as
2374 * a special argument. */
2376 /* continue below and process the command */
2383 /* -- end of multi bulk commands processing -- */
2385 /* The QUIT command is handled as a special case. Normal command
2386 * procs are unable to close the client connection safely */
2387 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
2392 /* Now lookup the command and check ASAP about trivial error conditions
2393 * such wrong arity, bad command name and so forth. */
2394 cmd
= lookupCommand(c
->argv
[0]->ptr
);
2397 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2398 (char*)c
->argv
[0]->ptr
));
2401 } else if ((cmd
->arity
> 0 && cmd
->arity
!= c
->argc
) ||
2402 (c
->argc
< -cmd
->arity
)) {
2404 sdscatprintf(sdsempty(),
2405 "-ERR wrong number of arguments for '%s' command\r\n",
2409 } else if (cmd
->flags
& REDIS_CMD_BULK
&& c
->bulklen
== -1) {
2410 /* This is a bulk command, we have to read the last argument yet. */
2411 int bulklen
= atoi(c
->argv
[c
->argc
-1]->ptr
);
2413 decrRefCount(c
->argv
[c
->argc
-1]);
2414 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2416 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2421 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2422 /* It is possible that the bulk read is already in the
2423 * buffer. Check this condition and handle it accordingly.
2424 * This is just a fast path, alternative to call processInputBuffer().
2425 * It's a good idea since the code is small and this condition
2426 * happens most of the times. */
2427 if ((signed)sdslen(c
->querybuf
) >= c
->bulklen
) {
2428 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2430 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2432 /* Otherwise return... there is to read the last argument
2433 * from the socket. */
2437 /* Let's try to encode the bulk object to save space. */
2438 if (cmd
->flags
& REDIS_CMD_BULK
)
2439 c
->argv
[c
->argc
-1] = tryObjectEncoding(c
->argv
[c
->argc
-1]);
2441 /* Check if the user is authenticated */
2442 if (server
.requirepass
&& !c
->authenticated
&& cmd
->proc
!= authCommand
) {
2443 addReplySds(c
,sdsnew("-ERR operation not permitted\r\n"));
2448 /* Handle the maxmemory directive */
2449 if (server
.maxmemory
&& (cmd
->flags
& REDIS_CMD_DENYOOM
) &&
2450 zmalloc_used_memory() > server
.maxmemory
)
2452 addReplySds(c
,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2457 /* Only allow SUBSCRIBE and UNSUBSCRIBE in the context of Pub/Sub */
2458 if ((dictSize(c
->pubsub_channels
) > 0 || listLength(c
->pubsub_patterns
) > 0)
2460 cmd
->proc
!= subscribeCommand
&& cmd
->proc
!= unsubscribeCommand
&&
2461 cmd
->proc
!= psubscribeCommand
&& cmd
->proc
!= punsubscribeCommand
) {
2462 addReplySds(c
,sdsnew("-ERR only (P)SUBSCRIBE / (P)UNSUBSCRIBE / QUIT allowed in this context\r\n"));
2467 /* Exec the command */
2468 if (c
->flags
& REDIS_MULTI
&&
2469 cmd
->proc
!= execCommand
&& cmd
->proc
!= discardCommand
&&
2470 cmd
->proc
!= multiCommand
&& cmd
->proc
!= watchCommand
)
2472 queueMultiCommand(c
,cmd
);
2473 addReply(c
,shared
.queued
);
2475 if (server
.vm_enabled
&& server
.vm_max_threads
> 0 &&
2476 blockClientOnSwappedKeys(c
,cmd
)) return 1;
2480 /* Prepare the client for the next command */
2485 static void replicationFeedSlaves(list
*slaves
, int dictid
, robj
**argv
, int argc
) {
2490 /* We need 1+(ARGS*3) objects since commands are using the new protocol
2491 * and we one 1 object for the first "*<count>\r\n" multibulk count, then
2492 * for every additional object we have "$<count>\r\n" + object + "\r\n". */
2493 robj
*static_outv
[REDIS_STATIC_ARGS
*3+1];
2496 if (argc
<= REDIS_STATIC_ARGS
) {
2499 outv
= zmalloc(sizeof(robj
*)*(argc
*3+1));
2502 lenobj
= createObject(REDIS_STRING
,
2503 sdscatprintf(sdsempty(), "*%d\r\n", argc
));
2504 lenobj
->refcount
= 0;
2505 outv
[outc
++] = lenobj
;
2506 for (j
= 0; j
< argc
; j
++) {
2507 lenobj
= createObject(REDIS_STRING
,
2508 sdscatprintf(sdsempty(),"$%lu\r\n",
2509 (unsigned long) stringObjectLen(argv
[j
])));
2510 lenobj
->refcount
= 0;
2511 outv
[outc
++] = lenobj
;
2512 outv
[outc
++] = argv
[j
];
2513 outv
[outc
++] = shared
.crlf
;
2516 /* Increment all the refcounts at start and decrement at end in order to
2517 * be sure to free objects if there is no slave in a replication state
2518 * able to be feed with commands */
2519 for (j
= 0; j
< outc
; j
++) incrRefCount(outv
[j
]);
2520 listRewind(slaves
,&li
);
2521 while((ln
= listNext(&li
))) {
2522 redisClient
*slave
= ln
->value
;
2524 /* Don't feed slaves that are still waiting for BGSAVE to start */
2525 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) continue;
2527 /* Feed all the other slaves, MONITORs and so on */
2528 if (slave
->slaveseldb
!= dictid
) {
2532 case 0: selectcmd
= shared
.select0
; break;
2533 case 1: selectcmd
= shared
.select1
; break;
2534 case 2: selectcmd
= shared
.select2
; break;
2535 case 3: selectcmd
= shared
.select3
; break;
2536 case 4: selectcmd
= shared
.select4
; break;
2537 case 5: selectcmd
= shared
.select5
; break;
2538 case 6: selectcmd
= shared
.select6
; break;
2539 case 7: selectcmd
= shared
.select7
; break;
2540 case 8: selectcmd
= shared
.select8
; break;
2541 case 9: selectcmd
= shared
.select9
; break;
2543 selectcmd
= createObject(REDIS_STRING
,
2544 sdscatprintf(sdsempty(),"select %d\r\n",dictid
));
2545 selectcmd
->refcount
= 0;
2548 addReply(slave
,selectcmd
);
2549 slave
->slaveseldb
= dictid
;
2551 for (j
= 0; j
< outc
; j
++) addReply(slave
,outv
[j
]);
2553 for (j
= 0; j
< outc
; j
++) decrRefCount(outv
[j
]);
2554 if (outv
!= static_outv
) zfree(outv
);
2557 static sds
sdscatrepr(sds s
, char *p
, size_t len
) {
2558 s
= sdscatlen(s
,"\"",1);
2563 s
= sdscatprintf(s
,"\\%c",*p
);
2565 case '\n': s
= sdscatlen(s
,"\\n",1); break;
2566 case '\r': s
= sdscatlen(s
,"\\r",1); break;
2567 case '\t': s
= sdscatlen(s
,"\\t",1); break;
2568 case '\a': s
= sdscatlen(s
,"\\a",1); break;
2569 case '\b': s
= sdscatlen(s
,"\\b",1); break;
2572 s
= sdscatprintf(s
,"%c",*p
);
2574 s
= sdscatprintf(s
,"\\x%02x",(unsigned char)*p
);
2579 return sdscatlen(s
,"\"",1);
2582 static void replicationFeedMonitors(list
*monitors
, int dictid
, robj
**argv
, int argc
) {
2586 sds cmdrepr
= sdsnew("+");
2590 gettimeofday(&tv
,NULL
);
2591 cmdrepr
= sdscatprintf(cmdrepr
,"%ld.%ld ",(long)tv
.tv_sec
,(long)tv
.tv_usec
);
2592 if (dictid
!= 0) cmdrepr
= sdscatprintf(cmdrepr
,"(db %d) ", dictid
);
2594 for (j
= 0; j
< argc
; j
++) {
2595 if (argv
[j
]->encoding
== REDIS_ENCODING_INT
) {
2596 cmdrepr
= sdscatprintf(cmdrepr
, "%ld", (long)argv
[j
]->ptr
);
2598 cmdrepr
= sdscatrepr(cmdrepr
,(char*)argv
[j
]->ptr
,
2599 sdslen(argv
[j
]->ptr
));
2602 cmdrepr
= sdscatlen(cmdrepr
," ",1);
2604 cmdrepr
= sdscatlen(cmdrepr
,"\r\n",2);
2605 cmdobj
= createObject(REDIS_STRING
,cmdrepr
);
2607 listRewind(monitors
,&li
);
2608 while((ln
= listNext(&li
))) {
2609 redisClient
*monitor
= ln
->value
;
2610 addReply(monitor
,cmdobj
);
2612 decrRefCount(cmdobj
);
2615 static void processInputBuffer(redisClient
*c
) {
2617 /* Before to process the input buffer, make sure the client is not
2618 * waitig for a blocking operation such as BLPOP. Note that the first
2619 * iteration the client is never blocked, otherwise the processInputBuffer
2620 * would not be called at all, but after the execution of the first commands
2621 * in the input buffer the client may be blocked, and the "goto again"
2622 * will try to reiterate. The following line will make it return asap. */
2623 if (c
->flags
& REDIS_BLOCKED
|| c
->flags
& REDIS_IO_WAIT
) return;
2624 if (c
->bulklen
== -1) {
2625 /* Read the first line of the query */
2626 char *p
= strchr(c
->querybuf
,'\n');
2633 query
= c
->querybuf
;
2634 c
->querybuf
= sdsempty();
2635 querylen
= 1+(p
-(query
));
2636 if (sdslen(query
) > querylen
) {
2637 /* leave data after the first line of the query in the buffer */
2638 c
->querybuf
= sdscatlen(c
->querybuf
,query
+querylen
,sdslen(query
)-querylen
);
2640 *p
= '\0'; /* remove "\n" */
2641 if (*(p
-1) == '\r') *(p
-1) = '\0'; /* and "\r" if any */
2642 sdsupdatelen(query
);
2644 /* Now we can split the query in arguments */
2645 argv
= sdssplitlen(query
,sdslen(query
)," ",1,&argc
);
2648 if (c
->argv
) zfree(c
->argv
);
2649 c
->argv
= zmalloc(sizeof(robj
*)*argc
);
2651 for (j
= 0; j
< argc
; j
++) {
2652 if (sdslen(argv
[j
])) {
2653 c
->argv
[c
->argc
] = createObject(REDIS_STRING
,argv
[j
]);
2661 /* Execute the command. If the client is still valid
2662 * after processCommand() return and there is something
2663 * on the query buffer try to process the next command. */
2664 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2666 /* Nothing to process, argc == 0. Just process the query
2667 * buffer if it's not empty or return to the caller */
2668 if (sdslen(c
->querybuf
)) goto again
;
2671 } else if (sdslen(c
->querybuf
) >= REDIS_REQUEST_MAX_SIZE
) {
2672 redisLog(REDIS_VERBOSE
, "Client protocol error");
2677 /* Bulk read handling. Note that if we are at this point
2678 the client already sent a command terminated with a newline,
2679 we are reading the bulk data that is actually the last
2680 argument of the command. */
2681 int qbl
= sdslen(c
->querybuf
);
2683 if (c
->bulklen
<= qbl
) {
2684 /* Copy everything but the final CRLF as final argument */
2685 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2687 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2688 /* Process the command. If the client is still valid after
2689 * the processing and there is more data in the buffer
2690 * try to parse it. */
2691 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2697 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2698 redisClient
*c
= (redisClient
*) privdata
;
2699 char buf
[REDIS_IOBUF_LEN
];
2702 REDIS_NOTUSED(mask
);
2704 nread
= read(fd
, buf
, REDIS_IOBUF_LEN
);
2706 if (errno
== EAGAIN
) {
2709 redisLog(REDIS_VERBOSE
, "Reading from client: %s",strerror(errno
));
2713 } else if (nread
== 0) {
2714 redisLog(REDIS_VERBOSE
, "Client closed connection");
2719 c
->querybuf
= sdscatlen(c
->querybuf
, buf
, nread
);
2720 c
->lastinteraction
= time(NULL
);
2724 processInputBuffer(c
);
2727 static int selectDb(redisClient
*c
, int id
) {
2728 if (id
< 0 || id
>= server
.dbnum
)
2730 c
->db
= &server
.db
[id
];
2734 static void *dupClientReplyValue(void *o
) {
2735 incrRefCount((robj
*)o
);
2739 static int listMatchObjects(void *a
, void *b
) {
2740 return equalStringObjects(a
,b
);
2743 static redisClient
*createClient(int fd
) {
2744 redisClient
*c
= zmalloc(sizeof(*c
));
2746 anetNonBlock(NULL
,fd
);
2747 anetTcpNoDelay(NULL
,fd
);
2748 if (!c
) return NULL
;
2751 c
->querybuf
= sdsempty();
2760 c
->lastinteraction
= time(NULL
);
2761 c
->authenticated
= 0;
2762 c
->replstate
= REDIS_REPL_NONE
;
2763 c
->reply
= listCreate();
2764 listSetFreeMethod(c
->reply
,decrRefCount
);
2765 listSetDupMethod(c
->reply
,dupClientReplyValue
);
2766 c
->blocking_keys
= NULL
;
2767 c
->blocking_keys_num
= 0;
2768 c
->io_keys
= listCreate();
2769 c
->watched_keys
= listCreate();
2770 listSetFreeMethod(c
->io_keys
,decrRefCount
);
2771 c
->pubsub_channels
= dictCreate(&setDictType
,NULL
);
2772 c
->pubsub_patterns
= listCreate();
2773 listSetFreeMethod(c
->pubsub_patterns
,decrRefCount
);
2774 listSetMatchMethod(c
->pubsub_patterns
,listMatchObjects
);
2775 if (aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
2776 readQueryFromClient
, c
) == AE_ERR
) {
2780 listAddNodeTail(server
.clients
,c
);
2781 initClientMultiState(c
);
2785 static void addReply(redisClient
*c
, robj
*obj
) {
2786 if (listLength(c
->reply
) == 0 &&
2787 (c
->replstate
== REDIS_REPL_NONE
||
2788 c
->replstate
== REDIS_REPL_ONLINE
) &&
2789 aeCreateFileEvent(server
.el
, c
->fd
, AE_WRITABLE
,
2790 sendReplyToClient
, c
) == AE_ERR
) return;
2792 if (server
.vm_enabled
&& obj
->storage
!= REDIS_VM_MEMORY
) {
2793 obj
= dupStringObject(obj
);
2794 obj
->refcount
= 0; /* getDecodedObject() will increment the refcount */
2796 listAddNodeTail(c
->reply
,getDecodedObject(obj
));
2799 static void addReplySds(redisClient
*c
, sds s
) {
2800 robj
*o
= createObject(REDIS_STRING
,s
);
2805 static void addReplyDouble(redisClient
*c
, double d
) {
2808 snprintf(buf
,sizeof(buf
),"%.17g",d
);
2809 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2810 (unsigned long) strlen(buf
),buf
));
2813 static void addReplyLongLong(redisClient
*c
, long long ll
) {
2818 addReply(c
,shared
.czero
);
2820 } else if (ll
== 1) {
2821 addReply(c
,shared
.cone
);
2825 len
= ll2string(buf
+1,sizeof(buf
)-1,ll
);
2828 addReplySds(c
,sdsnewlen(buf
,len
+3));
2831 static void addReplyUlong(redisClient
*c
, unsigned long ul
) {
2836 addReply(c
,shared
.czero
);
2838 } else if (ul
== 1) {
2839 addReply(c
,shared
.cone
);
2842 len
= snprintf(buf
,sizeof(buf
),":%lu\r\n",ul
);
2843 addReplySds(c
,sdsnewlen(buf
,len
));
2846 static void addReplyBulkLen(redisClient
*c
, robj
*obj
) {
2850 if (obj
->encoding
== REDIS_ENCODING_RAW
) {
2851 len
= sdslen(obj
->ptr
);
2853 long n
= (long)obj
->ptr
;
2855 /* Compute how many bytes will take this integer as a radix 10 string */
2861 while((n
= n
/10) != 0) {
2866 intlen
= ll2string(buf
+1,sizeof(buf
)-1,(long long)len
);
2867 buf
[intlen
+1] = '\r';
2868 buf
[intlen
+2] = '\n';
2869 addReplySds(c
,sdsnewlen(buf
,intlen
+3));
2872 static void addReplyBulk(redisClient
*c
, robj
*obj
) {
2873 addReplyBulkLen(c
,obj
);
2875 addReply(c
,shared
.crlf
);
2878 /* In the CONFIG command we need to add vanilla C string as bulk replies */
2879 static void addReplyBulkCString(redisClient
*c
, char *s
) {
2881 addReply(c
,shared
.nullbulk
);
2883 robj
*o
= createStringObject(s
,strlen(s
));
2889 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2894 REDIS_NOTUSED(mask
);
2895 REDIS_NOTUSED(privdata
);
2897 cfd
= anetAccept(server
.neterr
, fd
, cip
, &cport
);
2898 if (cfd
== AE_ERR
) {
2899 redisLog(REDIS_VERBOSE
,"Accepting client connection: %s", server
.neterr
);
2902 redisLog(REDIS_VERBOSE
,"Accepted %s:%d", cip
, cport
);
2903 if ((c
= createClient(cfd
)) == NULL
) {
2904 redisLog(REDIS_WARNING
,"Error allocating resoures for the client");
2905 close(cfd
); /* May be already closed, just ingore errors */
2908 /* If maxclient directive is set and this is one client more... close the
2909 * connection. Note that we create the client instead to check before
2910 * for this condition, since now the socket is already set in nonblocking
2911 * mode and we can send an error for free using the Kernel I/O */
2912 if (server
.maxclients
&& listLength(server
.clients
) > server
.maxclients
) {
2913 char *err
= "-ERR max number of clients reached\r\n";
2915 /* That's a best effort error message, don't check write errors */
2916 if (write(c
->fd
,err
,strlen(err
)) == -1) {
2917 /* Nothing to do, Just to avoid the warning... */
2922 server
.stat_numconnections
++;
2925 /* ======================= Redis objects implementation ===================== */
2927 static robj
*createObject(int type
, void *ptr
) {
2930 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2931 if (listLength(server
.objfreelist
)) {
2932 listNode
*head
= listFirst(server
.objfreelist
);
2933 o
= listNodeValue(head
);
2934 listDelNode(server
.objfreelist
,head
);
2935 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2937 if (server
.vm_enabled
) {
2938 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2939 o
= zmalloc(sizeof(*o
));
2941 o
= zmalloc(sizeof(*o
)-sizeof(struct redisObjectVM
));
2945 o
->encoding
= REDIS_ENCODING_RAW
;
2948 if (server
.vm_enabled
) {
2949 /* Note that this code may run in the context of an I/O thread
2950 * and accessing to server.unixtime in theory is an error
2951 * (no locks). But in practice this is safe, and even if we read
2952 * garbage Redis will not fail, as it's just a statistical info */
2953 o
->vm
.atime
= server
.unixtime
;
2954 o
->storage
= REDIS_VM_MEMORY
;
2959 static robj
*createStringObject(char *ptr
, size_t len
) {
2960 return createObject(REDIS_STRING
,sdsnewlen(ptr
,len
));
2963 static robj
*createStringObjectFromLongLong(long long value
) {
2965 if (value
>= 0 && value
< REDIS_SHARED_INTEGERS
) {
2966 incrRefCount(shared
.integers
[value
]);
2967 o
= shared
.integers
[value
];
2969 if (value
>= LONG_MIN
&& value
<= LONG_MAX
) {
2970 o
= createObject(REDIS_STRING
, NULL
);
2971 o
->encoding
= REDIS_ENCODING_INT
;
2972 o
->ptr
= (void*)((long)value
);
2974 o
= createObject(REDIS_STRING
,sdsfromlonglong(value
));
2980 static robj
*dupStringObject(robj
*o
) {
2981 assert(o
->encoding
== REDIS_ENCODING_RAW
);
2982 return createStringObject(o
->ptr
,sdslen(o
->ptr
));
2985 static robj
*createListObject(void) {
2986 list
*l
= listCreate();
2988 listSetFreeMethod(l
,decrRefCount
);
2989 return createObject(REDIS_LIST
,l
);
2992 static robj
*createSetObject(void) {
2993 dict
*d
= dictCreate(&setDictType
,NULL
);
2994 return createObject(REDIS_SET
,d
);
2997 static robj
*createHashObject(void) {
2998 /* All the Hashes start as zipmaps. Will be automatically converted
2999 * into hash tables if there are enough elements or big elements
3001 unsigned char *zm
= zipmapNew();
3002 robj
*o
= createObject(REDIS_HASH
,zm
);
3003 o
->encoding
= REDIS_ENCODING_ZIPMAP
;
3007 static robj
*createZsetObject(void) {
3008 zset
*zs
= zmalloc(sizeof(*zs
));
3010 zs
->dict
= dictCreate(&zsetDictType
,NULL
);
3011 zs
->zsl
= zslCreate();
3012 return createObject(REDIS_ZSET
,zs
);
3015 static void freeStringObject(robj
*o
) {
3016 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3021 static void freeListObject(robj
*o
) {
3022 switch (o
->encoding
) {
3023 case REDIS_ENCODING_LIST
:
3024 listRelease((list
*) o
->ptr
);
3026 case REDIS_ENCODING_ZIPLIST
:
3030 redisPanic("Unknown list encoding type");
3034 static void freeSetObject(robj
*o
) {
3035 dictRelease((dict
*) o
->ptr
);
3038 static void freeZsetObject(robj
*o
) {
3041 dictRelease(zs
->dict
);
3046 static void freeHashObject(robj
*o
) {
3047 switch (o
->encoding
) {
3048 case REDIS_ENCODING_HT
:
3049 dictRelease((dict
*) o
->ptr
);
3051 case REDIS_ENCODING_ZIPMAP
:
3055 redisPanic("Unknown hash encoding type");
3060 static void incrRefCount(robj
*o
) {
3064 static void decrRefCount(void *obj
) {
3067 if (o
->refcount
<= 0) redisPanic("decrRefCount against refcount <= 0");
3068 /* Object is a key of a swapped out value, or in the process of being
3070 if (server
.vm_enabled
&&
3071 (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
))
3073 if (o
->storage
== REDIS_VM_LOADING
) vmCancelThreadedIOJob(obj
);
3074 redisAssert(o
->type
== REDIS_STRING
);
3075 freeStringObject(o
);
3076 vmMarkPagesFree(o
->vm
.page
,o
->vm
.usedpages
);
3077 pthread_mutex_lock(&server
.obj_freelist_mutex
);
3078 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
3079 !listAddNodeHead(server
.objfreelist
,o
))
3081 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
3082 server
.vm_stats_swapped_objects
--;
3085 /* Object is in memory, or in the process of being swapped out. */
3086 if (--(o
->refcount
) == 0) {
3087 if (server
.vm_enabled
&& o
->storage
== REDIS_VM_SWAPPING
)
3088 vmCancelThreadedIOJob(obj
);
3090 case REDIS_STRING
: freeStringObject(o
); break;
3091 case REDIS_LIST
: freeListObject(o
); break;
3092 case REDIS_SET
: freeSetObject(o
); break;
3093 case REDIS_ZSET
: freeZsetObject(o
); break;
3094 case REDIS_HASH
: freeHashObject(o
); break;
3095 default: redisPanic("Unknown object type"); break;
3097 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
3098 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
3099 !listAddNodeHead(server
.objfreelist
,o
))
3101 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
3105 static robj
*lookupKey(redisDb
*db
, robj
*key
) {
3106 dictEntry
*de
= dictFind(db
->dict
,key
);
3108 robj
*key
= dictGetEntryKey(de
);
3109 robj
*val
= dictGetEntryVal(de
);
3111 if (server
.vm_enabled
) {
3112 if (key
->storage
== REDIS_VM_MEMORY
||
3113 key
->storage
== REDIS_VM_SWAPPING
)
3115 /* If we were swapping the object out, stop it, this key
3117 if (key
->storage
== REDIS_VM_SWAPPING
)
3118 vmCancelThreadedIOJob(key
);
3119 /* Update the access time of the key for the aging algorithm. */
3120 key
->vm
.atime
= server
.unixtime
;
3122 int notify
= (key
->storage
== REDIS_VM_LOADING
);
3124 /* Our value was swapped on disk. Bring it at home. */
3125 redisAssert(val
== NULL
);
3126 val
= vmLoadObject(key
);
3127 dictGetEntryVal(de
) = val
;
3129 /* Clients blocked by the VM subsystem may be waiting for
3131 if (notify
) handleClientsBlockedOnSwappedKey(db
,key
);
3140 static robj
*lookupKeyRead(redisDb
*db
, robj
*key
) {
3141 expireIfNeeded(db
,key
);
3142 return lookupKey(db
,key
);
3145 static robj
*lookupKeyWrite(redisDb
*db
, robj
*key
) {
3146 deleteIfVolatile(db
,key
);
3147 touchWatchedKey(db
,key
);
3148 return lookupKey(db
,key
);
3151 static robj
*lookupKeyReadOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
3152 robj
*o
= lookupKeyRead(c
->db
, key
);
3153 if (!o
) addReply(c
,reply
);
3157 static robj
*lookupKeyWriteOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
3158 robj
*o
= lookupKeyWrite(c
->db
, key
);
3159 if (!o
) addReply(c
,reply
);
3163 static int checkType(redisClient
*c
, robj
*o
, int type
) {
3164 if (o
->type
!= type
) {
3165 addReply(c
,shared
.wrongtypeerr
);
3171 static int deleteKey(redisDb
*db
, robj
*key
) {
3174 /* We need to protect key from destruction: after the first dictDelete()
3175 * it may happen that 'key' is no longer valid if we don't increment
3176 * it's count. This may happen when we get the object reference directly
3177 * from the hash table with dictRandomKey() or dict iterators */
3179 if (dictSize(db
->expires
)) dictDelete(db
->expires
,key
);
3180 retval
= dictDelete(db
->dict
,key
);
3183 return retval
== DICT_OK
;
3186 /* Check if the nul-terminated string 's' can be represented by a long
3187 * (that is, is a number that fits into long without any other space or
3188 * character before or after the digits).
3190 * If so, the function returns REDIS_OK and *longval is set to the value
3191 * of the number. Otherwise REDIS_ERR is returned */
3192 static int isStringRepresentableAsLong(sds s
, long *longval
) {
3193 char buf
[32], *endptr
;
3197 value
= strtol(s
, &endptr
, 10);
3198 if (endptr
[0] != '\0') return REDIS_ERR
;
3199 slen
= ll2string(buf
,32,value
);
3201 /* If the number converted back into a string is not identical
3202 * then it's not possible to encode the string as integer */
3203 if (sdslen(s
) != (unsigned)slen
|| memcmp(buf
,s
,slen
)) return REDIS_ERR
;
3204 if (longval
) *longval
= value
;
3208 /* Try to encode a string object in order to save space */
3209 static robj
*tryObjectEncoding(robj
*o
) {
3213 if (o
->encoding
!= REDIS_ENCODING_RAW
)
3214 return o
; /* Already encoded */
3216 /* It's not safe to encode shared objects: shared objects can be shared
3217 * everywhere in the "object space" of Redis. Encoded objects can only
3218 * appear as "values" (and not, for instance, as keys) */
3219 if (o
->refcount
> 1) return o
;
3221 /* Currently we try to encode only strings */
3222 redisAssert(o
->type
== REDIS_STRING
);
3224 /* Check if we can represent this string as a long integer */
3225 if (isStringRepresentableAsLong(s
,&value
) == REDIS_ERR
) return o
;
3227 /* Ok, this object can be encoded */
3228 if (value
>= 0 && value
< REDIS_SHARED_INTEGERS
) {
3230 incrRefCount(shared
.integers
[value
]);
3231 return shared
.integers
[value
];
3233 o
->encoding
= REDIS_ENCODING_INT
;
3235 o
->ptr
= (void*) value
;
3240 /* Get a decoded version of an encoded object (returned as a new object).
3241 * If the object is already raw-encoded just increment the ref count. */
3242 static robj
*getDecodedObject(robj
*o
) {
3245 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3249 if (o
->type
== REDIS_STRING
&& o
->encoding
== REDIS_ENCODING_INT
) {
3252 ll2string(buf
,32,(long)o
->ptr
);
3253 dec
= createStringObject(buf
,strlen(buf
));
3256 redisPanic("Unknown encoding type");
3260 /* Compare two string objects via strcmp() or alike.
3261 * Note that the objects may be integer-encoded. In such a case we
3262 * use ll2string() to get a string representation of the numbers on the stack
3263 * and compare the strings, it's much faster than calling getDecodedObject().
3265 * Important note: if objects are not integer encoded, but binary-safe strings,
3266 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
3268 static int compareStringObjects(robj
*a
, robj
*b
) {
3269 redisAssert(a
->type
== REDIS_STRING
&& b
->type
== REDIS_STRING
);
3270 char bufa
[128], bufb
[128], *astr
, *bstr
;
3273 if (a
== b
) return 0;
3274 if (a
->encoding
!= REDIS_ENCODING_RAW
) {
3275 ll2string(bufa
,sizeof(bufa
),(long) a
->ptr
);
3281 if (b
->encoding
!= REDIS_ENCODING_RAW
) {
3282 ll2string(bufb
,sizeof(bufb
),(long) b
->ptr
);
3288 return bothsds
? sdscmp(astr
,bstr
) : strcmp(astr
,bstr
);
3291 /* Equal string objects return 1 if the two objects are the same from the
3292 * point of view of a string comparison, otherwise 0 is returned. Note that
3293 * this function is faster then checking for (compareStringObject(a,b) == 0)
3294 * because it can perform some more optimization. */
3295 static int equalStringObjects(robj
*a
, robj
*b
) {
3296 if (a
->encoding
!= REDIS_ENCODING_RAW
&& b
->encoding
!= REDIS_ENCODING_RAW
){
3297 return a
->ptr
== b
->ptr
;
3299 return compareStringObjects(a
,b
) == 0;
3303 static size_t stringObjectLen(robj
*o
) {
3304 redisAssert(o
->type
== REDIS_STRING
);
3305 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3306 return sdslen(o
->ptr
);
3310 return ll2string(buf
,32,(long)o
->ptr
);
3314 static int getDoubleFromObject(robj
*o
, double *target
) {
3321 redisAssert(o
->type
== REDIS_STRING
);
3322 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3323 value
= strtod(o
->ptr
, &eptr
);
3324 if (eptr
[0] != '\0') return REDIS_ERR
;
3325 } else if (o
->encoding
== REDIS_ENCODING_INT
) {
3326 value
= (long)o
->ptr
;
3328 redisPanic("Unknown string encoding");
3336 static int getDoubleFromObjectOrReply(redisClient
*c
, robj
*o
, double *target
, const char *msg
) {
3338 if (getDoubleFromObject(o
, &value
) != REDIS_OK
) {
3340 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3342 addReplySds(c
, sdsnew("-ERR value is not a double\r\n"));
3351 static int getLongLongFromObject(robj
*o
, long long *target
) {
3358 redisAssert(o
->type
== REDIS_STRING
);
3359 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3360 value
= strtoll(o
->ptr
, &eptr
, 10);
3361 if (eptr
[0] != '\0') return REDIS_ERR
;
3362 } else if (o
->encoding
== REDIS_ENCODING_INT
) {
3363 value
= (long)o
->ptr
;
3365 redisPanic("Unknown string encoding");
3373 static int getLongLongFromObjectOrReply(redisClient
*c
, robj
*o
, long long *target
, const char *msg
) {
3375 if (getLongLongFromObject(o
, &value
) != REDIS_OK
) {
3377 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3379 addReplySds(c
, sdsnew("-ERR value is not an integer\r\n"));
3388 static int getLongFromObjectOrReply(redisClient
*c
, robj
*o
, long *target
, const char *msg
) {
3391 if (getLongLongFromObjectOrReply(c
, o
, &value
, msg
) != REDIS_OK
) return REDIS_ERR
;
3392 if (value
< LONG_MIN
|| value
> LONG_MAX
) {
3394 addReplySds(c
, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg
));
3396 addReplySds(c
, sdsnew("-ERR value is out of range\r\n"));
3405 /*============================ RDB saving/loading =========================== */
3407 static int rdbSaveType(FILE *fp
, unsigned char type
) {
3408 if (fwrite(&type
,1,1,fp
) == 0) return -1;
3412 static int rdbSaveTime(FILE *fp
, time_t t
) {
3413 int32_t t32
= (int32_t) t
;
3414 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
3418 /* check rdbLoadLen() comments for more info */
3419 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
3420 unsigned char buf
[2];
3423 /* Save a 6 bit len */
3424 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
3425 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3426 } else if (len
< (1<<14)) {
3427 /* Save a 14 bit len */
3428 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
3430 if (fwrite(buf
,2,1,fp
) == 0) return -1;
3432 /* Save a 32 bit len */
3433 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
3434 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3436 if (fwrite(&len
,4,1,fp
) == 0) return -1;
3441 /* Encode 'value' as an integer if possible (if integer will fit the
3442 * supported range). If the function sucessful encoded the integer
3443 * then the (up to 5 bytes) encoded representation is written in the
3444 * string pointed by 'enc' and the length is returned. Otherwise
3446 static int rdbEncodeInteger(long long value
, unsigned char *enc
) {
3447 /* Finally check if it fits in our ranges */
3448 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
3449 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
3450 enc
[1] = value
&0xFF;
3452 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
3453 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
3454 enc
[1] = value
&0xFF;
3455 enc
[2] = (value
>>8)&0xFF;
3457 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
3458 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
3459 enc
[1] = value
&0xFF;
3460 enc
[2] = (value
>>8)&0xFF;
3461 enc
[3] = (value
>>16)&0xFF;
3462 enc
[4] = (value
>>24)&0xFF;
3469 /* String objects in the form "2391" "-100" without any space and with a
3470 * range of values that can fit in an 8, 16 or 32 bit signed value can be
3471 * encoded as integers to save space */
3472 static int rdbTryIntegerEncoding(char *s
, size_t len
, unsigned char *enc
) {
3474 char *endptr
, buf
[32];
3476 /* Check if it's possible to encode this value as a number */
3477 value
= strtoll(s
, &endptr
, 10);
3478 if (endptr
[0] != '\0') return 0;
3479 ll2string(buf
,32,value
);
3481 /* If the number converted back into a string is not identical
3482 * then it's not possible to encode the string as integer */
3483 if (strlen(buf
) != len
|| memcmp(buf
,s
,len
)) return 0;
3485 return rdbEncodeInteger(value
,enc
);
3488 static int rdbSaveLzfStringObject(FILE *fp
, unsigned char *s
, size_t len
) {
3489 size_t comprlen
, outlen
;
3493 /* We require at least four bytes compression for this to be worth it */
3494 if (len
<= 4) return 0;
3496 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
3497 comprlen
= lzf_compress(s
, len
, out
, outlen
);
3498 if (comprlen
== 0) {
3502 /* Data compressed! Let's save it on disk */
3503 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
3504 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
3505 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
3506 if (rdbSaveLen(fp
,len
) == -1) goto writeerr
;
3507 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
3516 /* Save a string objet as [len][data] on disk. If the object is a string
3517 * representation of an integer value we try to safe it in a special form */
3518 static int rdbSaveRawString(FILE *fp
, unsigned char *s
, size_t len
) {
3521 /* Try integer encoding */
3523 unsigned char buf
[5];
3524 if ((enclen
= rdbTryIntegerEncoding((char*)s
,len
,buf
)) > 0) {
3525 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3530 /* Try LZF compression - under 20 bytes it's unable to compress even
3531 * aaaaaaaaaaaaaaaaaa so skip it */
3532 if (server
.rdbcompression
&& len
> 20) {
3535 retval
= rdbSaveLzfStringObject(fp
,s
,len
);
3536 if (retval
== -1) return -1;
3537 if (retval
> 0) return 0;
3538 /* retval == 0 means data can't be compressed, save the old way */
3541 /* Store verbatim */
3542 if (rdbSaveLen(fp
,len
) == -1) return -1;
3543 if (len
&& fwrite(s
,len
,1,fp
) == 0) return -1;
3547 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
3548 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
3551 /* Avoid to decode the object, then encode it again, if the
3552 * object is alrady integer encoded. */
3553 if (obj
->encoding
== REDIS_ENCODING_INT
) {
3554 long val
= (long) obj
->ptr
;
3555 unsigned char buf
[5];
3558 if ((enclen
= rdbEncodeInteger(val
,buf
)) > 0) {
3559 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3562 /* otherwise... fall throught and continue with the usual
3566 /* Avoid incr/decr ref count business when possible.
3567 * This plays well with copy-on-write given that we are probably
3568 * in a child process (BGSAVE). Also this makes sure key objects
3569 * of swapped objects are not incRefCount-ed (an assert does not allow
3570 * this in order to avoid bugs) */
3571 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
3572 obj
= getDecodedObject(obj
);
3573 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3576 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3581 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
3582 * 8 bit integer specifing the length of the representation.
3583 * This 8 bit integer has special values in order to specify the following
3589 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
3590 unsigned char buf
[128];
3596 } else if (!isfinite(val
)) {
3598 buf
[0] = (val
< 0) ? 255 : 254;
3600 #if (DBL_MANT_DIG >= 52) && (LLONG_MAX == 0x7fffffffffffffffLL)
3601 /* Check if the float is in a safe range to be casted into a
3602 * long long. We are assuming that long long is 64 bit here.
3603 * Also we are assuming that there are no implementations around where
3604 * double has precision < 52 bit.
3606 * Under this assumptions we test if a double is inside an interval
3607 * where casting to long long is safe. Then using two castings we
3608 * make sure the decimal part is zero. If all this is true we use
3609 * integer printing function that is much faster. */
3610 double min
= -4503599627370495; /* (2^52)-1 */
3611 double max
= 4503599627370496; /* -(2^52) */
3612 if (val
> min
&& val
< max
&& val
== ((double)((long long)val
)))
3613 ll2string((char*)buf
+1,sizeof(buf
),(long long)val
);
3616 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
3617 buf
[0] = strlen((char*)buf
+1);
3620 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
3624 /* Save a Redis object. */
3625 static int rdbSaveObject(FILE *fp
, robj
*o
) {
3626 if (o
->type
== REDIS_STRING
) {
3627 /* Save a string value */
3628 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
3629 } else if (o
->type
== REDIS_LIST
) {
3630 /* Save a list value */
3631 list
*list
= o
->ptr
;
3635 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
3636 listRewind(list
,&li
);
3637 while((ln
= listNext(&li
))) {
3638 robj
*eleobj
= listNodeValue(ln
);
3640 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3642 } else if (o
->type
== REDIS_SET
) {
3643 /* Save a set value */
3645 dictIterator
*di
= dictGetIterator(set
);
3648 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
3649 while((de
= dictNext(di
)) != NULL
) {
3650 robj
*eleobj
= dictGetEntryKey(de
);
3652 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3654 dictReleaseIterator(di
);
3655 } else if (o
->type
== REDIS_ZSET
) {
3656 /* Save a set value */
3658 dictIterator
*di
= dictGetIterator(zs
->dict
);
3661 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
3662 while((de
= dictNext(di
)) != NULL
) {
3663 robj
*eleobj
= dictGetEntryKey(de
);
3664 double *score
= dictGetEntryVal(de
);
3666 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3667 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
3669 dictReleaseIterator(di
);
3670 } else if (o
->type
== REDIS_HASH
) {
3671 /* Save a hash value */
3672 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3673 unsigned char *p
= zipmapRewind(o
->ptr
);
3674 unsigned int count
= zipmapLen(o
->ptr
);
3675 unsigned char *key
, *val
;
3676 unsigned int klen
, vlen
;
3678 if (rdbSaveLen(fp
,count
) == -1) return -1;
3679 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
3680 if (rdbSaveRawString(fp
,key
,klen
) == -1) return -1;
3681 if (rdbSaveRawString(fp
,val
,vlen
) == -1) return -1;
3684 dictIterator
*di
= dictGetIterator(o
->ptr
);
3687 if (rdbSaveLen(fp
,dictSize((dict
*)o
->ptr
)) == -1) return -1;
3688 while((de
= dictNext(di
)) != NULL
) {
3689 robj
*key
= dictGetEntryKey(de
);
3690 robj
*val
= dictGetEntryVal(de
);
3692 if (rdbSaveStringObject(fp
,key
) == -1) return -1;
3693 if (rdbSaveStringObject(fp
,val
) == -1) return -1;
3695 dictReleaseIterator(di
);
3698 redisPanic("Unknown object type");
3703 /* Return the length the object will have on disk if saved with
3704 * the rdbSaveObject() function. Currently we use a trick to get
3705 * this length with very little changes to the code. In the future
3706 * we could switch to a faster solution. */
3707 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
3708 if (fp
== NULL
) fp
= server
.devnull
;
3710 assert(rdbSaveObject(fp
,o
) != 1);
3714 /* Return the number of pages required to save this object in the swap file */
3715 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
3716 off_t bytes
= rdbSavedObjectLen(o
,fp
);
3718 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
3721 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3722 static int rdbSave(char *filename
) {
3723 dictIterator
*di
= NULL
;
3728 time_t now
= time(NULL
);
3730 /* Wait for I/O therads to terminate, just in case this is a
3731 * foreground-saving, to avoid seeking the swap file descriptor at the
3733 if (server
.vm_enabled
)
3734 waitEmptyIOJobsQueue();
3736 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3737 fp
= fopen(tmpfile
,"w");
3739 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3742 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3743 for (j
= 0; j
< server
.dbnum
; j
++) {
3744 redisDb
*db
= server
.db
+j
;
3746 if (dictSize(d
) == 0) continue;
3747 di
= dictGetIterator(d
);
3753 /* Write the SELECT DB opcode */
3754 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3755 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3757 /* Iterate this DB writing every entry */
3758 while((de
= dictNext(di
)) != NULL
) {
3759 robj
*key
= dictGetEntryKey(de
);
3760 robj
*o
= dictGetEntryVal(de
);
3761 time_t expiretime
= getExpire(db
,key
);
3763 /* Save the expire time */
3764 if (expiretime
!= -1) {
3765 /* If this key is already expired skip it */
3766 if (expiretime
< now
) continue;
3767 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3768 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3770 /* Save the key and associated value. This requires special
3771 * handling if the value is swapped out. */
3772 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
3773 key
->storage
== REDIS_VM_SWAPPING
) {
3774 /* Save type, key, value */
3775 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3776 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3777 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3779 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3781 /* Get a preview of the object in memory */
3782 po
= vmPreviewObject(key
);
3783 /* Save type, key, value */
3784 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
3785 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3786 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3787 /* Remove the loaded object from memory */
3791 dictReleaseIterator(di
);
3794 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3796 /* Make sure data will not remain on the OS's output buffers */
3801 /* Use RENAME to make sure the DB file is changed atomically only
3802 * if the generate DB file is ok. */
3803 if (rename(tmpfile
,filename
) == -1) {
3804 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3808 redisLog(REDIS_NOTICE
,"DB saved on disk");
3810 server
.lastsave
= time(NULL
);
3816 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3817 if (di
) dictReleaseIterator(di
);
3821 static int rdbSaveBackground(char *filename
) {
3824 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3825 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
3826 if ((childpid
= fork()) == 0) {
3828 if (server
.vm_enabled
) vmReopenSwapFile();
3830 if (rdbSave(filename
) == REDIS_OK
) {
3837 if (childpid
== -1) {
3838 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3842 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3843 server
.bgsavechildpid
= childpid
;
3844 updateDictResizePolicy();
3847 return REDIS_OK
; /* unreached */
3850 static void rdbRemoveTempFile(pid_t childpid
) {
3853 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
3857 static int rdbLoadType(FILE *fp
) {
3859 if (fread(&type
,1,1,fp
) == 0) return -1;
3863 static time_t rdbLoadTime(FILE *fp
) {
3865 if (fread(&t32
,4,1,fp
) == 0) return -1;
3866 return (time_t) t32
;
3869 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3870 * of this file for a description of how this are stored on disk.
3872 * isencoded is set to 1 if the readed length is not actually a length but
3873 * an "encoding type", check the above comments for more info */
3874 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3875 unsigned char buf
[2];
3879 if (isencoded
) *isencoded
= 0;
3880 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3881 type
= (buf
[0]&0xC0)>>6;
3882 if (type
== REDIS_RDB_6BITLEN
) {
3883 /* Read a 6 bit len */
3885 } else if (type
== REDIS_RDB_ENCVAL
) {
3886 /* Read a 6 bit len encoding type */
3887 if (isencoded
) *isencoded
= 1;
3889 } else if (type
== REDIS_RDB_14BITLEN
) {
3890 /* Read a 14 bit len */
3891 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3892 return ((buf
[0]&0x3F)<<8)|buf
[1];
3894 /* Read a 32 bit len */
3895 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3900 /* Load an integer-encoded object from file 'fp', with the specified
3901 * encoding type 'enctype'. If encode is true the function may return
3902 * an integer-encoded object as reply, otherwise the returned object
3903 * will always be encoded as a raw string. */
3904 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
, int encode
) {
3905 unsigned char enc
[4];
3908 if (enctype
== REDIS_RDB_ENC_INT8
) {
3909 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3910 val
= (signed char)enc
[0];
3911 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3913 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3914 v
= enc
[0]|(enc
[1]<<8);
3916 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3918 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3919 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3922 val
= 0; /* anti-warning */
3923 redisPanic("Unknown RDB integer encoding type");
3926 return createStringObjectFromLongLong(val
);
3928 return createObject(REDIS_STRING
,sdsfromlonglong(val
));
3931 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3932 unsigned int len
, clen
;
3933 unsigned char *c
= NULL
;
3936 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3937 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3938 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3939 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3940 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3941 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3943 return createObject(REDIS_STRING
,val
);
3950 static robj
*rdbGenericLoadStringObject(FILE*fp
, int encode
) {
3955 len
= rdbLoadLen(fp
,&isencoded
);
3958 case REDIS_RDB_ENC_INT8
:
3959 case REDIS_RDB_ENC_INT16
:
3960 case REDIS_RDB_ENC_INT32
:
3961 return rdbLoadIntegerObject(fp
,len
,encode
);
3962 case REDIS_RDB_ENC_LZF
:
3963 return rdbLoadLzfStringObject(fp
);
3965 redisPanic("Unknown RDB encoding type");
3969 if (len
== REDIS_RDB_LENERR
) return NULL
;
3970 val
= sdsnewlen(NULL
,len
);
3971 if (len
&& fread(val
,len
,1,fp
) == 0) {
3975 return createObject(REDIS_STRING
,val
);
3978 static robj
*rdbLoadStringObject(FILE *fp
) {
3979 return rdbGenericLoadStringObject(fp
,0);
3982 static robj
*rdbLoadEncodedStringObject(FILE *fp
) {
3983 return rdbGenericLoadStringObject(fp
,1);
3986 /* For information about double serialization check rdbSaveDoubleValue() */
3987 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
3991 if (fread(&len
,1,1,fp
) == 0) return -1;
3993 case 255: *val
= R_NegInf
; return 0;
3994 case 254: *val
= R_PosInf
; return 0;
3995 case 253: *val
= R_Nan
; return 0;
3997 if (fread(buf
,len
,1,fp
) == 0) return -1;
3999 sscanf(buf
, "%lg", val
);
4004 /* Load a Redis object of the specified type from the specified file.
4005 * On success a newly allocated object is returned, otherwise NULL. */
4006 static robj
*rdbLoadObject(int type
, FILE *fp
) {
4009 redisLog(REDIS_DEBUG
,"LOADING OBJECT %d (at %d)\n",type
,ftell(fp
));
4010 if (type
== REDIS_STRING
) {
4011 /* Read string value */
4012 if ((o
= rdbLoadEncodedStringObject(fp
)) == NULL
) return NULL
;
4013 o
= tryObjectEncoding(o
);
4014 } else if (type
== REDIS_LIST
|| type
== REDIS_SET
) {
4015 /* Read list/set value */
4018 if ((listlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
4019 o
= (type
== REDIS_LIST
) ? createListObject() : createSetObject();
4020 /* It's faster to expand the dict to the right size asap in order
4021 * to avoid rehashing */
4022 if (type
== REDIS_SET
&& listlen
> DICT_HT_INITIAL_SIZE
)
4023 dictExpand(o
->ptr
,listlen
);
4024 /* Load every single element of the list/set */
4028 if ((ele
= rdbLoadEncodedStringObject(fp
)) == NULL
) return NULL
;
4029 ele
= tryObjectEncoding(ele
);
4030 if (type
== REDIS_LIST
) {
4031 listAddNodeTail((list
*)o
->ptr
,ele
);
4033 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
4036 } else if (type
== REDIS_ZSET
) {
4037 /* Read list/set value */
4041 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
4042 o
= createZsetObject();
4044 /* Load every single element of the list/set */
4047 double *score
= zmalloc(sizeof(double));
4049 if ((ele
= rdbLoadEncodedStringObject(fp
)) == NULL
) return NULL
;
4050 ele
= tryObjectEncoding(ele
);
4051 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
4052 dictAdd(zs
->dict
,ele
,score
);
4053 zslInsert(zs
->zsl
,*score
,ele
);
4054 incrRefCount(ele
); /* added to skiplist */
4056 } else if (type
== REDIS_HASH
) {
4059 if ((hashlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
4060 o
= createHashObject();
4061 /* Too many entries? Use an hash table. */
4062 if (hashlen
> server
.hash_max_zipmap_entries
)
4063 convertToRealHash(o
);
4064 /* Load every key/value, then set it into the zipmap or hash
4065 * table, as needed. */
4069 if ((key
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
4070 if ((val
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
4071 /* If we are using a zipmap and there are too big values
4072 * the object is converted to real hash table encoding. */
4073 if (o
->encoding
!= REDIS_ENCODING_HT
&&
4074 (sdslen(key
->ptr
) > server
.hash_max_zipmap_value
||
4075 sdslen(val
->ptr
) > server
.hash_max_zipmap_value
))
4077 convertToRealHash(o
);
4080 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
4081 unsigned char *zm
= o
->ptr
;
4083 zm
= zipmapSet(zm
,key
->ptr
,sdslen(key
->ptr
),
4084 val
->ptr
,sdslen(val
->ptr
),NULL
);
4089 key
= tryObjectEncoding(key
);
4090 val
= tryObjectEncoding(val
);
4091 dictAdd((dict
*)o
->ptr
,key
,val
);
4095 redisPanic("Unknown object type");
4100 static int rdbLoad(char *filename
) {
4103 int type
, retval
, rdbver
;
4104 int swap_all_values
= 0;
4105 dict
*d
= server
.db
[0].dict
;
4106 redisDb
*db
= server
.db
+0;
4108 time_t expiretime
, now
= time(NULL
);
4109 long long loadedkeys
= 0;
4111 fp
= fopen(filename
,"r");
4112 if (!fp
) return REDIS_ERR
;
4113 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
4115 if (memcmp(buf
,"REDIS",5) != 0) {
4117 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
4120 rdbver
= atoi(buf
+5);
4123 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
4131 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
4132 if (type
== REDIS_EXPIRETIME
) {
4133 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
4134 /* We read the time so we need to read the object type again */
4135 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
4137 if (type
== REDIS_EOF
) break;
4138 /* Handle SELECT DB opcode as a special case */
4139 if (type
== REDIS_SELECTDB
) {
4140 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
4142 if (dbid
>= (unsigned)server
.dbnum
) {
4143 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
4146 db
= server
.db
+dbid
;
4151 if ((key
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
4153 if ((val
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
4154 /* Check if the key already expired */
4155 if (expiretime
!= -1 && expiretime
< now
) {
4160 /* Add the new object in the hash table */
4161 retval
= dictAdd(d
,key
,val
);
4162 if (retval
== DICT_ERR
) {
4163 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", key
->ptr
);
4167 /* Set the expire time if needed */
4168 if (expiretime
!= -1) setExpire(db
,key
,expiretime
);
4170 /* Handle swapping while loading big datasets when VM is on */
4172 /* If we detecter we are hopeless about fitting something in memory
4173 * we just swap every new key on disk. Directly...
4174 * Note that's important to check for this condition before resorting
4175 * to random sampling, otherwise we may try to swap already
4177 if (swap_all_values
) {
4178 dictEntry
*de
= dictFind(d
,key
);
4180 /* de may be NULL since the key already expired */
4182 key
= dictGetEntryKey(de
);
4183 val
= dictGetEntryVal(de
);
4185 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
4186 dictGetEntryVal(de
) = NULL
;
4192 /* If we have still some hope of having some value fitting memory
4193 * then we try random sampling. */
4194 if (!swap_all_values
&& server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
4195 while (zmalloc_used_memory() > server
.vm_max_memory
) {
4196 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
4198 if (zmalloc_used_memory() > server
.vm_max_memory
)
4199 swap_all_values
= 1; /* We are already using too much mem */
4205 eoferr
: /* unexpected end of file is handled here with a fatal exit */
4206 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
4208 return REDIS_ERR
; /* Just to avoid warning */
4211 /*================================== Shutdown =============================== */
4212 static int prepareForShutdown() {
4213 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
4214 /* Kill the saving child if there is a background saving in progress.
4215 We want to avoid race conditions, for instance our saving child may
4216 overwrite the synchronous saving did by SHUTDOWN. */
4217 if (server
.bgsavechildpid
!= -1) {
4218 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
4219 kill(server
.bgsavechildpid
,SIGKILL
);
4220 rdbRemoveTempFile(server
.bgsavechildpid
);
4222 if (server
.appendonly
) {
4223 /* Append only file: fsync() the AOF and exit */
4224 fsync(server
.appendfd
);
4225 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4227 /* Snapshotting. Perform a SYNC SAVE and exit */
4228 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4229 if (server
.daemonize
)
4230 unlink(server
.pidfile
);
4231 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
4233 /* Ooops.. error saving! The best we can do is to continue
4234 * operating. Note that if there was a background saving process,
4235 * in the next cron() Redis will be notified that the background
4236 * saving aborted, handling special stuff like slaves pending for
4237 * synchronization... */
4238 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
4242 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
4246 /*================================== Commands =============================== */
4248 static void authCommand(redisClient
*c
) {
4249 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
4250 c
->authenticated
= 1;
4251 addReply(c
,shared
.ok
);
4253 c
->authenticated
= 0;
4254 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
4258 static void pingCommand(redisClient
*c
) {
4259 addReply(c
,shared
.pong
);
4262 static void echoCommand(redisClient
*c
) {
4263 addReplyBulk(c
,c
->argv
[1]);
4266 /*=================================== Strings =============================== */
4268 static void setGenericCommand(redisClient
*c
, int nx
, robj
*key
, robj
*val
, robj
*expire
) {
4270 long seconds
= 0; /* initialized to avoid an harmness warning */
4273 if (getLongFromObjectOrReply(c
, expire
, &seconds
, NULL
) != REDIS_OK
)
4276 addReplySds(c
,sdsnew("-ERR invalid expire time in SETEX\r\n"));
4281 touchWatchedKey(c
->db
,key
);
4282 if (nx
) deleteIfVolatile(c
->db
,key
);
4283 retval
= dictAdd(c
->db
->dict
,key
,val
);
4284 if (retval
== DICT_ERR
) {
4286 /* If the key is about a swapped value, we want a new key object
4287 * to overwrite the old. So we delete the old key in the database.
4288 * This will also make sure that swap pages about the old object
4289 * will be marked as free. */
4290 if (server
.vm_enabled
&& deleteIfSwapped(c
->db
,key
))
4292 dictReplace(c
->db
->dict
,key
,val
);
4295 addReply(c
,shared
.czero
);
4303 removeExpire(c
->db
,key
);
4304 if (expire
) setExpire(c
->db
,key
,time(NULL
)+seconds
);
4305 addReply(c
, nx
? shared
.cone
: shared
.ok
);
4308 static void setCommand(redisClient
*c
) {
4309 setGenericCommand(c
,0,c
->argv
[1],c
->argv
[2],NULL
);
4312 static void setnxCommand(redisClient
*c
) {
4313 setGenericCommand(c
,1,c
->argv
[1],c
->argv
[2],NULL
);
4316 static void setexCommand(redisClient
*c
) {
4317 setGenericCommand(c
,0,c
->argv
[1],c
->argv
[3],c
->argv
[2]);
4320 static int getGenericCommand(redisClient
*c
) {
4323 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
)
4326 if (o
->type
!= REDIS_STRING
) {
4327 addReply(c
,shared
.wrongtypeerr
);
4335 static void getCommand(redisClient
*c
) {
4336 getGenericCommand(c
);
4339 static void getsetCommand(redisClient
*c
) {
4340 if (getGenericCommand(c
) == REDIS_ERR
) return;
4341 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
4342 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4344 incrRefCount(c
->argv
[1]);
4346 incrRefCount(c
->argv
[2]);
4348 removeExpire(c
->db
,c
->argv
[1]);
4351 static void mgetCommand(redisClient
*c
) {
4354 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
4355 for (j
= 1; j
< c
->argc
; j
++) {
4356 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
4358 addReply(c
,shared
.nullbulk
);
4360 if (o
->type
!= REDIS_STRING
) {
4361 addReply(c
,shared
.nullbulk
);
4369 static void msetGenericCommand(redisClient
*c
, int nx
) {
4370 int j
, busykeys
= 0;
4372 if ((c
->argc
% 2) == 0) {
4373 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
4376 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
4377 * set nothing at all if at least one already key exists. */
4379 for (j
= 1; j
< c
->argc
; j
+= 2) {
4380 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
4386 addReply(c
, shared
.czero
);
4390 for (j
= 1; j
< c
->argc
; j
+= 2) {
4393 c
->argv
[j
+1] = tryObjectEncoding(c
->argv
[j
+1]);
4394 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
4395 if (retval
== DICT_ERR
) {
4396 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
4397 incrRefCount(c
->argv
[j
+1]);
4399 incrRefCount(c
->argv
[j
]);
4400 incrRefCount(c
->argv
[j
+1]);
4402 removeExpire(c
->db
,c
->argv
[j
]);
4404 server
.dirty
+= (c
->argc
-1)/2;
4405 addReply(c
, nx
? shared
.cone
: shared
.ok
);
4408 static void msetCommand(redisClient
*c
) {
4409 msetGenericCommand(c
,0);
4412 static void msetnxCommand(redisClient
*c
) {
4413 msetGenericCommand(c
,1);
4416 static void incrDecrCommand(redisClient
*c
, long long incr
) {
4421 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4422 if (o
!= NULL
&& checkType(c
,o
,REDIS_STRING
)) return;
4423 if (getLongLongFromObjectOrReply(c
,o
,&value
,NULL
) != REDIS_OK
) return;
4426 o
= createStringObjectFromLongLong(value
);
4427 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
4428 if (retval
== DICT_ERR
) {
4429 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4430 removeExpire(c
->db
,c
->argv
[1]);
4432 incrRefCount(c
->argv
[1]);
4435 addReply(c
,shared
.colon
);
4437 addReply(c
,shared
.crlf
);
4440 static void incrCommand(redisClient
*c
) {
4441 incrDecrCommand(c
,1);
4444 static void decrCommand(redisClient
*c
) {
4445 incrDecrCommand(c
,-1);
4448 static void incrbyCommand(redisClient
*c
) {
4451 if (getLongLongFromObjectOrReply(c
, c
->argv
[2], &incr
, NULL
) != REDIS_OK
) return;
4452 incrDecrCommand(c
,incr
);
4455 static void decrbyCommand(redisClient
*c
) {
4458 if (getLongLongFromObjectOrReply(c
, c
->argv
[2], &incr
, NULL
) != REDIS_OK
) return;
4459 incrDecrCommand(c
,-incr
);
4462 static void appendCommand(redisClient
*c
) {
4467 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4469 /* Create the key */
4470 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4471 incrRefCount(c
->argv
[1]);
4472 incrRefCount(c
->argv
[2]);
4473 totlen
= stringObjectLen(c
->argv
[2]);
4477 de
= dictFind(c
->db
->dict
,c
->argv
[1]);
4480 o
= dictGetEntryVal(de
);
4481 if (o
->type
!= REDIS_STRING
) {
4482 addReply(c
,shared
.wrongtypeerr
);
4485 /* If the object is specially encoded or shared we have to make
4487 if (o
->refcount
!= 1 || o
->encoding
!= REDIS_ENCODING_RAW
) {
4488 robj
*decoded
= getDecodedObject(o
);
4490 o
= createStringObject(decoded
->ptr
, sdslen(decoded
->ptr
));
4491 decrRefCount(decoded
);
4492 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4495 if (c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
) {
4496 o
->ptr
= sdscatlen(o
->ptr
,
4497 c
->argv
[2]->ptr
, sdslen(c
->argv
[2]->ptr
));
4499 o
->ptr
= sdscatprintf(o
->ptr
, "%ld",
4500 (unsigned long) c
->argv
[2]->ptr
);
4502 totlen
= sdslen(o
->ptr
);
4505 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen
));
4508 static void substrCommand(redisClient
*c
) {
4510 long start
= atoi(c
->argv
[2]->ptr
);
4511 long end
= atoi(c
->argv
[3]->ptr
);
4512 size_t rangelen
, strlen
;
4515 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4516 checkType(c
,o
,REDIS_STRING
)) return;
4518 o
= getDecodedObject(o
);
4519 strlen
= sdslen(o
->ptr
);
4521 /* convert negative indexes */
4522 if (start
< 0) start
= strlen
+start
;
4523 if (end
< 0) end
= strlen
+end
;
4524 if (start
< 0) start
= 0;
4525 if (end
< 0) end
= 0;
4527 /* indexes sanity checks */
4528 if (start
> end
|| (size_t)start
>= strlen
) {
4529 /* Out of range start or start > end result in null reply */
4530 addReply(c
,shared
.nullbulk
);
4534 if ((size_t)end
>= strlen
) end
= strlen
-1;
4535 rangelen
= (end
-start
)+1;
4537 /* Return the result */
4538 addReplySds(c
,sdscatprintf(sdsempty(),"$%zu\r\n",rangelen
));
4539 range
= sdsnewlen((char*)o
->ptr
+start
,rangelen
);
4540 addReplySds(c
,range
);
4541 addReply(c
,shared
.crlf
);
4545 /* ========================= Type agnostic commands ========================= */
4547 static void delCommand(redisClient
*c
) {
4550 for (j
= 1; j
< c
->argc
; j
++) {
4551 if (deleteKey(c
->db
,c
->argv
[j
])) {
4552 touchWatchedKey(c
->db
,c
->argv
[j
]);
4557 addReplyLongLong(c
,deleted
);
4560 static void existsCommand(redisClient
*c
) {
4561 expireIfNeeded(c
->db
,c
->argv
[1]);
4562 if (dictFind(c
->db
->dict
,c
->argv
[1])) {
4563 addReply(c
, shared
.cone
);
4565 addReply(c
, shared
.czero
);
4569 static void selectCommand(redisClient
*c
) {
4570 int id
= atoi(c
->argv
[1]->ptr
);
4572 if (selectDb(c
,id
) == REDIS_ERR
) {
4573 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
4575 addReply(c
,shared
.ok
);
4579 static void randomkeyCommand(redisClient
*c
) {
4584 de
= dictGetRandomKey(c
->db
->dict
);
4585 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
4589 addReply(c
,shared
.nullbulk
);
4593 key
= dictGetEntryKey(de
);
4594 if (server
.vm_enabled
) {
4595 key
= dupStringObject(key
);
4596 addReplyBulk(c
,key
);
4599 addReplyBulk(c
,key
);
4603 static void keysCommand(redisClient
*c
) {
4606 sds pattern
= c
->argv
[1]->ptr
;
4607 int plen
= sdslen(pattern
);
4608 unsigned long numkeys
= 0;
4609 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
4611 di
= dictGetIterator(c
->db
->dict
);
4613 decrRefCount(lenobj
);
4614 while((de
= dictNext(di
)) != NULL
) {
4615 robj
*keyobj
= dictGetEntryKey(de
);
4617 sds key
= keyobj
->ptr
;
4618 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
4619 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
4620 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
4621 addReplyBulk(c
,keyobj
);
4626 dictReleaseIterator(di
);
4627 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",numkeys
);
4630 static void dbsizeCommand(redisClient
*c
) {
4632 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
4635 static void lastsaveCommand(redisClient
*c
) {
4637 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
4640 static void typeCommand(redisClient
*c
) {
4644 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4649 case REDIS_STRING
: type
= "+string"; break;
4650 case REDIS_LIST
: type
= "+list"; break;
4651 case REDIS_SET
: type
= "+set"; break;
4652 case REDIS_ZSET
: type
= "+zset"; break;
4653 case REDIS_HASH
: type
= "+hash"; break;
4654 default: type
= "+unknown"; break;
4657 addReplySds(c
,sdsnew(type
));
4658 addReply(c
,shared
.crlf
);
4661 static void saveCommand(redisClient
*c
) {
4662 if (server
.bgsavechildpid
!= -1) {
4663 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
4666 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4667 addReply(c
,shared
.ok
);
4669 addReply(c
,shared
.err
);
4673 static void bgsaveCommand(redisClient
*c
) {
4674 if (server
.bgsavechildpid
!= -1) {
4675 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
4678 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
4679 char *status
= "+Background saving started\r\n";
4680 addReplySds(c
,sdsnew(status
));
4682 addReply(c
,shared
.err
);
4686 static void shutdownCommand(redisClient
*c
) {
4687 if (prepareForShutdown() == REDIS_OK
)
4689 addReplySds(c
, sdsnew("-ERR Errors trying to SHUTDOWN. Check logs.\r\n"));
4692 static void renameGenericCommand(redisClient
*c
, int nx
) {
4695 /* To use the same key as src and dst is probably an error */
4696 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
4697 addReply(c
,shared
.sameobjecterr
);
4701 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
)
4705 deleteIfVolatile(c
->db
,c
->argv
[2]);
4706 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
4709 addReply(c
,shared
.czero
);
4712 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
4714 incrRefCount(c
->argv
[2]);
4716 deleteKey(c
->db
,c
->argv
[1]);
4717 touchWatchedKey(c
->db
,c
->argv
[2]);
4719 addReply(c
,nx
? shared
.cone
: shared
.ok
);
4722 static void renameCommand(redisClient
*c
) {
4723 renameGenericCommand(c
,0);
4726 static void renamenxCommand(redisClient
*c
) {
4727 renameGenericCommand(c
,1);
4730 static void moveCommand(redisClient
*c
) {
4735 /* Obtain source and target DB pointers */
4738 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
4739 addReply(c
,shared
.outofrangeerr
);
4743 selectDb(c
,srcid
); /* Back to the source DB */
4745 /* If the user is moving using as target the same
4746 * DB as the source DB it is probably an error. */
4748 addReply(c
,shared
.sameobjecterr
);
4752 /* Check if the element exists and get a reference */
4753 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4755 addReply(c
,shared
.czero
);
4759 /* Try to add the element to the target DB */
4760 deleteIfVolatile(dst
,c
->argv
[1]);
4761 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
4762 addReply(c
,shared
.czero
);
4765 incrRefCount(c
->argv
[1]);
4768 /* OK! key moved, free the entry in the source DB */
4769 deleteKey(src
,c
->argv
[1]);
4771 addReply(c
,shared
.cone
);
4774 /* =================================== Lists ================================ */
4775 static void lPush(robj
*subject
, robj
*value
, int where
) {
4776 if (subject
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4777 int pos
= (where
== REDIS_HEAD
) ? ZIPLIST_HEAD
: ZIPLIST_TAIL
;
4778 value
= getDecodedObject(value
);
4779 subject
->ptr
= ziplistPush(subject
->ptr
,value
->ptr
,sdslen(value
->ptr
),pos
);
4780 decrRefCount(value
);
4781 } else if (subject
->encoding
== REDIS_ENCODING_LIST
) {
4782 if (where
== REDIS_HEAD
) {
4783 listAddNodeHead(subject
->ptr
,value
);
4785 listAddNodeTail(subject
->ptr
,value
);
4787 incrRefCount(value
);
4789 redisPanic("Unknown list encoding");
4793 static robj
*lPop(robj
*subject
, int where
) {
4795 if (subject
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4800 int pos
= (where
== REDIS_HEAD
) ? 0 : -1;
4801 p
= ziplistIndex(subject
->ptr
,pos
);
4802 if (ziplistGet(p
,&v
,&vlen
,&vval
)) {
4804 value
= createStringObject(v
,vlen
);
4806 value
= createStringObjectFromLongLong(vval
);
4809 subject
->ptr
= ziplistDelete(subject
->ptr
,&p
,ZIPLIST_TAIL
);
4810 } else if (subject
->encoding
== REDIS_ENCODING_LIST
) {
4811 list
*list
= subject
->ptr
;
4813 if (where
== REDIS_HEAD
) {
4814 ln
= listFirst(list
);
4816 ln
= listLast(list
);
4819 value
= listNodeValue(ln
);
4820 incrRefCount(value
);
4821 listDelNode(list
,ln
);
4824 redisPanic("Unknown list encoding");
4829 static unsigned long lLength(robj
*subject
) {
4830 if (subject
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4831 return ziplistLen(subject
->ptr
);
4832 } else if (subject
->encoding
== REDIS_ENCODING_LIST
) {
4833 return listLength((list
*)subject
->ptr
);
4835 redisPanic("Unknown list encoding");
4839 /* Structure to hold set iteration abstraction. */
4842 unsigned char encoding
;
4847 /* Initialize an iterator at the specified index. */
4848 static lIterator
*lInitIterator(robj
*subject
, int index
) {
4849 lIterator
*li
= zmalloc(sizeof(lIterator
));
4850 li
->subject
= subject
;
4851 li
->encoding
= subject
->encoding
;
4852 if (li
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4853 li
->zi
= ziplistIndex(subject
->ptr
,index
);
4854 } else if (li
->encoding
== REDIS_ENCODING_LIST
) {
4855 li
->ln
= listIndex(subject
->ptr
,index
);
4857 redisPanic("Unknown list encoding");
4862 /* Clean up the iterator. */
4863 static void lReleaseIterator(lIterator
*li
) {
4867 /* Whether the entry pointed at is a valid entry. */
4868 static int lIsEntry(lIterator
*li
) {
4869 if (li
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4870 return li
->zi
!= NULL
;
4871 } else if (li
->encoding
== REDIS_ENCODING_LIST
) {
4872 return li
->ln
!= NULL
;
4874 redisPanic("Unknown list encoding");
4878 /* Return entry or NULL at the current position of the iterator. */
4879 static robj
*lGet(lIterator
*li
) {
4881 if (li
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4885 redisAssert(li
->zi
!= NULL
);
4886 if (ziplistGet(li
->zi
,&v
,&vlen
,&vval
)) {
4888 value
= createStringObject(v
,vlen
);
4890 value
= createStringObjectFromLongLong(vval
);
4893 } else if (li
->encoding
== REDIS_ENCODING_LIST
) {
4894 redisAssert(li
->ln
!= NULL
);
4895 value
= listNodeValue(li
->ln
);
4896 incrRefCount(value
);
4898 redisPanic("Unknown list encoding");
4903 /* Delete the element pointed to. */
4904 static void lDelete(lIterator
*li
, int direction
) {
4905 if (li
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4906 direction
= (direction
== REDIS_HEAD
) ? ZIPLIST_HEAD
: ZIPLIST_TAIL
;
4907 li
->subject
->ptr
= ziplistDelete(li
->subject
->ptr
,&li
->zi
,direction
);
4908 } else if (li
->encoding
== REDIS_ENCODING_LIST
) {
4910 if (direction
== REDIS_HEAD
)
4911 next
= li
->ln
->prev
;
4913 next
= li
->ln
->next
;
4914 listDelNode(li
->subject
->ptr
,li
->ln
);
4917 redisPanic("Unknown list encoding");
4921 /* Compare the given object with the entry at the current position. */
4922 static int lEqualTo(lIterator
*li
, robj
*o
) {
4923 if (li
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4924 redisAssert(o
->encoding
== REDIS_ENCODING_RAW
);
4925 return ziplistCompare(li
->zi
,o
->ptr
,sdslen(o
->ptr
));
4926 } else if (li
->encoding
== REDIS_ENCODING_LIST
) {
4927 return equalStringObjects(o
,listNodeValue(li
->ln
));
4929 redisPanic("Unknown list encoding");
4933 /* Move to the next or previous entry in the list. */
4934 static void lMove(lIterator
*li
, int where
) {
4935 if (li
->encoding
== REDIS_ENCODING_ZIPLIST
) {
4936 redisAssert(li
->zi
!= NULL
);
4937 if (where
== REDIS_HEAD
)
4938 li
->zi
= ziplistPrev(li
->zi
);
4940 li
->zi
= ziplistNext(li
->zi
);
4941 } else if (li
->encoding
== REDIS_ENCODING_LIST
) {
4942 redisAssert(li
->ln
!= NULL
);
4943 if (where
== REDIS_HEAD
)
4944 li
->ln
= li
->ln
->prev
;
4946 li
->ln
= li
->ln
->next
;
4948 redisPanic("Unknown list encoding");
4952 static void pushGenericCommand(redisClient
*c
, int where
) {
4953 robj
*lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4955 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4956 addReply(c
,shared
.cone
);
4959 lobj
= createObject(REDIS_LIST
,ziplistNew());
4960 lobj
->encoding
= REDIS_ENCODING_ZIPLIST
;
4961 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
4962 incrRefCount(c
->argv
[1]);
4964 if (lobj
->type
!= REDIS_LIST
) {
4965 addReply(c
,shared
.wrongtypeerr
);
4968 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4969 addReply(c
,shared
.cone
);
4973 lPush(lobj
,c
->argv
[2],where
);
4974 addReplyLongLong(c
,lLength(lobj
));
4978 static void lpushCommand(redisClient
*c
) {
4979 pushGenericCommand(c
,REDIS_HEAD
);
4982 static void rpushCommand(redisClient
*c
) {
4983 pushGenericCommand(c
,REDIS_TAIL
);
4986 static void llenCommand(redisClient
*c
) {
4987 robj
*o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
);
4988 if (o
== NULL
|| checkType(c
,o
,REDIS_LIST
)) return;
4989 addReplyUlong(c
,lLength(o
));
4992 static void lindexCommand(redisClient
*c
) {
4993 robj
*o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
);
4994 if (o
== NULL
|| checkType(c
,o
,REDIS_LIST
)) return;
4995 int index
= atoi(c
->argv
[2]->ptr
);
4997 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
) {
5002 p
= ziplistIndex(o
->ptr
,index
);
5003 if (ziplistGet(p
,&v
,&vlen
,&vval
)) {
5005 addReplySds(c
,sdsnewlen(v
,vlen
));
5007 addReplyLongLong(c
,vval
);
5010 addReply(c
,shared
.nullbulk
);
5012 } else if (o
->encoding
== REDIS_ENCODING_LIST
) {
5013 listNode
*ln
= listIndex(o
->ptr
,index
);
5015 addReply(c
,(robj
*)listNodeValue(ln
));
5017 addReply(c
,shared
.nullbulk
);
5020 redisPanic("Unknown list encoding");
5024 static void lsetCommand(redisClient
*c
) {
5025 robj
*o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
);
5026 if (o
== NULL
|| checkType(c
,o
,REDIS_LIST
)) return;
5027 int index
= atoi(c
->argv
[2]->ptr
);
5028 robj
*value
= c
->argv
[3];
5030 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
) {
5031 unsigned char *p
, *zl
= o
->ptr
;
5032 p
= ziplistIndex(zl
,index
);
5034 addReply(c
,shared
.outofrangeerr
);
5036 o
->ptr
= ziplistDelete(o
->ptr
,&p
,ZIPLIST_TAIL
);
5037 value
= getDecodedObject(value
);
5038 o
->ptr
= ziplistInsert(o
->ptr
,p
,value
->ptr
,sdslen(value
->ptr
));
5039 decrRefCount(value
);
5040 addReply(c
,shared
.ok
);
5043 } else if (o
->encoding
== REDIS_ENCODING_LIST
) {
5044 listNode
*ln
= listIndex(o
->ptr
,index
);
5046 addReply(c
,shared
.outofrangeerr
);
5048 decrRefCount((robj
*)listNodeValue(ln
));
5049 listNodeValue(ln
) = value
;
5050 incrRefCount(value
);
5051 addReply(c
,shared
.ok
);
5055 redisPanic("Unknown list encoding");
5059 static void popGenericCommand(redisClient
*c
, int where
) {
5060 robj
*o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
);
5061 if (o
== NULL
|| checkType(c
,o
,REDIS_LIST
)) return;
5063 robj
*value
= lPop(o
,where
);
5064 if (value
== NULL
) {
5065 addReply(c
,shared
.nullbulk
);
5067 addReplyBulk(c
,value
);
5068 decrRefCount(value
);
5069 if (lLength(o
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5074 static void lpopCommand(redisClient
*c
) {
5075 popGenericCommand(c
,REDIS_HEAD
);
5078 static void rpopCommand(redisClient
*c
) {
5079 popGenericCommand(c
,REDIS_TAIL
);
5082 static void lrangeCommand(redisClient
*c
) {
5084 int start
= atoi(c
->argv
[2]->ptr
);
5085 int end
= atoi(c
->argv
[3]->ptr
);
5089 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
5090 || checkType(c
,o
,REDIS_LIST
)) return;
5093 /* convert negative indexes */
5094 if (start
< 0) start
= llen
+start
;
5095 if (end
< 0) end
= llen
+end
;
5096 if (start
< 0) start
= 0;
5097 if (end
< 0) end
= 0;
5099 /* indexes sanity checks */
5100 if (start
> end
|| start
>= llen
) {
5101 /* Out of range start or start > end result in empty list */
5102 addReply(c
,shared
.emptymultibulk
);
5105 if (end
>= llen
) end
= llen
-1;
5106 rangelen
= (end
-start
)+1;
5108 /* Return the result in form of a multi-bulk reply */
5109 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
5110 lIterator
*li
= lInitIterator(o
,start
);
5111 for (j
= 0; j
< rangelen
; j
++) {
5113 redisAssert(value
!= NULL
);
5114 addReplyBulk(c
,value
);
5115 lMove(li
,REDIS_TAIL
);
5117 lReleaseIterator(li
);
5120 static void ltrimCommand(redisClient
*c
) {
5122 int start
= atoi(c
->argv
[2]->ptr
);
5123 int end
= atoi(c
->argv
[3]->ptr
);
5125 int j
, ltrim
, rtrim
;
5129 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.ok
)) == NULL
||
5130 checkType(c
,o
,REDIS_LIST
)) return;
5133 /* convert negative indexes */
5134 if (start
< 0) start
= llen
+start
;
5135 if (end
< 0) end
= llen
+end
;
5136 if (start
< 0) start
= 0;
5137 if (end
< 0) end
= 0;
5139 /* indexes sanity checks */
5140 if (start
> end
|| start
>= llen
) {
5141 /* Out of range start or start > end result in empty list */
5145 if (end
>= llen
) end
= llen
-1;
5150 /* Remove list elements to perform the trim */
5151 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
) {
5152 o
->ptr
= ziplistDeleteRange(o
->ptr
,0,ltrim
);
5153 o
->ptr
= ziplistDeleteRange(o
->ptr
,-rtrim
,rtrim
);
5154 } else if (o
->encoding
== REDIS_ENCODING_LIST
) {
5156 for (j
= 0; j
< ltrim
; j
++) {
5157 ln
= listFirst(list
);
5158 listDelNode(list
,ln
);
5160 for (j
= 0; j
< rtrim
; j
++) {
5161 ln
= listLast(list
);
5162 listDelNode(list
,ln
);
5165 redisPanic("Unknown list encoding");
5167 if (lLength(o
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5169 addReply(c
,shared
.ok
);
5172 static void lremCommand(redisClient
*c
) {
5173 robj
*subject
, *obj
= c
->argv
[3];
5174 int toremove
= atoi(c
->argv
[2]->ptr
);
5178 subject
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
);
5179 if (subject
== NULL
|| checkType(c
,subject
,REDIS_LIST
)) return;
5181 /* Make sure obj is raw when we're dealing with a ziplist */
5182 if (subject
->encoding
== REDIS_ENCODING_ZIPLIST
)
5183 obj
= getDecodedObject(obj
);
5187 toremove
= -toremove
;
5188 direction
= REDIS_HEAD
;
5189 li
= lInitIterator(subject
,-1);
5191 direction
= REDIS_TAIL
;
5192 li
= lInitIterator(subject
,0);
5195 while (toremove
&& lIsEntry(li
)) {
5196 if (lEqualTo(li
,obj
)) {
5197 lDelete(li
,direction
);
5202 lMove(li
,direction
);
5205 lReleaseIterator(li
);
5207 /* Clean up raw encoded object */
5208 if (subject
->encoding
== REDIS_ENCODING_ZIPLIST
)
5211 if (lLength(subject
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5212 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
5215 /* This is the semantic of this command:
5216 * RPOPLPUSH srclist dstlist:
5217 * IF LLEN(srclist) > 0
5218 * element = RPOP srclist
5219 * LPUSH dstlist element
5226 * The idea is to be able to get an element from a list in a reliable way
5227 * since the element is not just returned but pushed against another list
5228 * as well. This command was originally proposed by Ezra Zygmuntowicz.
5230 static void rpoplpushcommand(redisClient
*c
) {
5235 if ((sobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5236 checkType(c
,sobj
,REDIS_LIST
)) return;
5237 srclist
= sobj
->ptr
;
5238 ln
= listLast(srclist
);
5241 addReply(c
,shared
.nullbulk
);
5243 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
5244 robj
*ele
= listNodeValue(ln
);
5247 if (dobj
&& dobj
->type
!= REDIS_LIST
) {
5248 addReply(c
,shared
.wrongtypeerr
);
5252 /* Add the element to the target list (unless it's directly
5253 * passed to some BLPOP-ing client */
5254 if (!handleClientsWaitingListPush(c
,c
->argv
[2],ele
)) {
5256 /* Create the list if the key does not exist */
5257 dobj
= createListObject();
5258 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
5259 incrRefCount(c
->argv
[2]);
5261 dstlist
= dobj
->ptr
;
5262 listAddNodeHead(dstlist
,ele
);
5266 /* Send the element to the client as reply as well */
5267 addReplyBulk(c
,ele
);
5269 /* Finally remove the element from the source list */
5270 listDelNode(srclist
,ln
);
5271 if (listLength(srclist
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5276 /* ==================================== Sets ================================ */
5278 static void saddCommand(redisClient
*c
) {
5281 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5283 set
= createSetObject();
5284 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
5285 incrRefCount(c
->argv
[1]);
5287 if (set
->type
!= REDIS_SET
) {
5288 addReply(c
,shared
.wrongtypeerr
);
5292 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
5293 incrRefCount(c
->argv
[2]);
5295 addReply(c
,shared
.cone
);
5297 addReply(c
,shared
.czero
);
5301 static void sremCommand(redisClient
*c
) {
5304 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5305 checkType(c
,set
,REDIS_SET
)) return;
5307 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
5309 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
5310 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5311 addReply(c
,shared
.cone
);
5313 addReply(c
,shared
.czero
);
5317 static void smoveCommand(redisClient
*c
) {
5318 robj
*srcset
, *dstset
;
5320 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5321 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
5323 /* If the source key does not exist return 0, if it's of the wrong type
5325 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
5326 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
5329 /* Error if the destination key is not a set as well */
5330 if (dstset
&& dstset
->type
!= REDIS_SET
) {
5331 addReply(c
,shared
.wrongtypeerr
);
5334 /* Remove the element from the source set */
5335 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
5336 /* Key not found in the src set! return zero */
5337 addReply(c
,shared
.czero
);
5340 if (dictSize((dict
*)srcset
->ptr
) == 0 && srcset
!= dstset
)
5341 deleteKey(c
->db
,c
->argv
[1]);
5343 /* Add the element to the destination set */
5345 dstset
= createSetObject();
5346 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
5347 incrRefCount(c
->argv
[2]);
5349 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
5350 incrRefCount(c
->argv
[3]);
5351 addReply(c
,shared
.cone
);
5354 static void sismemberCommand(redisClient
*c
) {
5357 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5358 checkType(c
,set
,REDIS_SET
)) return;
5360 if (dictFind(set
->ptr
,c
->argv
[2]))
5361 addReply(c
,shared
.cone
);
5363 addReply(c
,shared
.czero
);
5366 static void scardCommand(redisClient
*c
) {
5370 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5371 checkType(c
,o
,REDIS_SET
)) return;
5374 addReplyUlong(c
,dictSize(s
));
5377 static void spopCommand(redisClient
*c
) {
5381 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5382 checkType(c
,set
,REDIS_SET
)) return;
5384 de
= dictGetRandomKey(set
->ptr
);
5386 addReply(c
,shared
.nullbulk
);
5388 robj
*ele
= dictGetEntryKey(de
);
5390 addReplyBulk(c
,ele
);
5391 dictDelete(set
->ptr
,ele
);
5392 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
5393 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5398 static void srandmemberCommand(redisClient
*c
) {
5402 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5403 checkType(c
,set
,REDIS_SET
)) return;
5405 de
= dictGetRandomKey(set
->ptr
);
5407 addReply(c
,shared
.nullbulk
);
5409 robj
*ele
= dictGetEntryKey(de
);
5411 addReplyBulk(c
,ele
);
5415 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
5416 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
5418 return dictSize(*d1
)-dictSize(*d2
);
5421 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
5422 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
5425 robj
*lenobj
= NULL
, *dstset
= NULL
;
5426 unsigned long j
, cardinality
= 0;
5428 for (j
= 0; j
< setsnum
; j
++) {
5432 lookupKeyWrite(c
->db
,setskeys
[j
]) :
5433 lookupKeyRead(c
->db
,setskeys
[j
]);
5437 if (deleteKey(c
->db
,dstkey
))
5439 addReply(c
,shared
.czero
);
5441 addReply(c
,shared
.emptymultibulk
);
5445 if (setobj
->type
!= REDIS_SET
) {
5447 addReply(c
,shared
.wrongtypeerr
);
5450 dv
[j
] = setobj
->ptr
;
5452 /* Sort sets from the smallest to largest, this will improve our
5453 * algorithm's performace */
5454 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
5456 /* The first thing we should output is the total number of elements...
5457 * since this is a multi-bulk write, but at this stage we don't know
5458 * the intersection set size, so we use a trick, append an empty object
5459 * to the output list and save the pointer to later modify it with the
5462 lenobj
= createObject(REDIS_STRING
,NULL
);
5464 decrRefCount(lenobj
);
5466 /* If we have a target key where to store the resulting set
5467 * create this key with an empty set inside */
5468 dstset
= createSetObject();
5471 /* Iterate all the elements of the first (smallest) set, and test
5472 * the element against all the other sets, if at least one set does
5473 * not include the element it is discarded */
5474 di
= dictGetIterator(dv
[0]);
5476 while((de
= dictNext(di
)) != NULL
) {
5479 for (j
= 1; j
< setsnum
; j
++)
5480 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
5482 continue; /* at least one set does not contain the member */
5483 ele
= dictGetEntryKey(de
);
5485 addReplyBulk(c
,ele
);
5488 dictAdd(dstset
->ptr
,ele
,NULL
);
5492 dictReleaseIterator(di
);
5495 /* Store the resulting set into the target, if the intersection
5496 * is not an empty set. */
5497 deleteKey(c
->db
,dstkey
);
5498 if (dictSize((dict
*)dstset
->ptr
) > 0) {
5499 dictAdd(c
->db
->dict
,dstkey
,dstset
);
5500 incrRefCount(dstkey
);
5501 addReplyLongLong(c
,dictSize((dict
*)dstset
->ptr
));
5503 decrRefCount(dstset
);
5504 addReply(c
,shared
.czero
);
5508 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
5513 static void sinterCommand(redisClient
*c
) {
5514 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
5517 static void sinterstoreCommand(redisClient
*c
) {
5518 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
5521 #define REDIS_OP_UNION 0
5522 #define REDIS_OP_DIFF 1
5523 #define REDIS_OP_INTER 2
5525 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
5526 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
5529 robj
*dstset
= NULL
;
5530 int j
, cardinality
= 0;
5532 for (j
= 0; j
< setsnum
; j
++) {
5536 lookupKeyWrite(c
->db
,setskeys
[j
]) :
5537 lookupKeyRead(c
->db
,setskeys
[j
]);
5542 if (setobj
->type
!= REDIS_SET
) {
5544 addReply(c
,shared
.wrongtypeerr
);
5547 dv
[j
] = setobj
->ptr
;
5550 /* We need a temp set object to store our union. If the dstkey
5551 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
5552 * this set object will be the resulting object to set into the target key*/
5553 dstset
= createSetObject();
5555 /* Iterate all the elements of all the sets, add every element a single
5556 * time to the result set */
5557 for (j
= 0; j
< setsnum
; j
++) {
5558 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
5559 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
5561 di
= dictGetIterator(dv
[j
]);
5563 while((de
= dictNext(di
)) != NULL
) {
5566 /* dictAdd will not add the same element multiple times */
5567 ele
= dictGetEntryKey(de
);
5568 if (op
== REDIS_OP_UNION
|| j
== 0) {
5569 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
5573 } else if (op
== REDIS_OP_DIFF
) {
5574 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
5579 dictReleaseIterator(di
);
5581 /* result set is empty? Exit asap. */
5582 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break;
5585 /* Output the content of the resulting set, if not in STORE mode */
5587 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
5588 di
= dictGetIterator(dstset
->ptr
);
5589 while((de
= dictNext(di
)) != NULL
) {
5592 ele
= dictGetEntryKey(de
);
5593 addReplyBulk(c
,ele
);
5595 dictReleaseIterator(di
);
5596 decrRefCount(dstset
);
5598 /* If we have a target key where to store the resulting set
5599 * create this key with the result set inside */
5600 deleteKey(c
->db
,dstkey
);
5601 if (dictSize((dict
*)dstset
->ptr
) > 0) {
5602 dictAdd(c
->db
->dict
,dstkey
,dstset
);
5603 incrRefCount(dstkey
);
5604 addReplyLongLong(c
,dictSize((dict
*)dstset
->ptr
));
5606 decrRefCount(dstset
);
5607 addReply(c
,shared
.czero
);
5614 static void sunionCommand(redisClient
*c
) {
5615 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
5618 static void sunionstoreCommand(redisClient
*c
) {
5619 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
5622 static void sdiffCommand(redisClient
*c
) {
5623 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
5626 static void sdiffstoreCommand(redisClient
*c
) {
5627 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
5630 /* ==================================== ZSets =============================== */
5632 /* ZSETs are ordered sets using two data structures to hold the same elements
5633 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
5636 * The elements are added to an hash table mapping Redis objects to scores.
5637 * At the same time the elements are added to a skip list mapping scores
5638 * to Redis objects (so objects are sorted by scores in this "view"). */
5640 /* This skiplist implementation is almost a C translation of the original
5641 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
5642 * Alternative to Balanced Trees", modified in three ways:
5643 * a) this implementation allows for repeated values.
5644 * b) the comparison is not just by key (our 'score') but by satellite data.
5645 * c) there is a back pointer, so it's a doubly linked list with the back
5646 * pointers being only at "level 1". This allows to traverse the list
5647 * from tail to head, useful for ZREVRANGE. */
5649 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
5650 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
5652 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
5654 zn
->span
= zmalloc(sizeof(unsigned int) * (level
- 1));
5662 static zskiplist
*zslCreate(void) {
5666 zsl
= zmalloc(sizeof(*zsl
));
5669 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
5670 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++) {
5671 zsl
->header
->forward
[j
] = NULL
;
5673 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
5674 if (j
< ZSKIPLIST_MAXLEVEL
-1)
5675 zsl
->header
->span
[j
] = 0;
5677 zsl
->header
->backward
= NULL
;
5682 static void zslFreeNode(zskiplistNode
*node
) {
5683 decrRefCount(node
->obj
);
5684 zfree(node
->forward
);
5689 static void zslFree(zskiplist
*zsl
) {
5690 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
5692 zfree(zsl
->header
->forward
);
5693 zfree(zsl
->header
->span
);
5696 next
= node
->forward
[0];
5703 static int zslRandomLevel(void) {
5705 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
5707 return (level
<ZSKIPLIST_MAXLEVEL
) ? level
: ZSKIPLIST_MAXLEVEL
;
5710 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
5711 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5712 unsigned int rank
[ZSKIPLIST_MAXLEVEL
];
5716 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5717 /* store rank that is crossed to reach the insert position */
5718 rank
[i
] = i
== (zsl
->level
-1) ? 0 : rank
[i
+1];
5720 while (x
->forward
[i
] &&
5721 (x
->forward
[i
]->score
< score
||
5722 (x
->forward
[i
]->score
== score
&&
5723 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0))) {
5724 rank
[i
] += i
> 0 ? x
->span
[i
-1] : 1;
5729 /* we assume the key is not already inside, since we allow duplicated
5730 * scores, and the re-insertion of score and redis object should never
5731 * happpen since the caller of zslInsert() should test in the hash table
5732 * if the element is already inside or not. */
5733 level
= zslRandomLevel();
5734 if (level
> zsl
->level
) {
5735 for (i
= zsl
->level
; i
< level
; i
++) {
5737 update
[i
] = zsl
->header
;
5738 update
[i
]->span
[i
-1] = zsl
->length
;
5742 x
= zslCreateNode(level
,score
,obj
);
5743 for (i
= 0; i
< level
; i
++) {
5744 x
->forward
[i
] = update
[i
]->forward
[i
];
5745 update
[i
]->forward
[i
] = x
;
5747 /* update span covered by update[i] as x is inserted here */
5749 x
->span
[i
-1] = update
[i
]->span
[i
-1] - (rank
[0] - rank
[i
]);
5750 update
[i
]->span
[i
-1] = (rank
[0] - rank
[i
]) + 1;
5754 /* increment span for untouched levels */
5755 for (i
= level
; i
< zsl
->level
; i
++) {
5756 update
[i
]->span
[i
-1]++;
5759 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
5761 x
->forward
[0]->backward
= x
;
5767 /* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank */
5768 void zslDeleteNode(zskiplist
*zsl
, zskiplistNode
*x
, zskiplistNode
**update
) {
5770 for (i
= 0; i
< zsl
->level
; i
++) {
5771 if (update
[i
]->forward
[i
] == x
) {
5773 update
[i
]->span
[i
-1] += x
->span
[i
-1] - 1;
5775 update
[i
]->forward
[i
] = x
->forward
[i
];
5777 /* invariant: i > 0, because update[0]->forward[0]
5778 * is always equal to x */
5779 update
[i
]->span
[i
-1] -= 1;
5782 if (x
->forward
[0]) {
5783 x
->forward
[0]->backward
= x
->backward
;
5785 zsl
->tail
= x
->backward
;
5787 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
5792 /* Delete an element with matching score/object from the skiplist. */
5793 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
5794 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5798 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5799 while (x
->forward
[i
] &&
5800 (x
->forward
[i
]->score
< score
||
5801 (x
->forward
[i
]->score
== score
&&
5802 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
5806 /* We may have multiple elements with the same score, what we need
5807 * is to find the element with both the right score and object. */
5809 if (x
&& score
== x
->score
&& equalStringObjects(x
->obj
,obj
)) {
5810 zslDeleteNode(zsl
, x
, update
);
5814 return 0; /* not found */
5816 return 0; /* not found */
5819 /* Delete all the elements with score between min and max from the skiplist.
5820 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
5821 * Note that this function takes the reference to the hash table view of the
5822 * sorted set, in order to remove the elements from the hash table too. */
5823 static unsigned long zslDeleteRangeByScore(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
5824 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5825 unsigned long removed
= 0;
5829 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5830 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
5834 /* We may have multiple elements with the same score, what we need
5835 * is to find the element with both the right score and object. */
5837 while (x
&& x
->score
<= max
) {
5838 zskiplistNode
*next
= x
->forward
[0];
5839 zslDeleteNode(zsl
, x
, update
);
5840 dictDelete(dict
,x
->obj
);
5845 return removed
; /* not found */
5848 /* Delete all the elements with rank between start and end from the skiplist.
5849 * Start and end are inclusive. Note that start and end need to be 1-based */
5850 static unsigned long zslDeleteRangeByRank(zskiplist
*zsl
, unsigned int start
, unsigned int end
, dict
*dict
) {
5851 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5852 unsigned long traversed
= 0, removed
= 0;
5856 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5857 while (x
->forward
[i
] && (traversed
+ (i
> 0 ? x
->span
[i
-1] : 1)) < start
) {
5858 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5866 while (x
&& traversed
<= end
) {
5867 zskiplistNode
*next
= x
->forward
[0];
5868 zslDeleteNode(zsl
, x
, update
);
5869 dictDelete(dict
,x
->obj
);
5878 /* Find the first node having a score equal or greater than the specified one.
5879 * Returns NULL if there is no match. */
5880 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
5885 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5886 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
5889 /* We may have multiple elements with the same score, what we need
5890 * is to find the element with both the right score and object. */
5891 return x
->forward
[0];
5894 /* Find the rank for an element by both score and key.
5895 * Returns 0 when the element cannot be found, rank otherwise.
5896 * Note that the rank is 1-based due to the span of zsl->header to the
5898 static unsigned long zslGetRank(zskiplist
*zsl
, double score
, robj
*o
) {
5900 unsigned long rank
= 0;
5904 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5905 while (x
->forward
[i
] &&
5906 (x
->forward
[i
]->score
< score
||
5907 (x
->forward
[i
]->score
== score
&&
5908 compareStringObjects(x
->forward
[i
]->obj
,o
) <= 0))) {
5909 rank
+= i
> 0 ? x
->span
[i
-1] : 1;
5913 /* x might be equal to zsl->header, so test if obj is non-NULL */
5914 if (x
->obj
&& equalStringObjects(x
->obj
,o
)) {
5921 /* Finds an element by its rank. The rank argument needs to be 1-based. */
5922 zskiplistNode
* zslGetElementByRank(zskiplist
*zsl
, unsigned long rank
) {
5924 unsigned long traversed
= 0;
5928 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5929 while (x
->forward
[i
] && (traversed
+ (i
>0 ? x
->span
[i
-1] : 1)) <= rank
)
5931 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5934 if (traversed
== rank
) {
5941 /* The actual Z-commands implementations */
5943 /* This generic command implements both ZADD and ZINCRBY.
5944 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
5945 * the increment if the operation is a ZINCRBY (doincrement == 1). */
5946 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
5951 if (isnan(scoreval
)) {
5952 addReplySds(c
,sdsnew("-ERR provide score is Not A Number (nan)\r\n"));
5956 zsetobj
= lookupKeyWrite(c
->db
,key
);
5957 if (zsetobj
== NULL
) {
5958 zsetobj
= createZsetObject();
5959 dictAdd(c
->db
->dict
,key
,zsetobj
);
5962 if (zsetobj
->type
!= REDIS_ZSET
) {
5963 addReply(c
,shared
.wrongtypeerr
);
5969 /* Ok now since we implement both ZADD and ZINCRBY here the code
5970 * needs to handle the two different conditions. It's all about setting
5971 * '*score', that is, the new score to set, to the right value. */
5972 score
= zmalloc(sizeof(double));
5976 /* Read the old score. If the element was not present starts from 0 */
5977 de
= dictFind(zs
->dict
,ele
);
5979 double *oldscore
= dictGetEntryVal(de
);
5980 *score
= *oldscore
+ scoreval
;
5984 if (isnan(*score
)) {
5986 sdsnew("-ERR resulting score is Not A Number (nan)\r\n"));
5988 /* Note that we don't need to check if the zset may be empty and
5989 * should be removed here, as we can only obtain Nan as score if
5990 * there was already an element in the sorted set. */
5997 /* What follows is a simple remove and re-insert operation that is common
5998 * to both ZADD and ZINCRBY... */
5999 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
6000 /* case 1: New element */
6001 incrRefCount(ele
); /* added to hash */
6002 zslInsert(zs
->zsl
,*score
,ele
);
6003 incrRefCount(ele
); /* added to skiplist */
6006 addReplyDouble(c
,*score
);
6008 addReply(c
,shared
.cone
);
6013 /* case 2: Score update operation */
6014 de
= dictFind(zs
->dict
,ele
);
6015 redisAssert(de
!= NULL
);
6016 oldscore
= dictGetEntryVal(de
);
6017 if (*score
!= *oldscore
) {
6020 /* Remove and insert the element in the skip list with new score */
6021 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
6022 redisAssert(deleted
!= 0);
6023 zslInsert(zs
->zsl
,*score
,ele
);
6025 /* Update the score in the hash table */
6026 dictReplace(zs
->dict
,ele
,score
);
6032 addReplyDouble(c
,*score
);
6034 addReply(c
,shared
.czero
);
6038 static void zaddCommand(redisClient
*c
) {
6041 if (getDoubleFromObjectOrReply(c
, c
->argv
[2], &scoreval
, NULL
) != REDIS_OK
) return;
6042 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
6045 static void zincrbyCommand(redisClient
*c
) {
6048 if (getDoubleFromObjectOrReply(c
, c
->argv
[2], &scoreval
, NULL
) != REDIS_OK
) return;
6049 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
6052 static void zremCommand(redisClient
*c
) {
6059 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6060 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
6063 de
= dictFind(zs
->dict
,c
->argv
[2]);
6065 addReply(c
,shared
.czero
);
6068 /* Delete from the skiplist */
6069 oldscore
= dictGetEntryVal(de
);
6070 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
6071 redisAssert(deleted
!= 0);
6073 /* Delete from the hash table */
6074 dictDelete(zs
->dict
,c
->argv
[2]);
6075 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
6076 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
6078 addReply(c
,shared
.cone
);
6081 static void zremrangebyscoreCommand(redisClient
*c
) {
6088 if ((getDoubleFromObjectOrReply(c
, c
->argv
[2], &min
, NULL
) != REDIS_OK
) ||
6089 (getDoubleFromObjectOrReply(c
, c
->argv
[3], &max
, NULL
) != REDIS_OK
)) return;
6091 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6092 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
6095 deleted
= zslDeleteRangeByScore(zs
->zsl
,min
,max
,zs
->dict
);
6096 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
6097 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
6098 server
.dirty
+= deleted
;
6099 addReplyLongLong(c
,deleted
);
6102 static void zremrangebyrankCommand(redisClient
*c
) {
6110 if ((getLongFromObjectOrReply(c
, c
->argv
[2], &start
, NULL
) != REDIS_OK
) ||
6111 (getLongFromObjectOrReply(c
, c
->argv
[3], &end
, NULL
) != REDIS_OK
)) return;
6113 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6114 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
6116 llen
= zs
->zsl
->length
;
6118 /* convert negative indexes */
6119 if (start
< 0) start
= llen
+start
;
6120 if (end
< 0) end
= llen
+end
;
6121 if (start
< 0) start
= 0;
6122 if (end
< 0) end
= 0;
6124 /* indexes sanity checks */
6125 if (start
> end
|| start
>= llen
) {
6126 addReply(c
,shared
.czero
);
6129 if (end
>= llen
) end
= llen
-1;
6131 /* increment start and end because zsl*Rank functions
6132 * use 1-based rank */
6133 deleted
= zslDeleteRangeByRank(zs
->zsl
,start
+1,end
+1,zs
->dict
);
6134 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
6135 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
6136 server
.dirty
+= deleted
;
6137 addReplyLongLong(c
, deleted
);
6145 static int qsortCompareZsetopsrcByCardinality(const void *s1
, const void *s2
) {
6146 zsetopsrc
*d1
= (void*) s1
, *d2
= (void*) s2
;
6147 unsigned long size1
, size2
;
6148 size1
= d1
->dict
? dictSize(d1
->dict
) : 0;
6149 size2
= d2
->dict
? dictSize(d2
->dict
) : 0;
6150 return size1
- size2
;
6153 #define REDIS_AGGR_SUM 1
6154 #define REDIS_AGGR_MIN 2
6155 #define REDIS_AGGR_MAX 3
6156 #define zunionInterDictValue(_e) (dictGetEntryVal(_e) == NULL ? 1.0 : *(double*)dictGetEntryVal(_e))
6158 inline static void zunionInterAggregate(double *target
, double val
, int aggregate
) {
6159 if (aggregate
== REDIS_AGGR_SUM
) {
6160 *target
= *target
+ val
;
6161 } else if (aggregate
== REDIS_AGGR_MIN
) {
6162 *target
= val
< *target
? val
: *target
;
6163 } else if (aggregate
== REDIS_AGGR_MAX
) {
6164 *target
= val
> *target
? val
: *target
;
6167 redisPanic("Unknown ZUNION/INTER aggregate type");
6171 static void zunionInterGenericCommand(redisClient
*c
, robj
*dstkey
, int op
) {
6173 int aggregate
= REDIS_AGGR_SUM
;
6180 /* expect setnum input keys to be given */
6181 setnum
= atoi(c
->argv
[2]->ptr
);
6183 addReplySds(c
,sdsnew("-ERR at least 1 input key is needed for ZUNIONSTORE/ZINTERSTORE\r\n"));
6187 /* test if the expected number of keys would overflow */
6188 if (3+setnum
> c
->argc
) {
6189 addReply(c
,shared
.syntaxerr
);
6193 /* read keys to be used for input */
6194 src
= zmalloc(sizeof(zsetopsrc
) * setnum
);
6195 for (i
= 0, j
= 3; i
< setnum
; i
++, j
++) {
6196 robj
*obj
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
6200 if (obj
->type
== REDIS_ZSET
) {
6201 src
[i
].dict
= ((zset
*)obj
->ptr
)->dict
;
6202 } else if (obj
->type
== REDIS_SET
) {
6203 src
[i
].dict
= (obj
->ptr
);
6206 addReply(c
,shared
.wrongtypeerr
);
6211 /* default all weights to 1 */
6212 src
[i
].weight
= 1.0;
6215 /* parse optional extra arguments */
6217 int remaining
= c
->argc
- j
;
6220 if (remaining
>= (setnum
+ 1) && !strcasecmp(c
->argv
[j
]->ptr
,"weights")) {
6222 for (i
= 0; i
< setnum
; i
++, j
++, remaining
--) {
6223 if (getDoubleFromObjectOrReply(c
, c
->argv
[j
], &src
[i
].weight
, NULL
) != REDIS_OK
)
6226 } else if (remaining
>= 2 && !strcasecmp(c
->argv
[j
]->ptr
,"aggregate")) {
6228 if (!strcasecmp(c
->argv
[j
]->ptr
,"sum")) {
6229 aggregate
= REDIS_AGGR_SUM
;
6230 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"min")) {
6231 aggregate
= REDIS_AGGR_MIN
;
6232 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"max")) {
6233 aggregate
= REDIS_AGGR_MAX
;
6236 addReply(c
,shared
.syntaxerr
);
6242 addReply(c
,shared
.syntaxerr
);
6248 /* sort sets from the smallest to largest, this will improve our
6249 * algorithm's performance */
6250 qsort(src
,setnum
,sizeof(zsetopsrc
),qsortCompareZsetopsrcByCardinality
);
6252 dstobj
= createZsetObject();
6253 dstzset
= dstobj
->ptr
;
6255 if (op
== REDIS_OP_INTER
) {
6256 /* skip going over all entries if the smallest zset is NULL or empty */
6257 if (src
[0].dict
&& dictSize(src
[0].dict
) > 0) {
6258 /* precondition: as src[0].dict is non-empty and the zsets are ordered
6259 * from small to large, all src[i > 0].dict are non-empty too */
6260 di
= dictGetIterator(src
[0].dict
);
6261 while((de
= dictNext(di
)) != NULL
) {
6262 double *score
= zmalloc(sizeof(double)), value
;
6263 *score
= src
[0].weight
* zunionInterDictValue(de
);
6265 for (j
= 1; j
< setnum
; j
++) {
6266 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
6268 value
= src
[j
].weight
* zunionInterDictValue(other
);
6269 zunionInterAggregate(score
, value
, aggregate
);
6275 /* skip entry when not present in every source dict */
6279 robj
*o
= dictGetEntryKey(de
);
6280 dictAdd(dstzset
->dict
,o
,score
);
6281 incrRefCount(o
); /* added to dictionary */
6282 zslInsert(dstzset
->zsl
,*score
,o
);
6283 incrRefCount(o
); /* added to skiplist */
6286 dictReleaseIterator(di
);
6288 } else if (op
== REDIS_OP_UNION
) {
6289 for (i
= 0; i
< setnum
; i
++) {
6290 if (!src
[i
].dict
) continue;
6292 di
= dictGetIterator(src
[i
].dict
);
6293 while((de
= dictNext(di
)) != NULL
) {
6294 /* skip key when already processed */
6295 if (dictFind(dstzset
->dict
,dictGetEntryKey(de
)) != NULL
) continue;
6297 double *score
= zmalloc(sizeof(double)), value
;
6298 *score
= src
[i
].weight
* zunionInterDictValue(de
);
6300 /* because the zsets are sorted by size, its only possible
6301 * for sets at larger indices to hold this entry */
6302 for (j
= (i
+1); j
< setnum
; j
++) {
6303 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
6305 value
= src
[j
].weight
* zunionInterDictValue(other
);
6306 zunionInterAggregate(score
, value
, aggregate
);
6310 robj
*o
= dictGetEntryKey(de
);
6311 dictAdd(dstzset
->dict
,o
,score
);
6312 incrRefCount(o
); /* added to dictionary */
6313 zslInsert(dstzset
->zsl
,*score
,o
);
6314 incrRefCount(o
); /* added to skiplist */
6316 dictReleaseIterator(di
);
6319 /* unknown operator */
6320 redisAssert(op
== REDIS_OP_INTER
|| op
== REDIS_OP_UNION
);
6323 deleteKey(c
->db
,dstkey
);
6324 if (dstzset
->zsl
->length
) {
6325 dictAdd(c
->db
->dict
,dstkey
,dstobj
);
6326 incrRefCount(dstkey
);
6327 addReplyLongLong(c
, dstzset
->zsl
->length
);
6330 decrRefCount(dstobj
);
6331 addReply(c
, shared
.czero
);
6336 static void zunionstoreCommand(redisClient
*c
) {
6337 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_UNION
);
6340 static void zinterstoreCommand(redisClient
*c
) {
6341 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_INTER
);
6344 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
6356 if ((getLongFromObjectOrReply(c
, c
->argv
[2], &start
, NULL
) != REDIS_OK
) ||
6357 (getLongFromObjectOrReply(c
, c
->argv
[3], &end
, NULL
) != REDIS_OK
)) return;
6359 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
6361 } else if (c
->argc
>= 5) {
6362 addReply(c
,shared
.syntaxerr
);
6366 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
6367 || checkType(c
,o
,REDIS_ZSET
)) return;
6372 /* convert negative indexes */
6373 if (start
< 0) start
= llen
+start
;
6374 if (end
< 0) end
= llen
+end
;
6375 if (start
< 0) start
= 0;
6376 if (end
< 0) end
= 0;
6378 /* indexes sanity checks */
6379 if (start
> end
|| start
>= llen
) {
6380 /* Out of range start or start > end result in empty list */
6381 addReply(c
,shared
.emptymultibulk
);
6384 if (end
>= llen
) end
= llen
-1;
6385 rangelen
= (end
-start
)+1;
6387 /* check if starting point is trivial, before searching
6388 * the element in log(N) time */
6390 ln
= start
== 0 ? zsl
->tail
: zslGetElementByRank(zsl
, llen
-start
);
6393 zsl
->header
->forward
[0] : zslGetElementByRank(zsl
, start
+1);
6396 /* Return the result in form of a multi-bulk reply */
6397 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
6398 withscores
? (rangelen
*2) : rangelen
));
6399 for (j
= 0; j
< rangelen
; j
++) {
6401 addReplyBulk(c
,ele
);
6403 addReplyDouble(c
,ln
->score
);
6404 ln
= reverse
? ln
->backward
: ln
->forward
[0];
6408 static void zrangeCommand(redisClient
*c
) {
6409 zrangeGenericCommand(c
,0);
6412 static void zrevrangeCommand(redisClient
*c
) {
6413 zrangeGenericCommand(c
,1);
6416 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
6417 * If justcount is non-zero, just the count is returned. */
6418 static void genericZrangebyscoreCommand(redisClient
*c
, int justcount
) {
6421 int minex
= 0, maxex
= 0; /* are min or max exclusive? */
6422 int offset
= 0, limit
= -1;
6426 /* Parse the min-max interval. If one of the values is prefixed
6427 * by the "(" character, it's considered "open". For instance
6428 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
6429 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
6430 if (((char*)c
->argv
[2]->ptr
)[0] == '(') {
6431 min
= strtod((char*)c
->argv
[2]->ptr
+1,NULL
);
6434 min
= strtod(c
->argv
[2]->ptr
,NULL
);
6436 if (((char*)c
->argv
[3]->ptr
)[0] == '(') {
6437 max
= strtod((char*)c
->argv
[3]->ptr
+1,NULL
);
6440 max
= strtod(c
->argv
[3]->ptr
,NULL
);
6443 /* Parse "WITHSCORES": note that if the command was called with
6444 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
6445 * enter the following paths to parse WITHSCORES and LIMIT. */
6446 if (c
->argc
== 5 || c
->argc
== 8) {
6447 if (strcasecmp(c
->argv
[c
->argc
-1]->ptr
,"withscores") == 0)
6452 if (c
->argc
!= (4 + withscores
) && c
->argc
!= (7 + withscores
))
6456 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
6461 if (c
->argc
== (7 + withscores
) && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
6462 addReply(c
,shared
.syntaxerr
);
6464 } else if (c
->argc
== (7 + withscores
)) {
6465 offset
= atoi(c
->argv
[5]->ptr
);
6466 limit
= atoi(c
->argv
[6]->ptr
);
6467 if (offset
< 0) offset
= 0;
6470 /* Ok, lookup the key and get the range */
6471 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
6473 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
6475 if (o
->type
!= REDIS_ZSET
) {
6476 addReply(c
,shared
.wrongtypeerr
);
6478 zset
*zsetobj
= o
->ptr
;
6479 zskiplist
*zsl
= zsetobj
->zsl
;
6481 robj
*ele
, *lenobj
= NULL
;
6482 unsigned long rangelen
= 0;
6484 /* Get the first node with the score >= min, or with
6485 * score > min if 'minex' is true. */
6486 ln
= zslFirstWithScore(zsl
,min
);
6487 while (minex
&& ln
&& ln
->score
== min
) ln
= ln
->forward
[0];
6490 /* No element matching the speciifed interval */
6491 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
6495 /* We don't know in advance how many matching elements there
6496 * are in the list, so we push this object that will represent
6497 * the multi-bulk length in the output buffer, and will "fix"
6500 lenobj
= createObject(REDIS_STRING
,NULL
);
6502 decrRefCount(lenobj
);
6505 while(ln
&& (maxex
? (ln
->score
< max
) : (ln
->score
<= max
))) {
6508 ln
= ln
->forward
[0];
6511 if (limit
== 0) break;
6514 addReplyBulk(c
,ele
);
6516 addReplyDouble(c
,ln
->score
);
6518 ln
= ln
->forward
[0];
6520 if (limit
> 0) limit
--;
6523 addReplyLongLong(c
,(long)rangelen
);
6525 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",
6526 withscores
? (rangelen
*2) : rangelen
);
6532 static void zrangebyscoreCommand(redisClient
*c
) {
6533 genericZrangebyscoreCommand(c
,0);
6536 static void zcountCommand(redisClient
*c
) {
6537 genericZrangebyscoreCommand(c
,1);
6540 static void zcardCommand(redisClient
*c
) {
6544 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6545 checkType(c
,o
,REDIS_ZSET
)) return;
6548 addReplyUlong(c
,zs
->zsl
->length
);
6551 static void zscoreCommand(redisClient
*c
) {
6556 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6557 checkType(c
,o
,REDIS_ZSET
)) return;
6560 de
= dictFind(zs
->dict
,c
->argv
[2]);
6562 addReply(c
,shared
.nullbulk
);
6564 double *score
= dictGetEntryVal(de
);
6566 addReplyDouble(c
,*score
);
6570 static void zrankGenericCommand(redisClient
*c
, int reverse
) {
6578 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6579 checkType(c
,o
,REDIS_ZSET
)) return;
6583 de
= dictFind(zs
->dict
,c
->argv
[2]);
6585 addReply(c
,shared
.nullbulk
);
6589 score
= dictGetEntryVal(de
);
6590 rank
= zslGetRank(zsl
, *score
, c
->argv
[2]);
6593 addReplyLongLong(c
, zsl
->length
- rank
);
6595 addReplyLongLong(c
, rank
-1);
6598 addReply(c
,shared
.nullbulk
);
6602 static void zrankCommand(redisClient
*c
) {
6603 zrankGenericCommand(c
, 0);
6606 static void zrevrankCommand(redisClient
*c
) {
6607 zrankGenericCommand(c
, 1);
6610 /* ========================= Hashes utility functions ======================= */
6611 #define REDIS_HASH_KEY 1
6612 #define REDIS_HASH_VALUE 2
6614 /* Check the length of a number of objects to see if we need to convert a
6615 * zipmap to a real hash. Note that we only check string encoded objects
6616 * as their string length can be queried in constant time. */
6617 static void hashTryConversion(robj
*subject
, robj
**argv
, int start
, int end
) {
6619 if (subject
->encoding
!= REDIS_ENCODING_ZIPMAP
) return;
6621 for (i
= start
; i
<= end
; i
++) {
6622 if (argv
[i
]->encoding
== REDIS_ENCODING_RAW
&&
6623 sdslen(argv
[i
]->ptr
) > server
.hash_max_zipmap_value
)
6625 convertToRealHash(subject
);
6631 /* Encode given objects in-place when the hash uses a dict. */
6632 static void hashTryObjectEncoding(robj
*subject
, robj
**o1
, robj
**o2
) {
6633 if (subject
->encoding
== REDIS_ENCODING_HT
) {
6634 if (o1
) *o1
= tryObjectEncoding(*o1
);
6635 if (o2
) *o2
= tryObjectEncoding(*o2
);
6639 /* Get the value from a hash identified by key. Returns either a string
6640 * object or NULL if the value cannot be found. The refcount of the object
6641 * is always increased by 1 when the value was found. */
6642 static robj
*hashGet(robj
*o
, robj
*key
) {
6644 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6647 key
= getDecodedObject(key
);
6648 if (zipmapGet(o
->ptr
,key
->ptr
,sdslen(key
->ptr
),&v
,&vlen
)) {
6649 value
= createStringObject((char*)v
,vlen
);
6653 dictEntry
*de
= dictFind(o
->ptr
,key
);
6655 value
= dictGetEntryVal(de
);
6656 incrRefCount(value
);
6662 /* Test if the key exists in the given hash. Returns 1 if the key
6663 * exists and 0 when it doesn't. */
6664 static int hashExists(robj
*o
, robj
*key
) {
6665 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6666 key
= getDecodedObject(key
);
6667 if (zipmapExists(o
->ptr
,key
->ptr
,sdslen(key
->ptr
))) {
6673 if (dictFind(o
->ptr
,key
) != NULL
) {
6680 /* Add an element, discard the old if the key already exists.
6681 * Return 0 on insert and 1 on update. */
6682 static int hashSet(robj
*o
, robj
*key
, robj
*value
) {
6684 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6685 key
= getDecodedObject(key
);
6686 value
= getDecodedObject(value
);
6687 o
->ptr
= zipmapSet(o
->ptr
,
6688 key
->ptr
,sdslen(key
->ptr
),
6689 value
->ptr
,sdslen(value
->ptr
), &update
);
6691 decrRefCount(value
);
6693 /* Check if the zipmap needs to be upgraded to a real hash table */
6694 if (zipmapLen(o
->ptr
) > server
.hash_max_zipmap_entries
)
6695 convertToRealHash(o
);
6697 if (dictReplace(o
->ptr
,key
,value
)) {
6704 incrRefCount(value
);
6709 /* Delete an element from a hash.
6710 * Return 1 on deleted and 0 on not found. */
6711 static int hashDelete(robj
*o
, robj
*key
) {
6713 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6714 key
= getDecodedObject(key
);
6715 o
->ptr
= zipmapDel(o
->ptr
,key
->ptr
,sdslen(key
->ptr
), &deleted
);
6718 deleted
= dictDelete((dict
*)o
->ptr
,key
) == DICT_OK
;
6719 /* Always check if the dictionary needs a resize after a delete. */
6720 if (deleted
&& htNeedsResize(o
->ptr
)) dictResize(o
->ptr
);
6725 /* Return the number of elements in a hash. */
6726 static unsigned long hashLength(robj
*o
) {
6727 return (o
->encoding
== REDIS_ENCODING_ZIPMAP
) ?
6728 zipmapLen((unsigned char*)o
->ptr
) : dictSize((dict
*)o
->ptr
);
6731 /* Structure to hold hash iteration abstration. Note that iteration over
6732 * hashes involves both fields and values. Because it is possible that
6733 * not both are required, store pointers in the iterator to avoid
6734 * unnecessary memory allocation for fields/values. */
6738 unsigned char *zk
, *zv
;
6739 unsigned int zklen
, zvlen
;
6745 static hashIterator
*hashInitIterator(robj
*subject
) {
6746 hashIterator
*hi
= zmalloc(sizeof(hashIterator
));
6747 hi
->encoding
= subject
->encoding
;
6748 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6749 hi
->zi
= zipmapRewind(subject
->ptr
);
6750 } else if (hi
->encoding
== REDIS_ENCODING_HT
) {
6751 hi
->di
= dictGetIterator(subject
->ptr
);
6758 static void hashReleaseIterator(hashIterator
*hi
) {
6759 if (hi
->encoding
== REDIS_ENCODING_HT
) {
6760 dictReleaseIterator(hi
->di
);
6765 /* Move to the next entry in the hash. Return REDIS_OK when the next entry
6766 * could be found and REDIS_ERR when the iterator reaches the end. */
6767 static int hashNext(hashIterator
*hi
) {
6768 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6769 if ((hi
->zi
= zipmapNext(hi
->zi
, &hi
->zk
, &hi
->zklen
,
6770 &hi
->zv
, &hi
->zvlen
)) == NULL
) return REDIS_ERR
;
6772 if ((hi
->de
= dictNext(hi
->di
)) == NULL
) return REDIS_ERR
;
6777 /* Get key or value object at current iteration position.
6778 * This increases the refcount of the field object by 1. */
6779 static robj
*hashCurrent(hashIterator
*hi
, int what
) {
6781 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6782 if (what
& REDIS_HASH_KEY
) {
6783 o
= createStringObject((char*)hi
->zk
,hi
->zklen
);
6785 o
= createStringObject((char*)hi
->zv
,hi
->zvlen
);
6788 if (what
& REDIS_HASH_KEY
) {
6789 o
= dictGetEntryKey(hi
->de
);
6791 o
= dictGetEntryVal(hi
->de
);
6798 static robj
*hashLookupWriteOrCreate(redisClient
*c
, robj
*key
) {
6799 robj
*o
= lookupKeyWrite(c
->db
,key
);
6801 o
= createHashObject();
6802 dictAdd(c
->db
->dict
,key
,o
);
6805 if (o
->type
!= REDIS_HASH
) {
6806 addReply(c
,shared
.wrongtypeerr
);
6813 /* ============================= Hash commands ============================== */
6814 static void hsetCommand(redisClient
*c
) {
6818 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6819 hashTryConversion(o
,c
->argv
,2,3);
6820 hashTryObjectEncoding(o
,&c
->argv
[2], &c
->argv
[3]);
6821 update
= hashSet(o
,c
->argv
[2],c
->argv
[3]);
6822 addReply(c
, update
? shared
.czero
: shared
.cone
);
6826 static void hsetnxCommand(redisClient
*c
) {
6828 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6829 hashTryConversion(o
,c
->argv
,2,3);
6831 if (hashExists(o
, c
->argv
[2])) {
6832 addReply(c
, shared
.czero
);
6834 hashTryObjectEncoding(o
,&c
->argv
[2], &c
->argv
[3]);
6835 hashSet(o
,c
->argv
[2],c
->argv
[3]);
6836 addReply(c
, shared
.cone
);
6841 static void hmsetCommand(redisClient
*c
) {
6845 if ((c
->argc
% 2) == 1) {
6846 addReplySds(c
,sdsnew("-ERR wrong number of arguments for HMSET\r\n"));
6850 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6851 hashTryConversion(o
,c
->argv
,2,c
->argc
-1);
6852 for (i
= 2; i
< c
->argc
; i
+= 2) {
6853 hashTryObjectEncoding(o
,&c
->argv
[i
], &c
->argv
[i
+1]);
6854 hashSet(o
,c
->argv
[i
],c
->argv
[i
+1]);
6856 addReply(c
, shared
.ok
);
6860 static void hincrbyCommand(redisClient
*c
) {
6861 long long value
, incr
;
6862 robj
*o
, *current
, *new;
6864 if (getLongLongFromObjectOrReply(c
,c
->argv
[3],&incr
,NULL
) != REDIS_OK
) return;
6865 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6866 if ((current
= hashGet(o
,c
->argv
[2])) != NULL
) {
6867 if (getLongLongFromObjectOrReply(c
,current
,&value
,
6868 "hash value is not an integer") != REDIS_OK
) {
6869 decrRefCount(current
);
6872 decrRefCount(current
);
6878 new = createStringObjectFromLongLong(value
);
6879 hashTryObjectEncoding(o
,&c
->argv
[2],NULL
);
6880 hashSet(o
,c
->argv
[2],new);
6882 addReplyLongLong(c
,value
);
6886 static void hgetCommand(redisClient
*c
) {
6888 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6889 checkType(c
,o
,REDIS_HASH
)) return;
6891 if ((value
= hashGet(o
,c
->argv
[2])) != NULL
) {
6892 addReplyBulk(c
,value
);
6893 decrRefCount(value
);
6895 addReply(c
,shared
.nullbulk
);
6899 static void hmgetCommand(redisClient
*c
) {
6902 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
6903 if (o
!= NULL
&& o
->type
!= REDIS_HASH
) {
6904 addReply(c
,shared
.wrongtypeerr
);
6907 /* Note the check for o != NULL happens inside the loop. This is
6908 * done because objects that cannot be found are considered to be
6909 * an empty hash. The reply should then be a series of NULLs. */
6910 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-2));
6911 for (i
= 2; i
< c
->argc
; i
++) {
6912 if (o
!= NULL
&& (value
= hashGet(o
,c
->argv
[i
])) != NULL
) {
6913 addReplyBulk(c
,value
);
6914 decrRefCount(value
);
6916 addReply(c
,shared
.nullbulk
);
6921 static void hdelCommand(redisClient
*c
) {
6923 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6924 checkType(c
,o
,REDIS_HASH
)) return;
6926 if (hashDelete(o
,c
->argv
[2])) {
6927 if (hashLength(o
) == 0) deleteKey(c
->db
,c
->argv
[1]);
6928 addReply(c
,shared
.cone
);
6931 addReply(c
,shared
.czero
);
6935 static void hlenCommand(redisClient
*c
) {
6937 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6938 checkType(c
,o
,REDIS_HASH
)) return;
6940 addReplyUlong(c
,hashLength(o
));
6943 static void genericHgetallCommand(redisClient
*c
, int flags
) {
6944 robj
*o
, *lenobj
, *obj
;
6945 unsigned long count
= 0;
6948 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
6949 || checkType(c
,o
,REDIS_HASH
)) return;
6951 lenobj
= createObject(REDIS_STRING
,NULL
);
6953 decrRefCount(lenobj
);
6955 hi
= hashInitIterator(o
);
6956 while (hashNext(hi
) != REDIS_ERR
) {
6957 if (flags
& REDIS_HASH_KEY
) {
6958 obj
= hashCurrent(hi
,REDIS_HASH_KEY
);
6959 addReplyBulk(c
,obj
);
6963 if (flags
& REDIS_HASH_VALUE
) {
6964 obj
= hashCurrent(hi
,REDIS_HASH_VALUE
);
6965 addReplyBulk(c
,obj
);
6970 hashReleaseIterator(hi
);
6972 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",count
);
6975 static void hkeysCommand(redisClient
*c
) {
6976 genericHgetallCommand(c
,REDIS_HASH_KEY
);
6979 static void hvalsCommand(redisClient
*c
) {
6980 genericHgetallCommand(c
,REDIS_HASH_VALUE
);
6983 static void hgetallCommand(redisClient
*c
) {
6984 genericHgetallCommand(c
,REDIS_HASH_KEY
|REDIS_HASH_VALUE
);
6987 static void hexistsCommand(redisClient
*c
) {
6989 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6990 checkType(c
,o
,REDIS_HASH
)) return;
6992 addReply(c
, hashExists(o
,c
->argv
[2]) ? shared
.cone
: shared
.czero
);
6995 static void convertToRealHash(robj
*o
) {
6996 unsigned char *key
, *val
, *p
, *zm
= o
->ptr
;
6997 unsigned int klen
, vlen
;
6998 dict
*dict
= dictCreate(&hashDictType
,NULL
);
7000 assert(o
->type
== REDIS_HASH
&& o
->encoding
!= REDIS_ENCODING_HT
);
7001 p
= zipmapRewind(zm
);
7002 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
7003 robj
*keyobj
, *valobj
;
7005 keyobj
= createStringObject((char*)key
,klen
);
7006 valobj
= createStringObject((char*)val
,vlen
);
7007 keyobj
= tryObjectEncoding(keyobj
);
7008 valobj
= tryObjectEncoding(valobj
);
7009 dictAdd(dict
,keyobj
,valobj
);
7011 o
->encoding
= REDIS_ENCODING_HT
;
7016 /* ========================= Non type-specific commands ==================== */
7018 static void flushdbCommand(redisClient
*c
) {
7019 server
.dirty
+= dictSize(c
->db
->dict
);
7020 touchWatchedKeysOnFlush(c
->db
->id
);
7021 dictEmpty(c
->db
->dict
);
7022 dictEmpty(c
->db
->expires
);
7023 addReply(c
,shared
.ok
);
7026 static void flushallCommand(redisClient
*c
) {
7027 touchWatchedKeysOnFlush(-1);
7028 server
.dirty
+= emptyDb();
7029 addReply(c
,shared
.ok
);
7030 if (server
.bgsavechildpid
!= -1) {
7031 kill(server
.bgsavechildpid
,SIGKILL
);
7032 rdbRemoveTempFile(server
.bgsavechildpid
);
7034 rdbSave(server
.dbfilename
);
7038 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
7039 redisSortOperation
*so
= zmalloc(sizeof(*so
));
7041 so
->pattern
= pattern
;
7045 /* Return the value associated to the key with a name obtained
7046 * substituting the first occurence of '*' in 'pattern' with 'subst'.
7047 * The returned object will always have its refcount increased by 1
7048 * when it is non-NULL. */
7049 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
7052 robj keyobj
, fieldobj
, *o
;
7053 int prefixlen
, sublen
, postfixlen
, fieldlen
;
7054 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
7058 char buf
[REDIS_SORTKEY_MAX
+1];
7059 } keyname
, fieldname
;
7061 /* If the pattern is "#" return the substitution object itself in order
7062 * to implement the "SORT ... GET #" feature. */
7063 spat
= pattern
->ptr
;
7064 if (spat
[0] == '#' && spat
[1] == '\0') {
7065 incrRefCount(subst
);
7069 /* The substitution object may be specially encoded. If so we create
7070 * a decoded object on the fly. Otherwise getDecodedObject will just
7071 * increment the ref count, that we'll decrement later. */
7072 subst
= getDecodedObject(subst
);
7075 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
7076 p
= strchr(spat
,'*');
7078 decrRefCount(subst
);
7082 /* Find out if we're dealing with a hash dereference. */
7083 if ((f
= strstr(p
+1, "->")) != NULL
) {
7084 fieldlen
= sdslen(spat
)-(f
-spat
);
7085 /* this also copies \0 character */
7086 memcpy(fieldname
.buf
,f
+2,fieldlen
-1);
7087 fieldname
.len
= fieldlen
-2;
7093 sublen
= sdslen(ssub
);
7094 postfixlen
= sdslen(spat
)-(prefixlen
+1)-fieldlen
;
7095 memcpy(keyname
.buf
,spat
,prefixlen
);
7096 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
7097 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
7098 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
7099 keyname
.len
= prefixlen
+sublen
+postfixlen
;
7100 decrRefCount(subst
);
7102 /* Lookup substituted key */
7103 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2));
7104 o
= lookupKeyRead(db
,&keyobj
);
7105 if (o
== NULL
) return NULL
;
7108 if (o
->type
!= REDIS_HASH
|| fieldname
.len
< 1) return NULL
;
7110 /* Retrieve value from hash by the field name. This operation
7111 * already increases the refcount of the returned object. */
7112 initStaticStringObject(fieldobj
,((char*)&fieldname
)+(sizeof(long)*2));
7113 o
= hashGet(o
, &fieldobj
);
7115 if (o
->type
!= REDIS_STRING
) return NULL
;
7117 /* Every object that this function returns needs to have its refcount
7118 * increased. sortCommand decreases it again. */
7125 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
7126 * the additional parameter is not standard but a BSD-specific we have to
7127 * pass sorting parameters via the global 'server' structure */
7128 static int sortCompare(const void *s1
, const void *s2
) {
7129 const redisSortObject
*so1
= s1
, *so2
= s2
;
7132 if (!server
.sort_alpha
) {
7133 /* Numeric sorting. Here it's trivial as we precomputed scores */
7134 if (so1
->u
.score
> so2
->u
.score
) {
7136 } else if (so1
->u
.score
< so2
->u
.score
) {
7142 /* Alphanumeric sorting */
7143 if (server
.sort_bypattern
) {
7144 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
7145 /* At least one compare object is NULL */
7146 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
7148 else if (so1
->u
.cmpobj
== NULL
)
7153 /* We have both the objects, use strcoll */
7154 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
7157 /* Compare elements directly. */
7158 cmp
= compareStringObjects(so1
->obj
,so2
->obj
);
7161 return server
.sort_desc
? -cmp
: cmp
;
7164 /* The SORT command is the most complex command in Redis. Warning: this code
7165 * is optimized for speed and a bit less for readability */
7166 static void sortCommand(redisClient
*c
) {
7169 int desc
= 0, alpha
= 0;
7170 int limit_start
= 0, limit_count
= -1, start
, end
;
7171 int j
, dontsort
= 0, vectorlen
;
7172 int getop
= 0; /* GET operation counter */
7173 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
7174 redisSortObject
*vector
; /* Resulting vector to sort */
7176 /* Lookup the key to sort. It must be of the right types */
7177 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
7178 if (sortval
== NULL
) {
7179 addReply(c
,shared
.emptymultibulk
);
7182 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
7183 sortval
->type
!= REDIS_ZSET
)
7185 addReply(c
,shared
.wrongtypeerr
);
7189 /* Create a list of operations to perform for every sorted element.
7190 * Operations can be GET/DEL/INCR/DECR */
7191 operations
= listCreate();
7192 listSetFreeMethod(operations
,zfree
);
7195 /* Now we need to protect sortval incrementing its count, in the future
7196 * SORT may have options able to overwrite/delete keys during the sorting
7197 * and the sorted key itself may get destroied */
7198 incrRefCount(sortval
);
7200 /* The SORT command has an SQL-alike syntax, parse it */
7201 while(j
< c
->argc
) {
7202 int leftargs
= c
->argc
-j
-1;
7203 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
7205 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
7207 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
7209 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
7210 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
7211 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
7213 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
7214 storekey
= c
->argv
[j
+1];
7216 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
7217 sortby
= c
->argv
[j
+1];
7218 /* If the BY pattern does not contain '*', i.e. it is constant,
7219 * we don't need to sort nor to lookup the weight keys. */
7220 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
7222 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
7223 listAddNodeTail(operations
,createSortOperation(
7224 REDIS_SORT_GET
,c
->argv
[j
+1]));
7228 decrRefCount(sortval
);
7229 listRelease(operations
);
7230 addReply(c
,shared
.syntaxerr
);
7236 /* Load the sorting vector with all the objects to sort */
7237 switch(sortval
->type
) {
7238 case REDIS_LIST
: vectorlen
= listLength((list
*)sortval
->ptr
); break;
7239 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
7240 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
7241 default: vectorlen
= 0; redisPanic("Bad SORT type"); /* Avoid GCC warning */
7243 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
7246 if (sortval
->type
== REDIS_LIST
) {
7247 list
*list
= sortval
->ptr
;
7251 listRewind(list
,&li
);
7252 while((ln
= listNext(&li
))) {
7253 robj
*ele
= ln
->value
;
7254 vector
[j
].obj
= ele
;
7255 vector
[j
].u
.score
= 0;
7256 vector
[j
].u
.cmpobj
= NULL
;
7264 if (sortval
->type
== REDIS_SET
) {
7267 zset
*zs
= sortval
->ptr
;
7271 di
= dictGetIterator(set
);
7272 while((setele
= dictNext(di
)) != NULL
) {
7273 vector
[j
].obj
= dictGetEntryKey(setele
);
7274 vector
[j
].u
.score
= 0;
7275 vector
[j
].u
.cmpobj
= NULL
;
7278 dictReleaseIterator(di
);
7280 redisAssert(j
== vectorlen
);
7282 /* Now it's time to load the right scores in the sorting vector */
7283 if (dontsort
== 0) {
7284 for (j
= 0; j
< vectorlen
; j
++) {
7287 /* lookup value to sort by */
7288 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
7289 if (!byval
) continue;
7291 /* use object itself to sort by */
7292 byval
= vector
[j
].obj
;
7296 if (sortby
) vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
7298 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
7299 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
7300 } else if (byval
->encoding
== REDIS_ENCODING_INT
) {
7301 /* Don't need to decode the object if it's
7302 * integer-encoded (the only encoding supported) so
7303 * far. We can just cast it */
7304 vector
[j
].u
.score
= (long)byval
->ptr
;
7306 redisAssert(1 != 1);
7310 /* when the object was retrieved using lookupKeyByPattern,
7311 * its refcount needs to be decreased. */
7313 decrRefCount(byval
);
7318 /* We are ready to sort the vector... perform a bit of sanity check
7319 * on the LIMIT option too. We'll use a partial version of quicksort. */
7320 start
= (limit_start
< 0) ? 0 : limit_start
;
7321 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
7322 if (start
>= vectorlen
) {
7323 start
= vectorlen
-1;
7326 if (end
>= vectorlen
) end
= vectorlen
-1;
7328 if (dontsort
== 0) {
7329 server
.sort_desc
= desc
;
7330 server
.sort_alpha
= alpha
;
7331 server
.sort_bypattern
= sortby
? 1 : 0;
7332 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
7333 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
7335 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
7338 /* Send command output to the output buffer, performing the specified
7339 * GET/DEL/INCR/DECR operations if any. */
7340 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
7341 if (storekey
== NULL
) {
7342 /* STORE option not specified, sent the sorting result to client */
7343 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
7344 for (j
= start
; j
<= end
; j
++) {
7348 if (!getop
) addReplyBulk(c
,vector
[j
].obj
);
7349 listRewind(operations
,&li
);
7350 while((ln
= listNext(&li
))) {
7351 redisSortOperation
*sop
= ln
->value
;
7352 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
7355 if (sop
->type
== REDIS_SORT_GET
) {
7357 addReply(c
,shared
.nullbulk
);
7359 addReplyBulk(c
,val
);
7363 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
7368 robj
*listObject
= createListObject();
7369 list
*listPtr
= (list
*) listObject
->ptr
;
7371 /* STORE option specified, set the sorting result as a List object */
7372 for (j
= start
; j
<= end
; j
++) {
7377 listAddNodeTail(listPtr
,vector
[j
].obj
);
7378 incrRefCount(vector
[j
].obj
);
7380 listRewind(operations
,&li
);
7381 while((ln
= listNext(&li
))) {
7382 redisSortOperation
*sop
= ln
->value
;
7383 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
7386 if (sop
->type
== REDIS_SORT_GET
) {
7388 listAddNodeTail(listPtr
,createStringObject("",0));
7390 /* We should do a incrRefCount on val because it is
7391 * added to the list, but also a decrRefCount because
7392 * it is returned by lookupKeyByPattern. This results
7393 * in doing nothing at all. */
7394 listAddNodeTail(listPtr
,val
);
7397 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
7401 if (dictReplace(c
->db
->dict
,storekey
,listObject
)) {
7402 incrRefCount(storekey
);
7404 /* Note: we add 1 because the DB is dirty anyway since even if the
7405 * SORT result is empty a new key is set and maybe the old content
7407 server
.dirty
+= 1+outputlen
;
7408 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
7412 decrRefCount(sortval
);
7413 listRelease(operations
);
7414 for (j
= 0; j
< vectorlen
; j
++) {
7415 if (alpha
&& vector
[j
].u
.cmpobj
)
7416 decrRefCount(vector
[j
].u
.cmpobj
);
7421 /* Convert an amount of bytes into a human readable string in the form
7422 * of 100B, 2G, 100M, 4K, and so forth. */
7423 static void bytesToHuman(char *s
, unsigned long long n
) {
7428 sprintf(s
,"%lluB",n
);
7430 } else if (n
< (1024*1024)) {
7431 d
= (double)n
/(1024);
7432 sprintf(s
,"%.2fK",d
);
7433 } else if (n
< (1024LL*1024*1024)) {
7434 d
= (double)n
/(1024*1024);
7435 sprintf(s
,"%.2fM",d
);
7436 } else if (n
< (1024LL*1024*1024*1024)) {
7437 d
= (double)n
/(1024LL*1024*1024);
7438 sprintf(s
,"%.2fG",d
);
7442 /* Create the string returned by the INFO command. This is decoupled
7443 * by the INFO command itself as we need to report the same information
7444 * on memory corruption problems. */
7445 static sds
genRedisInfoString(void) {
7447 time_t uptime
= time(NULL
)-server
.stat_starttime
;
7451 bytesToHuman(hmem
,zmalloc_used_memory());
7452 info
= sdscatprintf(sdsempty(),
7453 "redis_version:%s\r\n"
7454 "redis_git_sha1:%s\r\n"
7455 "redis_git_dirty:%d\r\n"
7457 "multiplexing_api:%s\r\n"
7458 "process_id:%ld\r\n"
7459 "uptime_in_seconds:%ld\r\n"
7460 "uptime_in_days:%ld\r\n"
7461 "connected_clients:%d\r\n"
7462 "connected_slaves:%d\r\n"
7463 "blocked_clients:%d\r\n"
7464 "used_memory:%zu\r\n"
7465 "used_memory_human:%s\r\n"
7466 "changes_since_last_save:%lld\r\n"
7467 "bgsave_in_progress:%d\r\n"
7468 "last_save_time:%ld\r\n"
7469 "bgrewriteaof_in_progress:%d\r\n"
7470 "total_connections_received:%lld\r\n"
7471 "total_commands_processed:%lld\r\n"
7472 "expired_keys:%lld\r\n"
7473 "hash_max_zipmap_entries:%zu\r\n"
7474 "hash_max_zipmap_value:%zu\r\n"
7475 "pubsub_channels:%ld\r\n"
7476 "pubsub_patterns:%u\r\n"
7481 strtol(REDIS_GIT_DIRTY
,NULL
,10) > 0,
7482 (sizeof(long) == 8) ? "64" : "32",
7487 listLength(server
.clients
)-listLength(server
.slaves
),
7488 listLength(server
.slaves
),
7489 server
.blpop_blocked_clients
,
7490 zmalloc_used_memory(),
7493 server
.bgsavechildpid
!= -1,
7495 server
.bgrewritechildpid
!= -1,
7496 server
.stat_numconnections
,
7497 server
.stat_numcommands
,
7498 server
.stat_expiredkeys
,
7499 server
.hash_max_zipmap_entries
,
7500 server
.hash_max_zipmap_value
,
7501 dictSize(server
.pubsub_channels
),
7502 listLength(server
.pubsub_patterns
),
7503 server
.vm_enabled
!= 0,
7504 server
.masterhost
== NULL
? "master" : "slave"
7506 if (server
.masterhost
) {
7507 info
= sdscatprintf(info
,
7508 "master_host:%s\r\n"
7509 "master_port:%d\r\n"
7510 "master_link_status:%s\r\n"
7511 "master_last_io_seconds_ago:%d\r\n"
7514 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
7516 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
7519 if (server
.vm_enabled
) {
7521 info
= sdscatprintf(info
,
7522 "vm_conf_max_memory:%llu\r\n"
7523 "vm_conf_page_size:%llu\r\n"
7524 "vm_conf_pages:%llu\r\n"
7525 "vm_stats_used_pages:%llu\r\n"
7526 "vm_stats_swapped_objects:%llu\r\n"
7527 "vm_stats_swappin_count:%llu\r\n"
7528 "vm_stats_swappout_count:%llu\r\n"
7529 "vm_stats_io_newjobs_len:%lu\r\n"
7530 "vm_stats_io_processing_len:%lu\r\n"
7531 "vm_stats_io_processed_len:%lu\r\n"
7532 "vm_stats_io_active_threads:%lu\r\n"
7533 "vm_stats_blocked_clients:%lu\r\n"
7534 ,(unsigned long long) server
.vm_max_memory
,
7535 (unsigned long long) server
.vm_page_size
,
7536 (unsigned long long) server
.vm_pages
,
7537 (unsigned long long) server
.vm_stats_used_pages
,
7538 (unsigned long long) server
.vm_stats_swapped_objects
,
7539 (unsigned long long) server
.vm_stats_swapins
,
7540 (unsigned long long) server
.vm_stats_swapouts
,
7541 (unsigned long) listLength(server
.io_newjobs
),
7542 (unsigned long) listLength(server
.io_processing
),
7543 (unsigned long) listLength(server
.io_processed
),
7544 (unsigned long) server
.io_active_threads
,
7545 (unsigned long) server
.vm_blocked_clients
7549 for (j
= 0; j
< server
.dbnum
; j
++) {
7550 long long keys
, vkeys
;
7552 keys
= dictSize(server
.db
[j
].dict
);
7553 vkeys
= dictSize(server
.db
[j
].expires
);
7554 if (keys
|| vkeys
) {
7555 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
7562 static void infoCommand(redisClient
*c
) {
7563 sds info
= genRedisInfoString();
7564 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
7565 (unsigned long)sdslen(info
)));
7566 addReplySds(c
,info
);
7567 addReply(c
,shared
.crlf
);
7570 static void monitorCommand(redisClient
*c
) {
7571 /* ignore MONITOR if aleady slave or in monitor mode */
7572 if (c
->flags
& REDIS_SLAVE
) return;
7574 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
7576 listAddNodeTail(server
.monitors
,c
);
7577 addReply(c
,shared
.ok
);
7580 /* ================================= Expire ================================= */
7581 static int removeExpire(redisDb
*db
, robj
*key
) {
7582 if (dictDelete(db
->expires
,key
) == DICT_OK
) {
7589 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
7590 if (dictAdd(db
->expires
,key
,(void*)when
) == DICT_ERR
) {
7598 /* Return the expire time of the specified key, or -1 if no expire
7599 * is associated with this key (i.e. the key is non volatile) */
7600 static time_t getExpire(redisDb
*db
, robj
*key
) {
7603 /* No expire? return ASAP */
7604 if (dictSize(db
->expires
) == 0 ||
7605 (de
= dictFind(db
->expires
,key
)) == NULL
) return -1;
7607 return (time_t) dictGetEntryVal(de
);
7610 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
7614 /* No expire? return ASAP */
7615 if (dictSize(db
->expires
) == 0 ||
7616 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
7618 /* Lookup the expire */
7619 when
= (time_t) dictGetEntryVal(de
);
7620 if (time(NULL
) <= when
) return 0;
7622 /* Delete the key */
7623 dictDelete(db
->expires
,key
);
7624 server
.stat_expiredkeys
++;
7625 return dictDelete(db
->dict
,key
) == DICT_OK
;
7628 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
7631 /* No expire? return ASAP */
7632 if (dictSize(db
->expires
) == 0 ||
7633 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
7635 /* Delete the key */
7637 server
.stat_expiredkeys
++;
7638 dictDelete(db
->expires
,key
);
7639 return dictDelete(db
->dict
,key
) == DICT_OK
;
7642 static void expireGenericCommand(redisClient
*c
, robj
*key
, robj
*param
, long offset
) {
7646 if (getLongFromObjectOrReply(c
, param
, &seconds
, NULL
) != REDIS_OK
) return;
7650 de
= dictFind(c
->db
->dict
,key
);
7652 addReply(c
,shared
.czero
);
7656 if (deleteKey(c
->db
,key
)) server
.dirty
++;
7657 addReply(c
, shared
.cone
);
7660 time_t when
= time(NULL
)+seconds
;
7661 if (setExpire(c
->db
,key
,when
)) {
7662 addReply(c
,shared
.cone
);
7665 addReply(c
,shared
.czero
);
7671 static void expireCommand(redisClient
*c
) {
7672 expireGenericCommand(c
,c
->argv
[1],c
->argv
[2],0);
7675 static void expireatCommand(redisClient
*c
) {
7676 expireGenericCommand(c
,c
->argv
[1],c
->argv
[2],time(NULL
));
7679 static void ttlCommand(redisClient
*c
) {
7683 expire
= getExpire(c
->db
,c
->argv
[1]);
7685 ttl
= (int) (expire
-time(NULL
));
7686 if (ttl
< 0) ttl
= -1;
7688 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
7691 /* ================================ MULTI/EXEC ============================== */
7693 /* Client state initialization for MULTI/EXEC */
7694 static void initClientMultiState(redisClient
*c
) {
7695 c
->mstate
.commands
= NULL
;
7696 c
->mstate
.count
= 0;
7699 /* Release all the resources associated with MULTI/EXEC state */
7700 static void freeClientMultiState(redisClient
*c
) {
7703 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7705 multiCmd
*mc
= c
->mstate
.commands
+j
;
7707 for (i
= 0; i
< mc
->argc
; i
++)
7708 decrRefCount(mc
->argv
[i
]);
7711 zfree(c
->mstate
.commands
);
7714 /* Add a new command into the MULTI commands queue */
7715 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
7719 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
7720 sizeof(multiCmd
)*(c
->mstate
.count
+1));
7721 mc
= c
->mstate
.commands
+c
->mstate
.count
;
7724 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
7725 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
7726 for (j
= 0; j
< c
->argc
; j
++)
7727 incrRefCount(mc
->argv
[j
]);
7731 static void multiCommand(redisClient
*c
) {
7732 if (c
->flags
& REDIS_MULTI
) {
7733 addReplySds(c
,sdsnew("-ERR MULTI calls can not be nested\r\n"));
7736 c
->flags
|= REDIS_MULTI
;
7737 addReply(c
,shared
.ok
);
7740 static void discardCommand(redisClient
*c
) {
7741 if (!(c
->flags
& REDIS_MULTI
)) {
7742 addReplySds(c
,sdsnew("-ERR DISCARD without MULTI\r\n"));
7746 freeClientMultiState(c
);
7747 initClientMultiState(c
);
7748 c
->flags
&= (~REDIS_MULTI
);
7749 addReply(c
,shared
.ok
);
7752 /* Send a MULTI command to all the slaves and AOF file. Check the execCommand
7753 * implememntation for more information. */
7754 static void execCommandReplicateMulti(redisClient
*c
) {
7755 struct redisCommand
*cmd
;
7756 robj
*multistring
= createStringObject("MULTI",5);
7758 cmd
= lookupCommand("multi");
7759 if (server
.appendonly
)
7760 feedAppendOnlyFile(cmd
,c
->db
->id
,&multistring
,1);
7761 if (listLength(server
.slaves
))
7762 replicationFeedSlaves(server
.slaves
,c
->db
->id
,&multistring
,1);
7763 decrRefCount(multistring
);
7766 static void execCommand(redisClient
*c
) {
7771 if (!(c
->flags
& REDIS_MULTI
)) {
7772 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
7776 /* Check if we need to abort the EXEC if some WATCHed key was touched.
7777 * A failed EXEC will return a multi bulk nil object. */
7778 if (c
->flags
& REDIS_DIRTY_CAS
) {
7779 freeClientMultiState(c
);
7780 initClientMultiState(c
);
7781 c
->flags
&= ~(REDIS_MULTI
|REDIS_DIRTY_CAS
);
7783 addReply(c
,shared
.nullmultibulk
);
7787 /* Replicate a MULTI request now that we are sure the block is executed.
7788 * This way we'll deliver the MULTI/..../EXEC block as a whole and
7789 * both the AOF and the replication link will have the same consistency
7790 * and atomicity guarantees. */
7791 execCommandReplicateMulti(c
);
7793 /* Exec all the queued commands */
7794 unwatchAllKeys(c
); /* Unwatch ASAP otherwise we'll waste CPU cycles */
7795 orig_argv
= c
->argv
;
7796 orig_argc
= c
->argc
;
7797 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
7798 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7799 c
->argc
= c
->mstate
.commands
[j
].argc
;
7800 c
->argv
= c
->mstate
.commands
[j
].argv
;
7801 call(c
,c
->mstate
.commands
[j
].cmd
);
7803 c
->argv
= orig_argv
;
7804 c
->argc
= orig_argc
;
7805 freeClientMultiState(c
);
7806 initClientMultiState(c
);
7807 c
->flags
&= ~(REDIS_MULTI
|REDIS_DIRTY_CAS
);
7808 /* Make sure the EXEC command is always replicated / AOF, since we
7809 * always send the MULTI command (we can't know beforehand if the
7810 * next operations will contain at least a modification to the DB). */
7814 /* =========================== Blocking Operations ========================= */
7816 /* Currently Redis blocking operations support is limited to list POP ops,
7817 * so the current implementation is not fully generic, but it is also not
7818 * completely specific so it will not require a rewrite to support new
7819 * kind of blocking operations in the future.
7821 * Still it's important to note that list blocking operations can be already
7822 * used as a notification mechanism in order to implement other blocking
7823 * operations at application level, so there must be a very strong evidence
7824 * of usefulness and generality before new blocking operations are implemented.
7826 * This is how the current blocking POP works, we use BLPOP as example:
7827 * - If the user calls BLPOP and the key exists and contains a non empty list
7828 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
7829 * if there is not to block.
7830 * - If instead BLPOP is called and the key does not exists or the list is
7831 * empty we need to block. In order to do so we remove the notification for
7832 * new data to read in the client socket (so that we'll not serve new
7833 * requests if the blocking request is not served). Also we put the client
7834 * in a dictionary (db->blocking_keys) mapping keys to a list of clients
7835 * blocking for this keys.
7836 * - If a PUSH operation against a key with blocked clients waiting is
7837 * performed, we serve the first in the list: basically instead to push
7838 * the new element inside the list we return it to the (first / oldest)
7839 * blocking client, unblock the client, and remove it form the list.
7841 * The above comment and the source code should be enough in order to understand
7842 * the implementation and modify / fix it later.
7845 /* Set a client in blocking mode for the specified key, with the specified
7847 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
7852 c
->blocking_keys
= zmalloc(sizeof(robj
*)*numkeys
);
7853 c
->blocking_keys_num
= numkeys
;
7854 c
->blockingto
= timeout
;
7855 for (j
= 0; j
< numkeys
; j
++) {
7856 /* Add the key in the client structure, to map clients -> keys */
7857 c
->blocking_keys
[j
] = keys
[j
];
7858 incrRefCount(keys
[j
]);
7860 /* And in the other "side", to map keys -> clients */
7861 de
= dictFind(c
->db
->blocking_keys
,keys
[j
]);
7865 /* For every key we take a list of clients blocked for it */
7867 retval
= dictAdd(c
->db
->blocking_keys
,keys
[j
],l
);
7868 incrRefCount(keys
[j
]);
7869 assert(retval
== DICT_OK
);
7871 l
= dictGetEntryVal(de
);
7873 listAddNodeTail(l
,c
);
7875 /* Mark the client as a blocked client */
7876 c
->flags
|= REDIS_BLOCKED
;
7877 server
.blpop_blocked_clients
++;
7880 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
7881 static void unblockClientWaitingData(redisClient
*c
) {
7886 assert(c
->blocking_keys
!= NULL
);
7887 /* The client may wait for multiple keys, so unblock it for every key. */
7888 for (j
= 0; j
< c
->blocking_keys_num
; j
++) {
7889 /* Remove this client from the list of clients waiting for this key. */
7890 de
= dictFind(c
->db
->blocking_keys
,c
->blocking_keys
[j
]);
7892 l
= dictGetEntryVal(de
);
7893 listDelNode(l
,listSearchKey(l
,c
));
7894 /* If the list is empty we need to remove it to avoid wasting memory */
7895 if (listLength(l
) == 0)
7896 dictDelete(c
->db
->blocking_keys
,c
->blocking_keys
[j
]);
7897 decrRefCount(c
->blocking_keys
[j
]);
7899 /* Cleanup the client structure */
7900 zfree(c
->blocking_keys
);
7901 c
->blocking_keys
= NULL
;
7902 c
->flags
&= (~REDIS_BLOCKED
);
7903 server
.blpop_blocked_clients
--;
7904 /* We want to process data if there is some command waiting
7905 * in the input buffer. Note that this is safe even if
7906 * unblockClientWaitingData() gets called from freeClient() because
7907 * freeClient() will be smart enough to call this function
7908 * *after* c->querybuf was set to NULL. */
7909 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
7912 /* This should be called from any function PUSHing into lists.
7913 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
7914 * 'ele' is the element pushed.
7916 * If the function returns 0 there was no client waiting for a list push
7919 * If the function returns 1 there was a client waiting for a list push
7920 * against this key, the element was passed to this client thus it's not
7921 * needed to actually add it to the list and the caller should return asap. */
7922 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
7923 struct dictEntry
*de
;
7924 redisClient
*receiver
;
7928 de
= dictFind(c
->db
->blocking_keys
,key
);
7929 if (de
== NULL
) return 0;
7930 l
= dictGetEntryVal(de
);
7933 receiver
= ln
->value
;
7935 addReplySds(receiver
,sdsnew("*2\r\n"));
7936 addReplyBulk(receiver
,key
);
7937 addReplyBulk(receiver
,ele
);
7938 unblockClientWaitingData(receiver
);
7942 /* Blocking RPOP/LPOP */
7943 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
7948 for (j
= 1; j
< c
->argc
-1; j
++) {
7949 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
7951 if (o
->type
!= REDIS_LIST
) {
7952 addReply(c
,shared
.wrongtypeerr
);
7955 list
*list
= o
->ptr
;
7956 if (listLength(list
) != 0) {
7957 /* If the list contains elements fall back to the usual
7958 * non-blocking POP operation */
7959 robj
*argv
[2], **orig_argv
;
7962 /* We need to alter the command arguments before to call
7963 * popGenericCommand() as the command takes a single key. */
7964 orig_argv
= c
->argv
;
7965 orig_argc
= c
->argc
;
7966 argv
[1] = c
->argv
[j
];
7970 /* Also the return value is different, we need to output
7971 * the multi bulk reply header and the key name. The
7972 * "real" command will add the last element (the value)
7973 * for us. If this souds like an hack to you it's just
7974 * because it is... */
7975 addReplySds(c
,sdsnew("*2\r\n"));
7976 addReplyBulk(c
,argv
[1]);
7977 popGenericCommand(c
,where
);
7979 /* Fix the client structure with the original stuff */
7980 c
->argv
= orig_argv
;
7981 c
->argc
= orig_argc
;
7987 /* If the list is empty or the key does not exists we must block */
7988 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
7989 if (timeout
> 0) timeout
+= time(NULL
);
7990 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
7993 static void blpopCommand(redisClient
*c
) {
7994 blockingPopGenericCommand(c
,REDIS_HEAD
);
7997 static void brpopCommand(redisClient
*c
) {
7998 blockingPopGenericCommand(c
,REDIS_TAIL
);
8001 /* =============================== Replication ============================= */
8003 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
8004 ssize_t nwritten
, ret
= size
;
8005 time_t start
= time(NULL
);
8009 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
8010 nwritten
= write(fd
,ptr
,size
);
8011 if (nwritten
== -1) return -1;
8015 if ((time(NULL
)-start
) > timeout
) {
8023 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
8024 ssize_t nread
, totread
= 0;
8025 time_t start
= time(NULL
);
8029 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
8030 nread
= read(fd
,ptr
,size
);
8031 if (nread
== -1) return -1;
8036 if ((time(NULL
)-start
) > timeout
) {
8044 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
8051 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
8054 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
8065 static void syncCommand(redisClient
*c
) {
8066 /* ignore SYNC if aleady slave or in monitor mode */
8067 if (c
->flags
& REDIS_SLAVE
) return;
8069 /* SYNC can't be issued when the server has pending data to send to
8070 * the client about already issued commands. We need a fresh reply
8071 * buffer registering the differences between the BGSAVE and the current
8072 * dataset, so that we can copy to other slaves if needed. */
8073 if (listLength(c
->reply
) != 0) {
8074 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
8078 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
8079 /* Here we need to check if there is a background saving operation
8080 * in progress, or if it is required to start one */
8081 if (server
.bgsavechildpid
!= -1) {
8082 /* Ok a background save is in progress. Let's check if it is a good
8083 * one for replication, i.e. if there is another slave that is
8084 * registering differences since the server forked to save */
8089 listRewind(server
.slaves
,&li
);
8090 while((ln
= listNext(&li
))) {
8092 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
8095 /* Perfect, the server is already registering differences for
8096 * another slave. Set the right state, and copy the buffer. */
8097 listRelease(c
->reply
);
8098 c
->reply
= listDup(slave
->reply
);
8099 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
8100 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
8102 /* No way, we need to wait for the next BGSAVE in order to
8103 * register differences */
8104 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
8105 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
8108 /* Ok we don't have a BGSAVE in progress, let's start one */
8109 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
8110 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
8111 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
8112 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
8115 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
8118 c
->flags
|= REDIS_SLAVE
;
8120 listAddNodeTail(server
.slaves
,c
);
8124 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
8125 redisClient
*slave
= privdata
;
8127 REDIS_NOTUSED(mask
);
8128 char buf
[REDIS_IOBUF_LEN
];
8129 ssize_t nwritten
, buflen
;
8131 if (slave
->repldboff
== 0) {
8132 /* Write the bulk write count before to transfer the DB. In theory here
8133 * we don't know how much room there is in the output buffer of the
8134 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
8135 * operations) will never be smaller than the few bytes we need. */
8138 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
8140 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
8148 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
8149 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
8151 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
8152 (buflen
== 0) ? "premature EOF" : strerror(errno
));
8156 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
8157 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
8162 slave
->repldboff
+= nwritten
;
8163 if (slave
->repldboff
== slave
->repldbsize
) {
8164 close(slave
->repldbfd
);
8165 slave
->repldbfd
= -1;
8166 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
8167 slave
->replstate
= REDIS_REPL_ONLINE
;
8168 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
8169 sendReplyToClient
, slave
) == AE_ERR
) {
8173 addReplySds(slave
,sdsempty());
8174 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
8178 /* This function is called at the end of every backgrond saving.
8179 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
8180 * otherwise REDIS_ERR is passed to the function.
8182 * The goal of this function is to handle slaves waiting for a successful
8183 * background saving in order to perform non-blocking synchronization. */
8184 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
8186 int startbgsave
= 0;
8189 listRewind(server
.slaves
,&li
);
8190 while((ln
= listNext(&li
))) {
8191 redisClient
*slave
= ln
->value
;
8193 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
8195 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
8196 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
8197 struct redis_stat buf
;
8199 if (bgsaveerr
!= REDIS_OK
) {
8201 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
8204 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
8205 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
8207 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
8210 slave
->repldboff
= 0;
8211 slave
->repldbsize
= buf
.st_size
;
8212 slave
->replstate
= REDIS_REPL_SEND_BULK
;
8213 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
8214 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
8221 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
8224 listRewind(server
.slaves
,&li
);
8225 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
8226 while((ln
= listNext(&li
))) {
8227 redisClient
*slave
= ln
->value
;
8229 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
8236 static int syncWithMaster(void) {
8237 char buf
[1024], tmpfile
[256], authcmd
[1024];
8239 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
8240 int dfd
, maxtries
= 5;
8243 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
8248 /* AUTH with the master if required. */
8249 if(server
.masterauth
) {
8250 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
8251 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
8253 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
8257 /* Read the AUTH result. */
8258 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
8260 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
8264 if (buf
[0] != '+') {
8266 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
8271 /* Issue the SYNC command */
8272 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
8274 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
8278 /* Read the bulk write count */
8279 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
8281 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
8285 if (buf
[0] != '$') {
8287 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
8290 dumpsize
= strtol(buf
+1,NULL
,10);
8291 redisLog(REDIS_NOTICE
,"Receiving %ld bytes data dump from MASTER",dumpsize
);
8292 /* Read the bulk write data on a temp file */
8294 snprintf(tmpfile
,256,
8295 "temp-%d.%ld.rdb",(int)time(NULL
),(long int)getpid());
8296 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
|O_EXCL
,0644);
8297 if (dfd
!= -1) break;
8302 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
8306 int nread
, nwritten
;
8308 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
8310 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
8316 nwritten
= write(dfd
,buf
,nread
);
8317 if (nwritten
== -1) {
8318 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
8326 if (rename(tmpfile
,server
.dbfilename
) == -1) {
8327 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
8333 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
8334 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
8338 server
.master
= createClient(fd
);
8339 server
.master
->flags
|= REDIS_MASTER
;
8340 server
.master
->authenticated
= 1;
8341 server
.replstate
= REDIS_REPL_CONNECTED
;
8345 static void slaveofCommand(redisClient
*c
) {
8346 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
8347 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
8348 if (server
.masterhost
) {
8349 sdsfree(server
.masterhost
);
8350 server
.masterhost
= NULL
;
8351 if (server
.master
) freeClient(server
.master
);
8352 server
.replstate
= REDIS_REPL_NONE
;
8353 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
8356 sdsfree(server
.masterhost
);
8357 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
8358 server
.masterport
= atoi(c
->argv
[2]->ptr
);
8359 if (server
.master
) freeClient(server
.master
);
8360 server
.replstate
= REDIS_REPL_CONNECT
;
8361 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
8362 server
.masterhost
, server
.masterport
);
8364 addReply(c
,shared
.ok
);
8367 /* ============================ Maxmemory directive ======================== */
8369 /* Try to free one object form the pre-allocated objects free list.
8370 * This is useful under low mem conditions as by default we take 1 million
8371 * free objects allocated. On success REDIS_OK is returned, otherwise
8373 static int tryFreeOneObjectFromFreelist(void) {
8376 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
8377 if (listLength(server
.objfreelist
)) {
8378 listNode
*head
= listFirst(server
.objfreelist
);
8379 o
= listNodeValue(head
);
8380 listDelNode(server
.objfreelist
,head
);
8381 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
8385 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
8390 /* This function gets called when 'maxmemory' is set on the config file to limit
8391 * the max memory used by the server, and we are out of memory.
8392 * This function will try to, in order:
8394 * - Free objects from the free list
8395 * - Try to remove keys with an EXPIRE set
8397 * It is not possible to free enough memory to reach used-memory < maxmemory
8398 * the server will start refusing commands that will enlarge even more the
8401 static void freeMemoryIfNeeded(void) {
8402 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
8403 int j
, k
, freed
= 0;
8405 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
8406 for (j
= 0; j
< server
.dbnum
; j
++) {
8408 robj
*minkey
= NULL
;
8409 struct dictEntry
*de
;
8411 if (dictSize(server
.db
[j
].expires
)) {
8413 /* From a sample of three keys drop the one nearest to
8414 * the natural expire */
8415 for (k
= 0; k
< 3; k
++) {
8418 de
= dictGetRandomKey(server
.db
[j
].expires
);
8419 t
= (time_t) dictGetEntryVal(de
);
8420 if (minttl
== -1 || t
< minttl
) {
8421 minkey
= dictGetEntryKey(de
);
8425 deleteKey(server
.db
+j
,minkey
);
8428 if (!freed
) return; /* nothing to free... */
8432 /* ============================== Append Only file ========================== */
8434 /* Write the append only file buffer on disk.
8436 * Since we are required to write the AOF before replying to the client,
8437 * and the only way the client socket can get a write is entering when the
8438 * the event loop, we accumulate all the AOF writes in a memory
8439 * buffer and write it on disk using this function just before entering
8440 * the event loop again. */
8441 static void flushAppendOnlyFile(void) {
8445 if (sdslen(server
.aofbuf
) == 0) return;
8447 /* We want to perform a single write. This should be guaranteed atomic
8448 * at least if the filesystem we are writing is a real physical one.
8449 * While this will save us against the server being killed I don't think
8450 * there is much to do about the whole server stopping for power problems
8452 nwritten
= write(server
.appendfd
,server
.aofbuf
,sdslen(server
.aofbuf
));
8453 if (nwritten
!= (signed)sdslen(server
.aofbuf
)) {
8454 /* Ooops, we are in troubles. The best thing to do for now is
8455 * aborting instead of giving the illusion that everything is
8456 * working as expected. */
8457 if (nwritten
== -1) {
8458 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
8460 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
8464 sdsfree(server
.aofbuf
);
8465 server
.aofbuf
= sdsempty();
8467 /* Fsync if needed */
8469 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
8470 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
8471 now
-server
.lastfsync
> 1))
8473 /* aof_fsync is defined as fdatasync() for Linux in order to avoid
8474 * flushing metadata. */
8475 aof_fsync(server
.appendfd
); /* Let's try to get this data on the disk */
8476 server
.lastfsync
= now
;
8480 static sds
catAppendOnlyGenericCommand(sds buf
, int argc
, robj
**argv
) {
8482 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
8483 for (j
= 0; j
< argc
; j
++) {
8484 robj
*o
= getDecodedObject(argv
[j
]);
8485 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
8486 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
8487 buf
= sdscatlen(buf
,"\r\n",2);
8493 static sds
catAppendOnlyExpireAtCommand(sds buf
, robj
*key
, robj
*seconds
) {
8498 /* Make sure we can use strtol */
8499 seconds
= getDecodedObject(seconds
);
8500 when
= time(NULL
)+strtol(seconds
->ptr
,NULL
,10);
8501 decrRefCount(seconds
);
8503 argv
[0] = createStringObject("EXPIREAT",8);
8505 argv
[2] = createObject(REDIS_STRING
,
8506 sdscatprintf(sdsempty(),"%ld",when
));
8507 buf
= catAppendOnlyGenericCommand(buf
, argc
, argv
);
8508 decrRefCount(argv
[0]);
8509 decrRefCount(argv
[2]);
8513 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
8514 sds buf
= sdsempty();
8517 /* The DB this command was targetting is not the same as the last command
8518 * we appendend. To issue a SELECT command is needed. */
8519 if (dictid
!= server
.appendseldb
) {
8522 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
8523 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
8524 (unsigned long)strlen(seldb
),seldb
);
8525 server
.appendseldb
= dictid
;
8528 if (cmd
->proc
== expireCommand
) {
8529 /* Translate EXPIRE into EXPIREAT */
8530 buf
= catAppendOnlyExpireAtCommand(buf
,argv
[1],argv
[2]);
8531 } else if (cmd
->proc
== setexCommand
) {
8532 /* Translate SETEX to SET and EXPIREAT */
8533 tmpargv
[0] = createStringObject("SET",3);
8534 tmpargv
[1] = argv
[1];
8535 tmpargv
[2] = argv
[3];
8536 buf
= catAppendOnlyGenericCommand(buf
,3,tmpargv
);
8537 decrRefCount(tmpargv
[0]);
8538 buf
= catAppendOnlyExpireAtCommand(buf
,argv
[1],argv
[2]);
8540 buf
= catAppendOnlyGenericCommand(buf
,argc
,argv
);
8543 /* Append to the AOF buffer. This will be flushed on disk just before
8544 * of re-entering the event loop, so before the client will get a
8545 * positive reply about the operation performed. */
8546 server
.aofbuf
= sdscatlen(server
.aofbuf
,buf
,sdslen(buf
));
8548 /* If a background append only file rewriting is in progress we want to
8549 * accumulate the differences between the child DB and the current one
8550 * in a buffer, so that when the child process will do its work we
8551 * can append the differences to the new append only file. */
8552 if (server
.bgrewritechildpid
!= -1)
8553 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
8558 /* In Redis commands are always executed in the context of a client, so in
8559 * order to load the append only file we need to create a fake client. */
8560 static struct redisClient
*createFakeClient(void) {
8561 struct redisClient
*c
= zmalloc(sizeof(*c
));
8565 c
->querybuf
= sdsempty();
8569 /* We set the fake client as a slave waiting for the synchronization
8570 * so that Redis will not try to send replies to this client. */
8571 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
8572 c
->reply
= listCreate();
8573 listSetFreeMethod(c
->reply
,decrRefCount
);
8574 listSetDupMethod(c
->reply
,dupClientReplyValue
);
8575 initClientMultiState(c
);
8579 static void freeFakeClient(struct redisClient
*c
) {
8580 sdsfree(c
->querybuf
);
8581 listRelease(c
->reply
);
8582 freeClientMultiState(c
);
8586 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
8587 * error (the append only file is zero-length) REDIS_ERR is returned. On
8588 * fatal error an error message is logged and the program exists. */
8589 int loadAppendOnlyFile(char *filename
) {
8590 struct redisClient
*fakeClient
;
8591 FILE *fp
= fopen(filename
,"r");
8592 struct redis_stat sb
;
8593 unsigned long long loadedkeys
= 0;
8594 int appendonly
= server
.appendonly
;
8596 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
8600 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
8604 /* Temporarily disable AOF, to prevent EXEC from feeding a MULTI
8605 * to the same file we're about to read. */
8606 server
.appendonly
= 0;
8608 fakeClient
= createFakeClient();
8615 struct redisCommand
*cmd
;
8617 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
8623 if (buf
[0] != '*') goto fmterr
;
8625 argv
= zmalloc(sizeof(robj
*)*argc
);
8626 for (j
= 0; j
< argc
; j
++) {
8627 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
8628 if (buf
[0] != '$') goto fmterr
;
8629 len
= strtol(buf
+1,NULL
,10);
8630 argsds
= sdsnewlen(NULL
,len
);
8631 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
8632 argv
[j
] = createObject(REDIS_STRING
,argsds
);
8633 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
8636 /* Command lookup */
8637 cmd
= lookupCommand(argv
[0]->ptr
);
8639 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
8642 /* Try object encoding */
8643 if (cmd
->flags
& REDIS_CMD_BULK
)
8644 argv
[argc
-1] = tryObjectEncoding(argv
[argc
-1]);
8645 /* Run the command in the context of a fake client */
8646 fakeClient
->argc
= argc
;
8647 fakeClient
->argv
= argv
;
8648 cmd
->proc(fakeClient
);
8649 /* Discard the reply objects list from the fake client */
8650 while(listLength(fakeClient
->reply
))
8651 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
8652 /* Clean up, ready for the next command */
8653 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
8655 /* Handle swapping while loading big datasets when VM is on */
8657 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
8658 while (zmalloc_used_memory() > server
.vm_max_memory
) {
8659 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
8664 /* This point can only be reached when EOF is reached without errors.
8665 * If the client is in the middle of a MULTI/EXEC, log error and quit. */
8666 if (fakeClient
->flags
& REDIS_MULTI
) goto readerr
;
8669 freeFakeClient(fakeClient
);
8670 server
.appendonly
= appendonly
;
8675 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
8677 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
8681 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
8685 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
8686 static int fwriteBulkObject(FILE *fp
, robj
*obj
) {
8690 /* Avoid the incr/decr ref count business if possible to help
8691 * copy-on-write (we are often in a child process when this function
8693 * Also makes sure that key objects don't get incrRefCount-ed when VM
8695 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
8696 obj
= getDecodedObject(obj
);
8699 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
8700 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
8701 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
8703 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
8704 if (decrrc
) decrRefCount(obj
);
8707 if (decrrc
) decrRefCount(obj
);
8711 /* Write binary-safe string into a file in the bulkformat
8712 * $<count>\r\n<payload>\r\n */
8713 static int fwriteBulkString(FILE *fp
, char *s
, unsigned long len
) {
8716 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(unsigned long)len
);
8717 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8718 if (len
&& fwrite(s
,len
,1,fp
) == 0) return 0;
8719 if (fwrite("\r\n",2,1,fp
) == 0) return 0;
8723 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
8724 static int fwriteBulkDouble(FILE *fp
, double d
) {
8725 char buf
[128], dbuf
[128];
8727 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
8728 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
8729 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8730 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
8734 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
8735 static int fwriteBulkLong(FILE *fp
, long l
) {
8736 char buf
[128], lbuf
[128];
8738 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
8739 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
8740 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8741 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
8745 /* Write a sequence of commands able to fully rebuild the dataset into
8746 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
8747 static int rewriteAppendOnlyFile(char *filename
) {
8748 dictIterator
*di
= NULL
;
8753 time_t now
= time(NULL
);
8755 /* Note that we have to use a different temp name here compared to the
8756 * one used by rewriteAppendOnlyFileBackground() function. */
8757 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
8758 fp
= fopen(tmpfile
,"w");
8760 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
8763 for (j
= 0; j
< server
.dbnum
; j
++) {
8764 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
8765 redisDb
*db
= server
.db
+j
;
8767 if (dictSize(d
) == 0) continue;
8768 di
= dictGetIterator(d
);
8774 /* SELECT the new DB */
8775 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
8776 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
8778 /* Iterate this DB writing every entry */
8779 while((de
= dictNext(di
)) != NULL
) {
8784 key
= dictGetEntryKey(de
);
8785 /* If the value for this key is swapped, load a preview in memory.
8786 * We use a "swapped" flag to remember if we need to free the
8787 * value object instead to just increment the ref count anyway
8788 * in order to avoid copy-on-write of pages if we are forked() */
8789 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
8790 key
->storage
== REDIS_VM_SWAPPING
) {
8791 o
= dictGetEntryVal(de
);
8794 o
= vmPreviewObject(key
);
8797 expiretime
= getExpire(db
,key
);
8799 /* Save the key and associated value */
8800 if (o
->type
== REDIS_STRING
) {
8801 /* Emit a SET command */
8802 char cmd
[]="*3\r\n$3\r\nSET\r\n";
8803 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8805 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8806 if (fwriteBulkObject(fp
,o
) == 0) goto werr
;
8807 } else if (o
->type
== REDIS_LIST
) {
8808 /* Emit the RPUSHes needed to rebuild the list */
8809 list
*list
= o
->ptr
;
8813 listRewind(list
,&li
);
8814 while((ln
= listNext(&li
))) {
8815 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
8816 robj
*eleobj
= listNodeValue(ln
);
8818 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8819 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8820 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8822 } else if (o
->type
== REDIS_SET
) {
8823 /* Emit the SADDs needed to rebuild the set */
8825 dictIterator
*di
= dictGetIterator(set
);
8828 while((de
= dictNext(di
)) != NULL
) {
8829 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
8830 robj
*eleobj
= dictGetEntryKey(de
);
8832 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8833 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8834 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8836 dictReleaseIterator(di
);
8837 } else if (o
->type
== REDIS_ZSET
) {
8838 /* Emit the ZADDs needed to rebuild the sorted set */
8840 dictIterator
*di
= dictGetIterator(zs
->dict
);
8843 while((de
= dictNext(di
)) != NULL
) {
8844 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
8845 robj
*eleobj
= dictGetEntryKey(de
);
8846 double *score
= dictGetEntryVal(de
);
8848 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8849 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8850 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
8851 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8853 dictReleaseIterator(di
);
8854 } else if (o
->type
== REDIS_HASH
) {
8855 char cmd
[]="*4\r\n$4\r\nHSET\r\n";
8857 /* Emit the HSETs needed to rebuild the hash */
8858 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
8859 unsigned char *p
= zipmapRewind(o
->ptr
);
8860 unsigned char *field
, *val
;
8861 unsigned int flen
, vlen
;
8863 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
8864 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8865 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8866 if (fwriteBulkString(fp
,(char*)field
,flen
) == -1)
8868 if (fwriteBulkString(fp
,(char*)val
,vlen
) == -1)
8872 dictIterator
*di
= dictGetIterator(o
->ptr
);
8875 while((de
= dictNext(di
)) != NULL
) {
8876 robj
*field
= dictGetEntryKey(de
);
8877 robj
*val
= dictGetEntryVal(de
);
8879 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8880 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8881 if (fwriteBulkObject(fp
,field
) == -1) return -1;
8882 if (fwriteBulkObject(fp
,val
) == -1) return -1;
8884 dictReleaseIterator(di
);
8887 redisPanic("Unknown object type");
8889 /* Save the expire time */
8890 if (expiretime
!= -1) {
8891 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
8892 /* If this key is already expired skip it */
8893 if (expiretime
< now
) continue;
8894 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8895 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8896 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
8898 if (swapped
) decrRefCount(o
);
8900 dictReleaseIterator(di
);
8903 /* Make sure data will not remain on the OS's output buffers */
8908 /* Use RENAME to make sure the DB file is changed atomically only
8909 * if the generate DB file is ok. */
8910 if (rename(tmpfile
,filename
) == -1) {
8911 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
8915 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
8921 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
8922 if (di
) dictReleaseIterator(di
);
8926 /* This is how rewriting of the append only file in background works:
8928 * 1) The user calls BGREWRITEAOF
8929 * 2) Redis calls this function, that forks():
8930 * 2a) the child rewrite the append only file in a temp file.
8931 * 2b) the parent accumulates differences in server.bgrewritebuf.
8932 * 3) When the child finished '2a' exists.
8933 * 4) The parent will trap the exit code, if it's OK, will append the
8934 * data accumulated into server.bgrewritebuf into the temp file, and
8935 * finally will rename(2) the temp file in the actual file name.
8936 * The the new file is reopened as the new append only file. Profit!
8938 static int rewriteAppendOnlyFileBackground(void) {
8941 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
8942 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
8943 if ((childpid
= fork()) == 0) {
8947 if (server
.vm_enabled
) vmReopenSwapFile();
8949 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
8950 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
8957 if (childpid
== -1) {
8958 redisLog(REDIS_WARNING
,
8959 "Can't rewrite append only file in background: fork: %s",
8963 redisLog(REDIS_NOTICE
,
8964 "Background append only file rewriting started by pid %d",childpid
);
8965 server
.bgrewritechildpid
= childpid
;
8966 updateDictResizePolicy();
8967 /* We set appendseldb to -1 in order to force the next call to the
8968 * feedAppendOnlyFile() to issue a SELECT command, so the differences
8969 * accumulated by the parent into server.bgrewritebuf will start
8970 * with a SELECT statement and it will be safe to merge. */
8971 server
.appendseldb
= -1;
8974 return REDIS_OK
; /* unreached */
8977 static void bgrewriteaofCommand(redisClient
*c
) {
8978 if (server
.bgrewritechildpid
!= -1) {
8979 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
8982 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
8983 char *status
= "+Background append only file rewriting started\r\n";
8984 addReplySds(c
,sdsnew(status
));
8986 addReply(c
,shared
.err
);
8990 static void aofRemoveTempFile(pid_t childpid
) {
8993 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
8997 /* Virtual Memory is composed mainly of two subsystems:
8998 * - Blocking Virutal Memory
8999 * - Threaded Virtual Memory I/O
9000 * The two parts are not fully decoupled, but functions are split among two
9001 * different sections of the source code (delimited by comments) in order to
9002 * make more clear what functionality is about the blocking VM and what about
9003 * the threaded (not blocking) VM.
9007 * Redis VM is a blocking VM (one that blocks reading swapped values from
9008 * disk into memory when a value swapped out is needed in memory) that is made
9009 * unblocking by trying to examine the command argument vector in order to
9010 * load in background values that will likely be needed in order to exec
9011 * the command. The command is executed only once all the relevant keys
9012 * are loaded into memory.
9014 * This basically is almost as simple of a blocking VM, but almost as parallel
9015 * as a fully non-blocking VM.
9018 /* Called when the user switches from "appendonly yes" to "appendonly no"
9019 * at runtime using the CONFIG command. */
9020 static void stopAppendOnly(void) {
9021 flushAppendOnlyFile();
9022 fsync(server
.appendfd
);
9023 close(server
.appendfd
);
9025 server
.appendfd
= -1;
9026 server
.appendseldb
= -1;
9027 server
.appendonly
= 0;
9028 /* rewrite operation in progress? kill it, wait child exit */
9029 if (server
.bgsavechildpid
!= -1) {
9032 if (kill(server
.bgsavechildpid
,SIGKILL
) != -1)
9033 wait3(&statloc
,0,NULL
);
9034 /* reset the buffer accumulating changes while the child saves */
9035 sdsfree(server
.bgrewritebuf
);
9036 server
.bgrewritebuf
= sdsempty();
9037 server
.bgsavechildpid
= -1;
9041 /* Called when the user switches from "appendonly no" to "appendonly yes"
9042 * at runtime using the CONFIG command. */
9043 static int startAppendOnly(void) {
9044 server
.appendonly
= 1;
9045 server
.lastfsync
= time(NULL
);
9046 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
9047 if (server
.appendfd
== -1) {
9048 redisLog(REDIS_WARNING
,"Used tried to switch on AOF via CONFIG, but I can't open the AOF file: %s",strerror(errno
));
9051 if (rewriteAppendOnlyFileBackground() == REDIS_ERR
) {
9052 server
.appendonly
= 0;
9053 close(server
.appendfd
);
9054 redisLog(REDIS_WARNING
,"Used tried to switch on AOF via CONFIG, I can't trigger a background AOF rewrite operation. Check the above logs for more info about the error.",strerror(errno
));
9060 /* =================== Virtual Memory - Blocking Side ====================== */
9062 static void vmInit(void) {
9068 if (server
.vm_max_threads
!= 0)
9069 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
9071 redisLog(REDIS_NOTICE
,"Using '%s' as swap file",server
.vm_swap_file
);
9072 /* Try to open the old swap file, otherwise create it */
9073 if ((server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b")) == NULL
) {
9074 server
.vm_fp
= fopen(server
.vm_swap_file
,"w+b");
9076 if (server
.vm_fp
== NULL
) {
9077 redisLog(REDIS_WARNING
,
9078 "Can't open the swap file: %s. Exiting.",
9082 server
.vm_fd
= fileno(server
.vm_fp
);
9083 /* Lock the swap file for writing, this is useful in order to avoid
9084 * another instance to use the same swap file for a config error. */
9085 fl
.l_type
= F_WRLCK
;
9086 fl
.l_whence
= SEEK_SET
;
9087 fl
.l_start
= fl
.l_len
= 0;
9088 if (fcntl(server
.vm_fd
,F_SETLK
,&fl
) == -1) {
9089 redisLog(REDIS_WARNING
,
9090 "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
));
9094 server
.vm_next_page
= 0;
9095 server
.vm_near_pages
= 0;
9096 server
.vm_stats_used_pages
= 0;
9097 server
.vm_stats_swapped_objects
= 0;
9098 server
.vm_stats_swapouts
= 0;
9099 server
.vm_stats_swapins
= 0;
9100 totsize
= server
.vm_pages
*server
.vm_page_size
;
9101 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
9102 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
9103 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
9107 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
9109 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
9110 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
9111 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
9112 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
9114 /* Initialize threaded I/O (used by Virtual Memory) */
9115 server
.io_newjobs
= listCreate();
9116 server
.io_processing
= listCreate();
9117 server
.io_processed
= listCreate();
9118 server
.io_ready_clients
= listCreate();
9119 pthread_mutex_init(&server
.io_mutex
,NULL
);
9120 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
9121 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
9122 server
.io_active_threads
= 0;
9123 if (pipe(pipefds
) == -1) {
9124 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
9128 server
.io_ready_pipe_read
= pipefds
[0];
9129 server
.io_ready_pipe_write
= pipefds
[1];
9130 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
9131 /* LZF requires a lot of stack */
9132 pthread_attr_init(&server
.io_threads_attr
);
9133 pthread_attr_getstacksize(&server
.io_threads_attr
, &stacksize
);
9134 while (stacksize
< REDIS_THREAD_STACK_SIZE
) stacksize
*= 2;
9135 pthread_attr_setstacksize(&server
.io_threads_attr
, stacksize
);
9136 /* Listen for events in the threaded I/O pipe */
9137 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
9138 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
9139 oom("creating file event");
9142 /* Mark the page as used */
9143 static void vmMarkPageUsed(off_t page
) {
9144 off_t byte
= page
/8;
9146 redisAssert(vmFreePage(page
) == 1);
9147 server
.vm_bitmap
[byte
] |= 1<<bit
;
9150 /* Mark N contiguous pages as used, with 'page' being the first. */
9151 static void vmMarkPagesUsed(off_t page
, off_t count
) {
9154 for (j
= 0; j
< count
; j
++)
9155 vmMarkPageUsed(page
+j
);
9156 server
.vm_stats_used_pages
+= count
;
9157 redisLog(REDIS_DEBUG
,"Mark USED pages: %lld pages at %lld\n",
9158 (long long)count
, (long long)page
);
9161 /* Mark the page as free */
9162 static void vmMarkPageFree(off_t page
) {
9163 off_t byte
= page
/8;
9165 redisAssert(vmFreePage(page
) == 0);
9166 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
9169 /* Mark N contiguous pages as free, with 'page' being the first. */
9170 static void vmMarkPagesFree(off_t page
, off_t count
) {
9173 for (j
= 0; j
< count
; j
++)
9174 vmMarkPageFree(page
+j
);
9175 server
.vm_stats_used_pages
-= count
;
9176 redisLog(REDIS_DEBUG
,"Mark FREE pages: %lld pages at %lld\n",
9177 (long long)count
, (long long)page
);
9180 /* Test if the page is free */
9181 static int vmFreePage(off_t page
) {
9182 off_t byte
= page
/8;
9184 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
9187 /* Find N contiguous free pages storing the first page of the cluster in *first.
9188 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
9189 * REDIS_ERR is returned.
9191 * This function uses a simple algorithm: we try to allocate
9192 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
9193 * again from the start of the swap file searching for free spaces.
9195 * If it looks pretty clear that there are no free pages near our offset
9196 * we try to find less populated places doing a forward jump of
9197 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
9198 * without hurry, and then we jump again and so forth...
9200 * This function can be improved using a free list to avoid to guess
9201 * too much, since we could collect data about freed pages.
9203 * note: I implemented this function just after watching an episode of
9204 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
9206 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
9207 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
9209 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
9210 server
.vm_near_pages
= 0;
9211 server
.vm_next_page
= 0;
9213 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
9214 base
= server
.vm_next_page
;
9216 while(offset
< server
.vm_pages
) {
9217 off_t
this = base
+offset
;
9219 /* If we overflow, restart from page zero */
9220 if (this >= server
.vm_pages
) {
9221 this -= server
.vm_pages
;
9223 /* Just overflowed, what we found on tail is no longer
9224 * interesting, as it's no longer contiguous. */
9228 if (vmFreePage(this)) {
9229 /* This is a free page */
9231 /* Already got N free pages? Return to the caller, with success */
9233 *first
= this-(n
-1);
9234 server
.vm_next_page
= this+1;
9235 redisLog(REDIS_DEBUG
, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n
, (long long) *first
);
9239 /* The current one is not a free page */
9243 /* Fast-forward if the current page is not free and we already
9244 * searched enough near this place. */
9246 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
9247 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
9249 /* Note that even if we rewind after the jump, we are don't need
9250 * to make sure numfree is set to zero as we only jump *if* it
9251 * is set to zero. */
9253 /* Otherwise just check the next page */
9260 /* Write the specified object at the specified page of the swap file */
9261 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
9262 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
9263 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
9264 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
9265 redisLog(REDIS_WARNING
,
9266 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
9270 rdbSaveObject(server
.vm_fp
,o
);
9271 fflush(server
.vm_fp
);
9272 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
9276 /* Swap the 'val' object relative to 'key' into disk. Store all the information
9277 * needed to later retrieve the object into the key object.
9278 * If we can't find enough contiguous empty pages to swap the object on disk
9279 * REDIS_ERR is returned. */
9280 static int vmSwapObjectBlocking(robj
*key
, robj
*val
) {
9281 off_t pages
= rdbSavedObjectPages(val
,NULL
);
9284 assert(key
->storage
== REDIS_VM_MEMORY
);
9285 assert(key
->refcount
== 1);
9286 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
9287 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return REDIS_ERR
;
9288 key
->vm
.page
= page
;
9289 key
->vm
.usedpages
= pages
;
9290 key
->storage
= REDIS_VM_SWAPPED
;
9291 key
->vtype
= val
->type
;
9292 decrRefCount(val
); /* Deallocate the object from memory. */
9293 vmMarkPagesUsed(page
,pages
);
9294 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
9295 (unsigned char*) key
->ptr
,
9296 (unsigned long long) page
, (unsigned long long) pages
);
9297 server
.vm_stats_swapped_objects
++;
9298 server
.vm_stats_swapouts
++;
9302 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
9305 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
9306 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
9307 redisLog(REDIS_WARNING
,
9308 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
9312 o
= rdbLoadObject(type
,server
.vm_fp
);
9314 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno
));
9317 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
9321 /* Load the value object relative to the 'key' object from swap to memory.
9322 * The newly allocated object is returned.
9324 * If preview is true the unserialized object is returned to the caller but
9325 * no changes are made to the key object, nor the pages are marked as freed */
9326 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
9329 redisAssert(key
->storage
== REDIS_VM_SWAPPED
|| key
->storage
== REDIS_VM_LOADING
);
9330 val
= vmReadObjectFromSwap(key
->vm
.page
,key
->vtype
);
9332 key
->storage
= REDIS_VM_MEMORY
;
9333 key
->vm
.atime
= server
.unixtime
;
9334 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
9335 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
9336 (unsigned char*) key
->ptr
);
9337 server
.vm_stats_swapped_objects
--;
9339 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
9340 (unsigned char*) key
->ptr
);
9342 server
.vm_stats_swapins
++;
9346 /* Plain object loading, from swap to memory */
9347 static robj
*vmLoadObject(robj
*key
) {
9348 /* If we are loading the object in background, stop it, we
9349 * need to load this object synchronously ASAP. */
9350 if (key
->storage
== REDIS_VM_LOADING
)
9351 vmCancelThreadedIOJob(key
);
9352 return vmGenericLoadObject(key
,0);
9355 /* Just load the value on disk, without to modify the key.
9356 * This is useful when we want to perform some operation on the value
9357 * without to really bring it from swap to memory, like while saving the
9358 * dataset or rewriting the append only log. */
9359 static robj
*vmPreviewObject(robj
*key
) {
9360 return vmGenericLoadObject(key
,1);
9363 /* How a good candidate is this object for swapping?
9364 * The better candidate it is, the greater the returned value.
9366 * Currently we try to perform a fast estimation of the object size in
9367 * memory, and combine it with aging informations.
9369 * Basically swappability = idle-time * log(estimated size)
9371 * Bigger objects are preferred over smaller objects, but not
9372 * proportionally, this is why we use the logarithm. This algorithm is
9373 * just a first try and will probably be tuned later. */
9374 static double computeObjectSwappability(robj
*o
) {
9375 time_t age
= server
.unixtime
- o
->vm
.atime
;
9379 struct dictEntry
*de
;
9382 if (age
<= 0) return 0;
9385 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
9388 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
9393 listNode
*ln
= listFirst(l
);
9395 asize
= sizeof(list
);
9397 robj
*ele
= ln
->value
;
9400 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9401 (sizeof(*o
)+sdslen(ele
->ptr
)) :
9403 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
9408 z
= (o
->type
== REDIS_ZSET
);
9409 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
9411 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
9412 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
9417 de
= dictGetRandomKey(d
);
9418 ele
= dictGetEntryKey(de
);
9419 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9420 (sizeof(*o
)+sdslen(ele
->ptr
)) :
9422 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
9423 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
9427 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
9428 unsigned char *p
= zipmapRewind((unsigned char*)o
->ptr
);
9429 unsigned int len
= zipmapLen((unsigned char*)o
->ptr
);
9430 unsigned int klen
, vlen
;
9431 unsigned char *key
, *val
;
9433 if ((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) == NULL
) {
9437 asize
= len
*(klen
+vlen
+3);
9438 } else if (o
->encoding
== REDIS_ENCODING_HT
) {
9440 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
9445 de
= dictGetRandomKey(d
);
9446 ele
= dictGetEntryKey(de
);
9447 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9448 (sizeof(*o
)+sdslen(ele
->ptr
)) :
9450 ele
= dictGetEntryVal(de
);
9451 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
9452 (sizeof(*o
)+sdslen(ele
->ptr
)) :
9454 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
9459 return (double)age
*log(1+asize
);
9462 /* Try to swap an object that's a good candidate for swapping.
9463 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
9464 * to swap any object at all.
9466 * If 'usethreaded' is true, Redis will try to swap the object in background
9467 * using I/O threads. */
9468 static int vmSwapOneObject(int usethreads
) {
9470 struct dictEntry
*best
= NULL
;
9471 double best_swappability
= 0;
9472 redisDb
*best_db
= NULL
;
9475 for (j
= 0; j
< server
.dbnum
; j
++) {
9476 redisDb
*db
= server
.db
+j
;
9477 /* Why maxtries is set to 100?
9478 * Because this way (usually) we'll find 1 object even if just 1% - 2%
9479 * are swappable objects */
9482 if (dictSize(db
->dict
) == 0) continue;
9483 for (i
= 0; i
< 5; i
++) {
9485 double swappability
;
9487 if (maxtries
) maxtries
--;
9488 de
= dictGetRandomKey(db
->dict
);
9489 key
= dictGetEntryKey(de
);
9490 val
= dictGetEntryVal(de
);
9491 /* Only swap objects that are currently in memory.
9493 * Also don't swap shared objects if threaded VM is on, as we
9494 * try to ensure that the main thread does not touch the
9495 * object while the I/O thread is using it, but we can't
9496 * control other keys without adding additional mutex. */
9497 if (key
->storage
!= REDIS_VM_MEMORY
||
9498 (server
.vm_max_threads
!= 0 && val
->refcount
!= 1)) {
9499 if (maxtries
) i
--; /* don't count this try */
9502 swappability
= computeObjectSwappability(val
);
9503 if (!best
|| swappability
> best_swappability
) {
9505 best_swappability
= swappability
;
9510 if (best
== NULL
) return REDIS_ERR
;
9511 key
= dictGetEntryKey(best
);
9512 val
= dictGetEntryVal(best
);
9514 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
9515 key
->ptr
, best_swappability
);
9517 /* Unshare the key if needed */
9518 if (key
->refcount
> 1) {
9519 robj
*newkey
= dupStringObject(key
);
9521 key
= dictGetEntryKey(best
) = newkey
;
9525 vmSwapObjectThreaded(key
,val
,best_db
);
9528 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
9529 dictGetEntryVal(best
) = NULL
;
9537 static int vmSwapOneObjectBlocking() {
9538 return vmSwapOneObject(0);
9541 static int vmSwapOneObjectThreaded() {
9542 return vmSwapOneObject(1);
9545 /* Return true if it's safe to swap out objects in a given moment.
9546 * Basically we don't want to swap objects out while there is a BGSAVE
9547 * or a BGAEOREWRITE running in backgroud. */
9548 static int vmCanSwapOut(void) {
9549 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
9552 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
9553 * and was deleted. Otherwise 0 is returned. */
9554 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
9558 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
9559 foundkey
= dictGetEntryKey(de
);
9560 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
9565 /* =================== Virtual Memory - Threaded I/O ======================= */
9567 static void freeIOJob(iojob
*j
) {
9568 if ((j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
9569 j
->type
== REDIS_IOJOB_DO_SWAP
||
9570 j
->type
== REDIS_IOJOB_LOAD
) && j
->val
!= NULL
)
9571 decrRefCount(j
->val
);
9572 /* We don't decrRefCount the j->key field as we did't incremented
9573 * the count creating IO Jobs. This is because the key field here is
9574 * just used as an indentifier and if a key is removed the Job should
9575 * never be touched again. */
9579 /* Every time a thread finished a Job, it writes a byte into the write side
9580 * of an unix pipe in order to "awake" the main thread, and this function
9582 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
9586 int retval
, processed
= 0, toprocess
= -1, trytoswap
= 1;
9588 REDIS_NOTUSED(mask
);
9589 REDIS_NOTUSED(privdata
);
9591 /* For every byte we read in the read side of the pipe, there is one
9592 * I/O job completed to process. */
9593 while((retval
= read(fd
,buf
,1)) == 1) {
9597 struct dictEntry
*de
;
9599 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
9601 /* Get the processed element (the oldest one) */
9603 assert(listLength(server
.io_processed
) != 0);
9604 if (toprocess
== -1) {
9605 toprocess
= (listLength(server
.io_processed
)*REDIS_MAX_COMPLETED_JOBS_PROCESSED
)/100;
9606 if (toprocess
<= 0) toprocess
= 1;
9608 ln
= listFirst(server
.io_processed
);
9610 listDelNode(server
.io_processed
,ln
);
9612 /* If this job is marked as canceled, just ignore it */
9617 /* Post process it in the main thread, as there are things we
9618 * can do just here to avoid race conditions and/or invasive locks */
9619 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
);
9620 de
= dictFind(j
->db
->dict
,j
->key
);
9622 key
= dictGetEntryKey(de
);
9623 if (j
->type
== REDIS_IOJOB_LOAD
) {
9626 /* Key loaded, bring it at home */
9627 key
->storage
= REDIS_VM_MEMORY
;
9628 key
->vm
.atime
= server
.unixtime
;
9629 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
9630 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
9631 (unsigned char*) key
->ptr
);
9632 server
.vm_stats_swapped_objects
--;
9633 server
.vm_stats_swapins
++;
9634 dictGetEntryVal(de
) = j
->val
;
9635 incrRefCount(j
->val
);
9638 /* Handle clients waiting for this key to be loaded. */
9639 handleClientsBlockedOnSwappedKey(db
,key
);
9640 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
9641 /* Now we know the amount of pages required to swap this object.
9642 * Let's find some space for it, and queue this task again
9643 * rebranded as REDIS_IOJOB_DO_SWAP. */
9644 if (!vmCanSwapOut() ||
9645 vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
)
9647 /* Ooops... no space or we can't swap as there is
9648 * a fork()ed Redis trying to save stuff on disk. */
9650 key
->storage
= REDIS_VM_MEMORY
; /* undo operation */
9652 /* Note that we need to mark this pages as used now,
9653 * if the job will be canceled, we'll mark them as freed
9655 vmMarkPagesUsed(j
->page
,j
->pages
);
9656 j
->type
= REDIS_IOJOB_DO_SWAP
;
9661 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
9664 /* Key swapped. We can finally free some memory. */
9665 if (key
->storage
!= REDIS_VM_SWAPPING
) {
9666 printf("key->storage: %d\n",key
->storage
);
9667 printf("key->name: %s\n",(char*)key
->ptr
);
9668 printf("key->refcount: %d\n",key
->refcount
);
9669 printf("val: %p\n",(void*)j
->val
);
9670 printf("val->type: %d\n",j
->val
->type
);
9671 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
9673 redisAssert(key
->storage
== REDIS_VM_SWAPPING
);
9674 val
= dictGetEntryVal(de
);
9675 key
->vm
.page
= j
->page
;
9676 key
->vm
.usedpages
= j
->pages
;
9677 key
->storage
= REDIS_VM_SWAPPED
;
9678 key
->vtype
= j
->val
->type
;
9679 decrRefCount(val
); /* Deallocate the object from memory. */
9680 dictGetEntryVal(de
) = NULL
;
9681 redisLog(REDIS_DEBUG
,
9682 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
9683 (unsigned char*) key
->ptr
,
9684 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
9685 server
.vm_stats_swapped_objects
++;
9686 server
.vm_stats_swapouts
++;
9688 /* Put a few more swap requests in queue if we are still
9690 if (trytoswap
&& vmCanSwapOut() &&
9691 zmalloc_used_memory() > server
.vm_max_memory
)
9696 more
= listLength(server
.io_newjobs
) <
9697 (unsigned) server
.vm_max_threads
;
9699 /* Don't waste CPU time if swappable objects are rare. */
9700 if (vmSwapOneObjectThreaded() == REDIS_ERR
) {
9708 if (processed
== toprocess
) return;
9710 if (retval
< 0 && errno
!= EAGAIN
) {
9711 redisLog(REDIS_WARNING
,
9712 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
9717 static void lockThreadedIO(void) {
9718 pthread_mutex_lock(&server
.io_mutex
);
9721 static void unlockThreadedIO(void) {
9722 pthread_mutex_unlock(&server
.io_mutex
);
9725 /* Remove the specified object from the threaded I/O queue if still not
9726 * processed, otherwise make sure to flag it as canceled. */
9727 static void vmCancelThreadedIOJob(robj
*o
) {
9729 server
.io_newjobs
, /* 0 */
9730 server
.io_processing
, /* 1 */
9731 server
.io_processed
/* 2 */
9735 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
9738 /* Search for a matching key in one of the queues */
9739 for (i
= 0; i
< 3; i
++) {
9743 listRewind(lists
[i
],&li
);
9744 while ((ln
= listNext(&li
)) != NULL
) {
9745 iojob
*job
= ln
->value
;
9747 if (job
->canceled
) continue; /* Skip this, already canceled. */
9748 if (job
->key
== o
) {
9749 redisLog(REDIS_DEBUG
,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
9750 (void*)job
, (char*)o
->ptr
, job
->type
, i
);
9751 /* Mark the pages as free since the swap didn't happened
9752 * or happened but is now discarded. */
9753 if (i
!= 1 && job
->type
== REDIS_IOJOB_DO_SWAP
)
9754 vmMarkPagesFree(job
->page
,job
->pages
);
9755 /* Cancel the job. It depends on the list the job is
9758 case 0: /* io_newjobs */
9759 /* If the job was yet not processed the best thing to do
9760 * is to remove it from the queue at all */
9762 listDelNode(lists
[i
],ln
);
9764 case 1: /* io_processing */
9765 /* Oh Shi- the thread is messing with the Job:
9767 * Probably it's accessing the object if this is a
9768 * PREPARE_SWAP or DO_SWAP job.
9769 * If it's a LOAD job it may be reading from disk and
9770 * if we don't wait for the job to terminate before to
9771 * cancel it, maybe in a few microseconds data can be
9772 * corrupted in this pages. So the short story is:
9774 * Better to wait for the job to move into the
9775 * next queue (processed)... */
9777 /* We try again and again until the job is completed. */
9779 /* But let's wait some time for the I/O thread
9780 * to finish with this job. After all this condition
9781 * should be very rare. */
9784 case 2: /* io_processed */
9785 /* The job was already processed, that's easy...
9786 * just mark it as canceled so that we'll ignore it
9787 * when processing completed jobs. */
9791 /* Finally we have to adjust the storage type of the object
9792 * in order to "UNDO" the operaiton. */
9793 if (o
->storage
== REDIS_VM_LOADING
)
9794 o
->storage
= REDIS_VM_SWAPPED
;
9795 else if (o
->storage
== REDIS_VM_SWAPPING
)
9796 o
->storage
= REDIS_VM_MEMORY
;
9803 assert(1 != 1); /* We should never reach this */
9806 static void *IOThreadEntryPoint(void *arg
) {
9811 pthread_detach(pthread_self());
9813 /* Get a new job to process */
9815 if (listLength(server
.io_newjobs
) == 0) {
9816 /* No new jobs in queue, exit. */
9817 redisLog(REDIS_DEBUG
,"Thread %ld exiting, nothing to do",
9818 (long) pthread_self());
9819 server
.io_active_threads
--;
9823 ln
= listFirst(server
.io_newjobs
);
9825 listDelNode(server
.io_newjobs
,ln
);
9826 /* Add the job in the processing queue */
9827 j
->thread
= pthread_self();
9828 listAddNodeTail(server
.io_processing
,j
);
9829 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
9831 redisLog(REDIS_DEBUG
,"Thread %ld got a new job (type %d): %p about key '%s'",
9832 (long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
9834 /* Process the Job */
9835 if (j
->type
== REDIS_IOJOB_LOAD
) {
9836 j
->val
= vmReadObjectFromSwap(j
->page
,j
->key
->vtype
);
9837 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
9838 FILE *fp
= fopen("/dev/null","w+");
9839 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
9841 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
9842 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
9846 /* Done: insert the job into the processed queue */
9847 redisLog(REDIS_DEBUG
,"Thread %ld completed the job: %p (key %s)",
9848 (long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
9850 listDelNode(server
.io_processing
,ln
);
9851 listAddNodeTail(server
.io_processed
,j
);
9854 /* Signal the main thread there is new stuff to process */
9855 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
9857 return NULL
; /* never reached */
9860 static void spawnIOThread(void) {
9862 sigset_t mask
, omask
;
9866 sigaddset(&mask
,SIGCHLD
);
9867 sigaddset(&mask
,SIGHUP
);
9868 sigaddset(&mask
,SIGPIPE
);
9869 pthread_sigmask(SIG_SETMASK
, &mask
, &omask
);
9870 while ((err
= pthread_create(&thread
,&server
.io_threads_attr
,IOThreadEntryPoint
,NULL
)) != 0) {
9871 redisLog(REDIS_WARNING
,"Unable to spawn an I/O thread: %s",
9875 pthread_sigmask(SIG_SETMASK
, &omask
, NULL
);
9876 server
.io_active_threads
++;
9879 /* We need to wait for the last thread to exit before we are able to
9880 * fork() in order to BGSAVE or BGREWRITEAOF. */
9881 static void waitEmptyIOJobsQueue(void) {
9883 int io_processed_len
;
9886 if (listLength(server
.io_newjobs
) == 0 &&
9887 listLength(server
.io_processing
) == 0 &&
9888 server
.io_active_threads
== 0)
9893 /* While waiting for empty jobs queue condition we post-process some
9894 * finshed job, as I/O threads may be hanging trying to write against
9895 * the io_ready_pipe_write FD but there are so much pending jobs that
9897 io_processed_len
= listLength(server
.io_processed
);
9899 if (io_processed_len
) {
9900 vmThreadedIOCompletedJob(NULL
,server
.io_ready_pipe_read
,NULL
,0);
9901 usleep(1000); /* 1 millisecond */
9903 usleep(10000); /* 10 milliseconds */
9908 static void vmReopenSwapFile(void) {
9909 /* Note: we don't close the old one as we are in the child process
9910 * and don't want to mess at all with the original file object. */
9911 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
9912 if (server
.vm_fp
== NULL
) {
9913 redisLog(REDIS_WARNING
,"Can't re-open the VM swap file: %s. Exiting.",
9914 server
.vm_swap_file
);
9917 server
.vm_fd
= fileno(server
.vm_fp
);
9920 /* This function must be called while with threaded IO locked */
9921 static void queueIOJob(iojob
*j
) {
9922 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
9923 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
9924 listAddNodeTail(server
.io_newjobs
,j
);
9925 if (server
.io_active_threads
< server
.vm_max_threads
)
9929 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
9932 assert(key
->storage
== REDIS_VM_MEMORY
);
9933 assert(key
->refcount
== 1);
9935 j
= zmalloc(sizeof(*j
));
9936 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
9942 j
->thread
= (pthread_t
) -1;
9943 key
->storage
= REDIS_VM_SWAPPING
;
9951 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
9953 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
9954 * If there is not already a job loading the key, it is craeted.
9955 * The key is added to the io_keys list in the client structure, and also
9956 * in the hash table mapping swapped keys to waiting clients, that is,
9957 * server.io_waited_keys. */
9958 static int waitForSwappedKey(redisClient
*c
, robj
*key
) {
9959 struct dictEntry
*de
;
9963 /* If the key does not exist or is already in RAM we don't need to
9964 * block the client at all. */
9965 de
= dictFind(c
->db
->dict
,key
);
9966 if (de
== NULL
) return 0;
9967 o
= dictGetEntryKey(de
);
9968 if (o
->storage
== REDIS_VM_MEMORY
) {
9970 } else if (o
->storage
== REDIS_VM_SWAPPING
) {
9971 /* We were swapping the key, undo it! */
9972 vmCancelThreadedIOJob(o
);
9976 /* OK: the key is either swapped, or being loaded just now. */
9978 /* Add the key to the list of keys this client is waiting for.
9979 * This maps clients to keys they are waiting for. */
9980 listAddNodeTail(c
->io_keys
,key
);
9983 /* Add the client to the swapped keys => clients waiting map. */
9984 de
= dictFind(c
->db
->io_keys
,key
);
9988 /* For every key we take a list of clients blocked for it */
9990 retval
= dictAdd(c
->db
->io_keys
,key
,l
);
9992 assert(retval
== DICT_OK
);
9994 l
= dictGetEntryVal(de
);
9996 listAddNodeTail(l
,c
);
9998 /* Are we already loading the key from disk? If not create a job */
9999 if (o
->storage
== REDIS_VM_SWAPPED
) {
10002 o
->storage
= REDIS_VM_LOADING
;
10003 j
= zmalloc(sizeof(*j
));
10004 j
->type
= REDIS_IOJOB_LOAD
;
10007 j
->key
->vtype
= o
->vtype
;
10008 j
->page
= o
->vm
.page
;
10011 j
->thread
= (pthread_t
) -1;
10014 unlockThreadedIO();
10019 /* Preload keys for any command with first, last and step values for
10020 * the command keys prototype, as defined in the command table. */
10021 static void waitForMultipleSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
, int argc
, robj
**argv
) {
10023 if (cmd
->vm_firstkey
== 0) return;
10024 last
= cmd
->vm_lastkey
;
10025 if (last
< 0) last
= argc
+last
;
10026 for (j
= cmd
->vm_firstkey
; j
<= last
; j
+= cmd
->vm_keystep
) {
10027 redisAssert(j
< argc
);
10028 waitForSwappedKey(c
,argv
[j
]);
10032 /* Preload keys needed for the ZUNIONSTORE and ZINTERSTORE commands.
10033 * Note that the number of keys to preload is user-defined, so we need to
10034 * apply a sanity check against argc. */
10035 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
, int argc
, robj
**argv
) {
10037 REDIS_NOTUSED(cmd
);
10039 num
= atoi(argv
[2]->ptr
);
10040 if (num
> (argc
-3)) return;
10041 for (i
= 0; i
< num
; i
++) {
10042 waitForSwappedKey(c
,argv
[3+i
]);
10046 /* Preload keys needed to execute the entire MULTI/EXEC block.
10048 * This function is called by blockClientOnSwappedKeys when EXEC is issued,
10049 * and will block the client when any command requires a swapped out value. */
10050 static void execBlockClientOnSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
, int argc
, robj
**argv
) {
10052 struct redisCommand
*mcmd
;
10054 REDIS_NOTUSED(cmd
);
10055 REDIS_NOTUSED(argc
);
10056 REDIS_NOTUSED(argv
);
10058 if (!(c
->flags
& REDIS_MULTI
)) return;
10059 for (i
= 0; i
< c
->mstate
.count
; i
++) {
10060 mcmd
= c
->mstate
.commands
[i
].cmd
;
10061 margc
= c
->mstate
.commands
[i
].argc
;
10062 margv
= c
->mstate
.commands
[i
].argv
;
10064 if (mcmd
->vm_preload_proc
!= NULL
) {
10065 mcmd
->vm_preload_proc(c
,mcmd
,margc
,margv
);
10067 waitForMultipleSwappedKeys(c
,mcmd
,margc
,margv
);
10072 /* Is this client attempting to run a command against swapped keys?
10073 * If so, block it ASAP, load the keys in background, then resume it.
10075 * The important idea about this function is that it can fail! If keys will
10076 * still be swapped when the client is resumed, this key lookups will
10077 * just block loading keys from disk. In practical terms this should only
10078 * happen with SORT BY command or if there is a bug in this function.
10080 * Return 1 if the client is marked as blocked, 0 if the client can
10081 * continue as the keys it is going to access appear to be in memory. */
10082 static int blockClientOnSwappedKeys(redisClient
*c
, struct redisCommand
*cmd
) {
10083 if (cmd
->vm_preload_proc
!= NULL
) {
10084 cmd
->vm_preload_proc(c
,cmd
,c
->argc
,c
->argv
);
10086 waitForMultipleSwappedKeys(c
,cmd
,c
->argc
,c
->argv
);
10089 /* If the client was blocked for at least one key, mark it as blocked. */
10090 if (listLength(c
->io_keys
)) {
10091 c
->flags
|= REDIS_IO_WAIT
;
10092 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
10093 server
.vm_blocked_clients
++;
10100 /* Remove the 'key' from the list of blocked keys for a given client.
10102 * The function returns 1 when there are no longer blocking keys after
10103 * the current one was removed (and the client can be unblocked). */
10104 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
) {
10108 struct dictEntry
*de
;
10110 /* Remove the key from the list of keys this client is waiting for. */
10111 listRewind(c
->io_keys
,&li
);
10112 while ((ln
= listNext(&li
)) != NULL
) {
10113 if (equalStringObjects(ln
->value
,key
)) {
10114 listDelNode(c
->io_keys
,ln
);
10118 assert(ln
!= NULL
);
10120 /* Remove the client form the key => waiting clients map. */
10121 de
= dictFind(c
->db
->io_keys
,key
);
10122 assert(de
!= NULL
);
10123 l
= dictGetEntryVal(de
);
10124 ln
= listSearchKey(l
,c
);
10125 assert(ln
!= NULL
);
10127 if (listLength(l
) == 0)
10128 dictDelete(c
->db
->io_keys
,key
);
10130 return listLength(c
->io_keys
) == 0;
10133 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
) {
10134 struct dictEntry
*de
;
10139 de
= dictFind(db
->io_keys
,key
);
10142 l
= dictGetEntryVal(de
);
10143 len
= listLength(l
);
10144 /* Note: we can't use something like while(listLength(l)) as the list
10145 * can be freed by the calling function when we remove the last element. */
10148 redisClient
*c
= ln
->value
;
10150 if (dontWaitForSwappedKey(c
,key
)) {
10151 /* Put the client in the list of clients ready to go as we
10152 * loaded all the keys about it. */
10153 listAddNodeTail(server
.io_ready_clients
,c
);
10158 /* =========================== Remote Configuration ========================= */
10160 static void configSetCommand(redisClient
*c
) {
10161 robj
*o
= getDecodedObject(c
->argv
[3]);
10164 if (!strcasecmp(c
->argv
[2]->ptr
,"dbfilename")) {
10165 zfree(server
.dbfilename
);
10166 server
.dbfilename
= zstrdup(o
->ptr
);
10167 } else if (!strcasecmp(c
->argv
[2]->ptr
,"requirepass")) {
10168 zfree(server
.requirepass
);
10169 server
.requirepass
= zstrdup(o
->ptr
);
10170 } else if (!strcasecmp(c
->argv
[2]->ptr
,"masterauth")) {
10171 zfree(server
.masterauth
);
10172 server
.masterauth
= zstrdup(o
->ptr
);
10173 } else if (!strcasecmp(c
->argv
[2]->ptr
,"maxmemory")) {
10174 if (getLongLongFromObject(o
,&ll
) == REDIS_ERR
||
10175 ll
< 0) goto badfmt
;
10176 server
.maxmemory
= ll
;
10177 } else if (!strcasecmp(c
->argv
[2]->ptr
,"timeout")) {
10178 if (getLongLongFromObject(o
,&ll
) == REDIS_ERR
||
10179 ll
< 0 || ll
> LONG_MAX
) goto badfmt
;
10180 server
.maxidletime
= ll
;
10181 } else if (!strcasecmp(c
->argv
[2]->ptr
,"appendfsync")) {
10182 if (!strcasecmp(o
->ptr
,"no")) {
10183 server
.appendfsync
= APPENDFSYNC_NO
;
10184 } else if (!strcasecmp(o
->ptr
,"everysec")) {
10185 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
10186 } else if (!strcasecmp(o
->ptr
,"always")) {
10187 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
10191 } else if (!strcasecmp(c
->argv
[2]->ptr
,"appendonly")) {
10192 int old
= server
.appendonly
;
10193 int new = yesnotoi(o
->ptr
);
10195 if (new == -1) goto badfmt
;
10200 if (startAppendOnly() == REDIS_ERR
) {
10201 addReplySds(c
,sdscatprintf(sdsempty(),
10202 "-ERR Unable to turn on AOF. Check server logs.\r\n"));
10208 } else if (!strcasecmp(c
->argv
[2]->ptr
,"save")) {
10210 sds
*v
= sdssplitlen(o
->ptr
,sdslen(o
->ptr
)," ",1,&vlen
);
10212 /* Perform sanity check before setting the new config:
10213 * - Even number of args
10214 * - Seconds >= 1, changes >= 0 */
10216 sdsfreesplitres(v
,vlen
);
10219 for (j
= 0; j
< vlen
; j
++) {
10223 val
= strtoll(v
[j
], &eptr
, 10);
10224 if (eptr
[0] != '\0' ||
10225 ((j
& 1) == 0 && val
< 1) ||
10226 ((j
& 1) == 1 && val
< 0)) {
10227 sdsfreesplitres(v
,vlen
);
10231 /* Finally set the new config */
10232 resetServerSaveParams();
10233 for (j
= 0; j
< vlen
; j
+= 2) {
10237 seconds
= strtoll(v
[j
],NULL
,10);
10238 changes
= strtoll(v
[j
+1],NULL
,10);
10239 appendServerSaveParams(seconds
, changes
);
10241 sdsfreesplitres(v
,vlen
);
10243 addReplySds(c
,sdscatprintf(sdsempty(),
10244 "-ERR not supported CONFIG parameter %s\r\n",
10245 (char*)c
->argv
[2]->ptr
));
10250 addReply(c
,shared
.ok
);
10253 badfmt
: /* Bad format errors */
10254 addReplySds(c
,sdscatprintf(sdsempty(),
10255 "-ERR invalid argument '%s' for CONFIG SET '%s'\r\n",
10257 (char*)c
->argv
[2]->ptr
));
10261 static void configGetCommand(redisClient
*c
) {
10262 robj
*o
= getDecodedObject(c
->argv
[2]);
10263 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
10264 char *pattern
= o
->ptr
;
10267 addReply(c
,lenobj
);
10268 decrRefCount(lenobj
);
10270 if (stringmatch(pattern
,"dbfilename",0)) {
10271 addReplyBulkCString(c
,"dbfilename");
10272 addReplyBulkCString(c
,server
.dbfilename
);
10275 if (stringmatch(pattern
,"requirepass",0)) {
10276 addReplyBulkCString(c
,"requirepass");
10277 addReplyBulkCString(c
,server
.requirepass
);
10280 if (stringmatch(pattern
,"masterauth",0)) {
10281 addReplyBulkCString(c
,"masterauth");
10282 addReplyBulkCString(c
,server
.masterauth
);
10285 if (stringmatch(pattern
,"maxmemory",0)) {
10288 ll2string(buf
,128,server
.maxmemory
);
10289 addReplyBulkCString(c
,"maxmemory");
10290 addReplyBulkCString(c
,buf
);
10293 if (stringmatch(pattern
,"timeout",0)) {
10296 ll2string(buf
,128,server
.maxidletime
);
10297 addReplyBulkCString(c
,"timeout");
10298 addReplyBulkCString(c
,buf
);
10301 if (stringmatch(pattern
,"appendonly",0)) {
10302 addReplyBulkCString(c
,"appendonly");
10303 addReplyBulkCString(c
,server
.appendonly
? "yes" : "no");
10306 if (stringmatch(pattern
,"appendfsync",0)) {
10309 switch(server
.appendfsync
) {
10310 case APPENDFSYNC_NO
: policy
= "no"; break;
10311 case APPENDFSYNC_EVERYSEC
: policy
= "everysec"; break;
10312 case APPENDFSYNC_ALWAYS
: policy
= "always"; break;
10313 default: policy
= "unknown"; break; /* too harmless to panic */
10315 addReplyBulkCString(c
,"appendfsync");
10316 addReplyBulkCString(c
,policy
);
10319 if (stringmatch(pattern
,"save",0)) {
10320 sds buf
= sdsempty();
10323 for (j
= 0; j
< server
.saveparamslen
; j
++) {
10324 buf
= sdscatprintf(buf
,"%ld %d",
10325 server
.saveparams
[j
].seconds
,
10326 server
.saveparams
[j
].changes
);
10327 if (j
!= server
.saveparamslen
-1)
10328 buf
= sdscatlen(buf
," ",1);
10330 addReplyBulkCString(c
,"save");
10331 addReplyBulkCString(c
,buf
);
10336 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%d\r\n",matches
*2);
10339 static void configCommand(redisClient
*c
) {
10340 if (!strcasecmp(c
->argv
[1]->ptr
,"set")) {
10341 if (c
->argc
!= 4) goto badarity
;
10342 configSetCommand(c
);
10343 } else if (!strcasecmp(c
->argv
[1]->ptr
,"get")) {
10344 if (c
->argc
!= 3) goto badarity
;
10345 configGetCommand(c
);
10346 } else if (!strcasecmp(c
->argv
[1]->ptr
,"resetstat")) {
10347 if (c
->argc
!= 2) goto badarity
;
10348 server
.stat_numcommands
= 0;
10349 server
.stat_numconnections
= 0;
10350 server
.stat_expiredkeys
= 0;
10351 server
.stat_starttime
= time(NULL
);
10352 addReply(c
,shared
.ok
);
10354 addReplySds(c
,sdscatprintf(sdsempty(),
10355 "-ERR CONFIG subcommand must be one of GET, SET, RESETSTAT\r\n"));
10360 addReplySds(c
,sdscatprintf(sdsempty(),
10361 "-ERR Wrong number of arguments for CONFIG %s\r\n",
10362 (char*) c
->argv
[1]->ptr
));
10365 /* =========================== Pubsub implementation ======================== */
10367 static void freePubsubPattern(void *p
) {
10368 pubsubPattern
*pat
= p
;
10370 decrRefCount(pat
->pattern
);
10374 static int listMatchPubsubPattern(void *a
, void *b
) {
10375 pubsubPattern
*pa
= a
, *pb
= b
;
10377 return (pa
->client
== pb
->client
) &&
10378 (equalStringObjects(pa
->pattern
,pb
->pattern
));
10381 /* Subscribe a client to a channel. Returns 1 if the operation succeeded, or
10382 * 0 if the client was already subscribed to that channel. */
10383 static int pubsubSubscribeChannel(redisClient
*c
, robj
*channel
) {
10384 struct dictEntry
*de
;
10385 list
*clients
= NULL
;
10388 /* Add the channel to the client -> channels hash table */
10389 if (dictAdd(c
->pubsub_channels
,channel
,NULL
) == DICT_OK
) {
10391 incrRefCount(channel
);
10392 /* Add the client to the channel -> list of clients hash table */
10393 de
= dictFind(server
.pubsub_channels
,channel
);
10395 clients
= listCreate();
10396 dictAdd(server
.pubsub_channels
,channel
,clients
);
10397 incrRefCount(channel
);
10399 clients
= dictGetEntryVal(de
);
10401 listAddNodeTail(clients
,c
);
10403 /* Notify the client */
10404 addReply(c
,shared
.mbulk3
);
10405 addReply(c
,shared
.subscribebulk
);
10406 addReplyBulk(c
,channel
);
10407 addReplyLongLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
10411 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
10412 * 0 if the client was not subscribed to the specified channel. */
10413 static int pubsubUnsubscribeChannel(redisClient
*c
, robj
*channel
, int notify
) {
10414 struct dictEntry
*de
;
10419 /* Remove the channel from the client -> channels hash table */
10420 incrRefCount(channel
); /* channel may be just a pointer to the same object
10421 we have in the hash tables. Protect it... */
10422 if (dictDelete(c
->pubsub_channels
,channel
) == DICT_OK
) {
10424 /* Remove the client from the channel -> clients list hash table */
10425 de
= dictFind(server
.pubsub_channels
,channel
);
10426 assert(de
!= NULL
);
10427 clients
= dictGetEntryVal(de
);
10428 ln
= listSearchKey(clients
,c
);
10429 assert(ln
!= NULL
);
10430 listDelNode(clients
,ln
);
10431 if (listLength(clients
) == 0) {
10432 /* Free the list and associated hash entry at all if this was
10433 * the latest client, so that it will be possible to abuse
10434 * Redis PUBSUB creating millions of channels. */
10435 dictDelete(server
.pubsub_channels
,channel
);
10438 /* Notify the client */
10440 addReply(c
,shared
.mbulk3
);
10441 addReply(c
,shared
.unsubscribebulk
);
10442 addReplyBulk(c
,channel
);
10443 addReplyLongLong(c
,dictSize(c
->pubsub_channels
)+
10444 listLength(c
->pubsub_patterns
));
10447 decrRefCount(channel
); /* it is finally safe to release it */
10451 /* Subscribe a client to a pattern. Returns 1 if the operation succeeded, or 0 if the clinet was already subscribed to that pattern. */
10452 static int pubsubSubscribePattern(redisClient
*c
, robj
*pattern
) {
10455 if (listSearchKey(c
->pubsub_patterns
,pattern
) == NULL
) {
10457 pubsubPattern
*pat
;
10458 listAddNodeTail(c
->pubsub_patterns
,pattern
);
10459 incrRefCount(pattern
);
10460 pat
= zmalloc(sizeof(*pat
));
10461 pat
->pattern
= getDecodedObject(pattern
);
10463 listAddNodeTail(server
.pubsub_patterns
,pat
);
10465 /* Notify the client */
10466 addReply(c
,shared
.mbulk3
);
10467 addReply(c
,shared
.psubscribebulk
);
10468 addReplyBulk(c
,pattern
);
10469 addReplyLongLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
10473 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
10474 * 0 if the client was not subscribed to the specified channel. */
10475 static int pubsubUnsubscribePattern(redisClient
*c
, robj
*pattern
, int notify
) {
10480 incrRefCount(pattern
); /* Protect the object. May be the same we remove */
10481 if ((ln
= listSearchKey(c
->pubsub_patterns
,pattern
)) != NULL
) {
10483 listDelNode(c
->pubsub_patterns
,ln
);
10485 pat
.pattern
= pattern
;
10486 ln
= listSearchKey(server
.pubsub_patterns
,&pat
);
10487 listDelNode(server
.pubsub_patterns
,ln
);
10489 /* Notify the client */
10491 addReply(c
,shared
.mbulk3
);
10492 addReply(c
,shared
.punsubscribebulk
);
10493 addReplyBulk(c
,pattern
);
10494 addReplyLongLong(c
,dictSize(c
->pubsub_channels
)+
10495 listLength(c
->pubsub_patterns
));
10497 decrRefCount(pattern
);
10501 /* Unsubscribe from all the channels. Return the number of channels the
10502 * client was subscribed from. */
10503 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
) {
10504 dictIterator
*di
= dictGetIterator(c
->pubsub_channels
);
10508 while((de
= dictNext(di
)) != NULL
) {
10509 robj
*channel
= dictGetEntryKey(de
);
10511 count
+= pubsubUnsubscribeChannel(c
,channel
,notify
);
10513 dictReleaseIterator(di
);
10517 /* Unsubscribe from all the patterns. Return the number of patterns the
10518 * client was subscribed from. */
10519 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
) {
10524 listRewind(c
->pubsub_patterns
,&li
);
10525 while ((ln
= listNext(&li
)) != NULL
) {
10526 robj
*pattern
= ln
->value
;
10528 count
+= pubsubUnsubscribePattern(c
,pattern
,notify
);
10533 /* Publish a message */
10534 static int pubsubPublishMessage(robj
*channel
, robj
*message
) {
10536 struct dictEntry
*de
;
10540 /* Send to clients listening for that channel */
10541 de
= dictFind(server
.pubsub_channels
,channel
);
10543 list
*list
= dictGetEntryVal(de
);
10547 listRewind(list
,&li
);
10548 while ((ln
= listNext(&li
)) != NULL
) {
10549 redisClient
*c
= ln
->value
;
10551 addReply(c
,shared
.mbulk3
);
10552 addReply(c
,shared
.messagebulk
);
10553 addReplyBulk(c
,channel
);
10554 addReplyBulk(c
,message
);
10558 /* Send to clients listening to matching channels */
10559 if (listLength(server
.pubsub_patterns
)) {
10560 listRewind(server
.pubsub_patterns
,&li
);
10561 channel
= getDecodedObject(channel
);
10562 while ((ln
= listNext(&li
)) != NULL
) {
10563 pubsubPattern
*pat
= ln
->value
;
10565 if (stringmatchlen((char*)pat
->pattern
->ptr
,
10566 sdslen(pat
->pattern
->ptr
),
10567 (char*)channel
->ptr
,
10568 sdslen(channel
->ptr
),0)) {
10569 addReply(pat
->client
,shared
.mbulk4
);
10570 addReply(pat
->client
,shared
.pmessagebulk
);
10571 addReplyBulk(pat
->client
,pat
->pattern
);
10572 addReplyBulk(pat
->client
,channel
);
10573 addReplyBulk(pat
->client
,message
);
10577 decrRefCount(channel
);
10582 static void subscribeCommand(redisClient
*c
) {
10585 for (j
= 1; j
< c
->argc
; j
++)
10586 pubsubSubscribeChannel(c
,c
->argv
[j
]);
10589 static void unsubscribeCommand(redisClient
*c
) {
10590 if (c
->argc
== 1) {
10591 pubsubUnsubscribeAllChannels(c
,1);
10596 for (j
= 1; j
< c
->argc
; j
++)
10597 pubsubUnsubscribeChannel(c
,c
->argv
[j
],1);
10601 static void psubscribeCommand(redisClient
*c
) {
10604 for (j
= 1; j
< c
->argc
; j
++)
10605 pubsubSubscribePattern(c
,c
->argv
[j
]);
10608 static void punsubscribeCommand(redisClient
*c
) {
10609 if (c
->argc
== 1) {
10610 pubsubUnsubscribeAllPatterns(c
,1);
10615 for (j
= 1; j
< c
->argc
; j
++)
10616 pubsubUnsubscribePattern(c
,c
->argv
[j
],1);
10620 static void publishCommand(redisClient
*c
) {
10621 int receivers
= pubsubPublishMessage(c
->argv
[1],c
->argv
[2]);
10622 addReplyLongLong(c
,receivers
);
10625 /* ===================== WATCH (CAS alike for MULTI/EXEC) ===================
10627 * The implementation uses a per-DB hash table mapping keys to list of clients
10628 * WATCHing those keys, so that given a key that is going to be modified
10629 * we can mark all the associated clients as dirty.
10631 * Also every client contains a list of WATCHed keys so that's possible to
10632 * un-watch such keys when the client is freed or when UNWATCH is called. */
10634 /* In the client->watched_keys list we need to use watchedKey structures
10635 * as in order to identify a key in Redis we need both the key name and the
10637 typedef struct watchedKey
{
10642 /* Watch for the specified key */
10643 static void watchForKey(redisClient
*c
, robj
*key
) {
10644 list
*clients
= NULL
;
10649 /* Check if we are already watching for this key */
10650 listRewind(c
->watched_keys
,&li
);
10651 while((ln
= listNext(&li
))) {
10652 wk
= listNodeValue(ln
);
10653 if (wk
->db
== c
->db
&& equalStringObjects(key
,wk
->key
))
10654 return; /* Key already watched */
10656 /* This key is not already watched in this DB. Let's add it */
10657 clients
= dictFetchValue(c
->db
->watched_keys
,key
);
10659 clients
= listCreate();
10660 dictAdd(c
->db
->watched_keys
,key
,clients
);
10663 listAddNodeTail(clients
,c
);
10664 /* Add the new key to the lits of keys watched by this client */
10665 wk
= zmalloc(sizeof(*wk
));
10669 listAddNodeTail(c
->watched_keys
,wk
);
10672 /* Unwatch all the keys watched by this client. To clean the EXEC dirty
10673 * flag is up to the caller. */
10674 static void unwatchAllKeys(redisClient
*c
) {
10678 if (listLength(c
->watched_keys
) == 0) return;
10679 listRewind(c
->watched_keys
,&li
);
10680 while((ln
= listNext(&li
))) {
10684 /* Lookup the watched key -> clients list and remove the client
10686 wk
= listNodeValue(ln
);
10687 clients
= dictFetchValue(wk
->db
->watched_keys
, wk
->key
);
10688 assert(clients
!= NULL
);
10689 listDelNode(clients
,listSearchKey(clients
,c
));
10690 /* Kill the entry at all if this was the only client */
10691 if (listLength(clients
) == 0)
10692 dictDelete(wk
->db
->watched_keys
, wk
->key
);
10693 /* Remove this watched key from the client->watched list */
10694 listDelNode(c
->watched_keys
,ln
);
10695 decrRefCount(wk
->key
);
10700 /* "Touch" a key, so that if this key is being WATCHed by some client the
10701 * next EXEC will fail. */
10702 static void touchWatchedKey(redisDb
*db
, robj
*key
) {
10707 if (dictSize(db
->watched_keys
) == 0) return;
10708 clients
= dictFetchValue(db
->watched_keys
, key
);
10709 if (!clients
) return;
10711 /* Mark all the clients watching this key as REDIS_DIRTY_CAS */
10712 /* Check if we are already watching for this key */
10713 listRewind(clients
,&li
);
10714 while((ln
= listNext(&li
))) {
10715 redisClient
*c
= listNodeValue(ln
);
10717 c
->flags
|= REDIS_DIRTY_CAS
;
10721 /* On FLUSHDB or FLUSHALL all the watched keys that are present before the
10722 * flush but will be deleted as effect of the flushing operation should
10723 * be touched. "dbid" is the DB that's getting the flush. -1 if it is
10724 * a FLUSHALL operation (all the DBs flushed). */
10725 static void touchWatchedKeysOnFlush(int dbid
) {
10729 /* For every client, check all the waited keys */
10730 listRewind(server
.clients
,&li1
);
10731 while((ln
= listNext(&li1
))) {
10732 redisClient
*c
= listNodeValue(ln
);
10733 listRewind(c
->watched_keys
,&li2
);
10734 while((ln
= listNext(&li2
))) {
10735 watchedKey
*wk
= listNodeValue(ln
);
10737 /* For every watched key matching the specified DB, if the
10738 * key exists, mark the client as dirty, as the key will be
10740 if (dbid
== -1 || wk
->db
->id
== dbid
) {
10741 if (dictFind(wk
->db
->dict
, wk
->key
) != NULL
)
10742 c
->flags
|= REDIS_DIRTY_CAS
;
10748 static void watchCommand(redisClient
*c
) {
10751 if (c
->flags
& REDIS_MULTI
) {
10752 addReplySds(c
,sdsnew("-ERR WATCH inside MULTI is not allowed\r\n"));
10755 for (j
= 1; j
< c
->argc
; j
++)
10756 watchForKey(c
,c
->argv
[j
]);
10757 addReply(c
,shared
.ok
);
10760 static void unwatchCommand(redisClient
*c
) {
10762 c
->flags
&= (~REDIS_DIRTY_CAS
);
10763 addReply(c
,shared
.ok
);
10766 /* ================================= Debugging ============================== */
10768 /* Compute the sha1 of string at 's' with 'len' bytes long.
10769 * The SHA1 is then xored againt the string pointed by digest.
10770 * Since xor is commutative, this operation is used in order to
10771 * "add" digests relative to unordered elements.
10773 * So digest(a,b,c,d) will be the same of digest(b,a,c,d) */
10774 static void xorDigest(unsigned char *digest
, void *ptr
, size_t len
) {
10776 unsigned char hash
[20], *s
= ptr
;
10780 SHA1Update(&ctx
,s
,len
);
10781 SHA1Final(hash
,&ctx
);
10783 for (j
= 0; j
< 20; j
++)
10784 digest
[j
] ^= hash
[j
];
10787 static void xorObjectDigest(unsigned char *digest
, robj
*o
) {
10788 o
= getDecodedObject(o
);
10789 xorDigest(digest
,o
->ptr
,sdslen(o
->ptr
));
10793 /* This function instead of just computing the SHA1 and xoring it
10794 * against diget, also perform the digest of "digest" itself and
10795 * replace the old value with the new one.
10797 * So the final digest will be:
10799 * digest = SHA1(digest xor SHA1(data))
10801 * This function is used every time we want to preserve the order so
10802 * that digest(a,b,c,d) will be different than digest(b,c,d,a)
10804 * Also note that mixdigest("foo") followed by mixdigest("bar")
10805 * will lead to a different digest compared to "fo", "obar".
10807 static void mixDigest(unsigned char *digest
, void *ptr
, size_t len
) {
10811 xorDigest(digest
,s
,len
);
10813 SHA1Update(&ctx
,digest
,20);
10814 SHA1Final(digest
,&ctx
);
10817 static void mixObjectDigest(unsigned char *digest
, robj
*o
) {
10818 o
= getDecodedObject(o
);
10819 mixDigest(digest
,o
->ptr
,sdslen(o
->ptr
));
10823 /* Compute the dataset digest. Since keys, sets elements, hashes elements
10824 * are not ordered, we use a trick: every aggregate digest is the xor
10825 * of the digests of their elements. This way the order will not change
10826 * the result. For list instead we use a feedback entering the output digest
10827 * as input in order to ensure that a different ordered list will result in
10828 * a different digest. */
10829 static void computeDatasetDigest(unsigned char *final
) {
10830 unsigned char digest
[20];
10832 dictIterator
*di
= NULL
;
10837 memset(final
,0,20); /* Start with a clean result */
10839 for (j
= 0; j
< server
.dbnum
; j
++) {
10840 redisDb
*db
= server
.db
+j
;
10842 if (dictSize(db
->dict
) == 0) continue;
10843 di
= dictGetIterator(db
->dict
);
10845 /* hash the DB id, so the same dataset moved in a different
10846 * DB will lead to a different digest */
10848 mixDigest(final
,&aux
,sizeof(aux
));
10850 /* Iterate this DB writing every entry */
10851 while((de
= dictNext(di
)) != NULL
) {
10852 robj
*key
, *o
, *kcopy
;
10855 memset(digest
,0,20); /* This key-val digest */
10856 key
= dictGetEntryKey(de
);
10858 if (!server
.vm_enabled
) {
10859 mixObjectDigest(digest
,key
);
10860 o
= dictGetEntryVal(de
);
10862 /* Don't work with the key directly as when VM is active
10863 * this is unsafe: TODO: fix decrRefCount to check if the
10864 * count really reached 0 to avoid this mess */
10865 kcopy
= dupStringObject(key
);
10866 mixObjectDigest(digest
,kcopy
);
10867 o
= lookupKeyRead(db
,kcopy
);
10868 decrRefCount(kcopy
);
10870 aux
= htonl(o
->type
);
10871 mixDigest(digest
,&aux
,sizeof(aux
));
10872 expiretime
= getExpire(db
,key
);
10874 /* Save the key and associated value */
10875 if (o
->type
== REDIS_STRING
) {
10876 mixObjectDigest(digest
,o
);
10877 } else if (o
->type
== REDIS_LIST
) {
10878 list
*list
= o
->ptr
;
10882 listRewind(list
,&li
);
10883 while((ln
= listNext(&li
))) {
10884 robj
*eleobj
= listNodeValue(ln
);
10886 mixObjectDigest(digest
,eleobj
);
10888 } else if (o
->type
== REDIS_SET
) {
10889 dict
*set
= o
->ptr
;
10890 dictIterator
*di
= dictGetIterator(set
);
10893 while((de
= dictNext(di
)) != NULL
) {
10894 robj
*eleobj
= dictGetEntryKey(de
);
10896 xorObjectDigest(digest
,eleobj
);
10898 dictReleaseIterator(di
);
10899 } else if (o
->type
== REDIS_ZSET
) {
10901 dictIterator
*di
= dictGetIterator(zs
->dict
);
10904 while((de
= dictNext(di
)) != NULL
) {
10905 robj
*eleobj
= dictGetEntryKey(de
);
10906 double *score
= dictGetEntryVal(de
);
10907 unsigned char eledigest
[20];
10909 snprintf(buf
,sizeof(buf
),"%.17g",*score
);
10910 memset(eledigest
,0,20);
10911 mixObjectDigest(eledigest
,eleobj
);
10912 mixDigest(eledigest
,buf
,strlen(buf
));
10913 xorDigest(digest
,eledigest
,20);
10915 dictReleaseIterator(di
);
10916 } else if (o
->type
== REDIS_HASH
) {
10920 hi
= hashInitIterator(o
);
10921 while (hashNext(hi
) != REDIS_ERR
) {
10922 unsigned char eledigest
[20];
10924 memset(eledigest
,0,20);
10925 obj
= hashCurrent(hi
,REDIS_HASH_KEY
);
10926 mixObjectDigest(eledigest
,obj
);
10928 obj
= hashCurrent(hi
,REDIS_HASH_VALUE
);
10929 mixObjectDigest(eledigest
,obj
);
10931 xorDigest(digest
,eledigest
,20);
10933 hashReleaseIterator(hi
);
10935 redisPanic("Unknown object type");
10937 /* If the key has an expire, add it to the mix */
10938 if (expiretime
!= -1) xorDigest(digest
,"!!expire!!",10);
10939 /* We can finally xor the key-val digest to the final digest */
10940 xorDigest(final
,digest
,20);
10942 dictReleaseIterator(di
);
10946 static void debugCommand(redisClient
*c
) {
10947 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
10948 *((char*)-1) = 'x';
10949 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
10950 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
10951 addReply(c
,shared
.err
);
10955 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
10956 addReply(c
,shared
.err
);
10959 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
10960 addReply(c
,shared
.ok
);
10961 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
10963 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
10964 addReply(c
,shared
.err
);
10967 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
10968 addReply(c
,shared
.ok
);
10969 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
10970 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
10974 addReply(c
,shared
.nokeyerr
);
10977 key
= dictGetEntryKey(de
);
10978 val
= dictGetEntryVal(de
);
10979 if (!server
.vm_enabled
|| (key
->storage
== REDIS_VM_MEMORY
||
10980 key
->storage
== REDIS_VM_SWAPPING
)) {
10984 if (val
->encoding
< (sizeof(strencoding
)/sizeof(char*))) {
10985 strenc
= strencoding
[val
->encoding
];
10987 snprintf(buf
,64,"unknown encoding %d\n", val
->encoding
);
10990 addReplySds(c
,sdscatprintf(sdsempty(),
10991 "+Key at:%p refcount:%d, value at:%p refcount:%d "
10992 "encoding:%s serializedlength:%lld\r\n",
10993 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
10994 strenc
, (long long) rdbSavedObjectLen(val
,NULL
)));
10996 addReplySds(c
,sdscatprintf(sdsempty(),
10997 "+Key at:%p refcount:%d, value swapped at: page %llu "
10998 "using %llu pages\r\n",
10999 (void*)key
, key
->refcount
, (unsigned long long) key
->vm
.page
,
11000 (unsigned long long) key
->vm
.usedpages
));
11002 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapin") && c
->argc
== 3) {
11003 lookupKeyRead(c
->db
,c
->argv
[2]);
11004 addReply(c
,shared
.ok
);
11005 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
11006 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
11009 if (!server
.vm_enabled
) {
11010 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
11014 addReply(c
,shared
.nokeyerr
);
11017 key
= dictGetEntryKey(de
);
11018 val
= dictGetEntryVal(de
);
11019 /* If the key is shared we want to create a copy */
11020 if (key
->refcount
> 1) {
11021 robj
*newkey
= dupStringObject(key
);
11023 key
= dictGetEntryKey(de
) = newkey
;
11026 if (key
->storage
!= REDIS_VM_MEMORY
) {
11027 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
11028 } else if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
11029 dictGetEntryVal(de
) = NULL
;
11030 addReply(c
,shared
.ok
);
11032 addReply(c
,shared
.err
);
11034 } else if (!strcasecmp(c
->argv
[1]->ptr
,"populate") && c
->argc
== 3) {
11039 if (getLongFromObjectOrReply(c
, c
->argv
[2], &keys
, NULL
) != REDIS_OK
)
11041 for (j
= 0; j
< keys
; j
++) {
11042 snprintf(buf
,sizeof(buf
),"key:%lu",j
);
11043 key
= createStringObject(buf
,strlen(buf
));
11044 if (lookupKeyRead(c
->db
,key
) != NULL
) {
11048 snprintf(buf
,sizeof(buf
),"value:%lu",j
);
11049 val
= createStringObject(buf
,strlen(buf
));
11050 dictAdd(c
->db
->dict
,key
,val
);
11052 addReply(c
,shared
.ok
);
11053 } else if (!strcasecmp(c
->argv
[1]->ptr
,"digest") && c
->argc
== 2) {
11054 unsigned char digest
[20];
11055 sds d
= sdsnew("+");
11058 computeDatasetDigest(digest
);
11059 for (j
= 0; j
< 20; j
++)
11060 d
= sdscatprintf(d
, "%02x",digest
[j
]);
11062 d
= sdscatlen(d
,"\r\n",2);
11065 addReplySds(c
,sdsnew(
11066 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPIN <key>|SWAPOUT <key>|RELOAD]\r\n"));
11070 static void _redisAssert(char *estr
, char *file
, int line
) {
11071 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
11072 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true",file
,line
,estr
);
11073 #ifdef HAVE_BACKTRACE
11074 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
11075 *((char*)-1) = 'x';
11079 static void _redisPanic(char *msg
, char *file
, int line
) {
11080 redisLog(REDIS_WARNING
,"!!! Software Failure. Press left mouse button to continue");
11081 redisLog(REDIS_WARNING
,"Guru Meditation: %s #%s:%d",msg
,file
,line
);
11082 #ifdef HAVE_BACKTRACE
11083 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
11084 *((char*)-1) = 'x';
11088 /* =================================== Main! ================================ */
11091 int linuxOvercommitMemoryValue(void) {
11092 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
11095 if (!fp
) return -1;
11096 if (fgets(buf
,64,fp
) == NULL
) {
11105 void linuxOvercommitMemoryWarning(void) {
11106 if (linuxOvercommitMemoryValue() == 0) {
11107 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.");
11110 #endif /* __linux__ */
11112 static void daemonize(void) {
11116 if (fork() != 0) exit(0); /* parent exits */
11117 setsid(); /* create a new session */
11119 /* Every output goes to /dev/null. If Redis is daemonized but
11120 * the 'logfile' is set to 'stdout' in the configuration file
11121 * it will not log at all. */
11122 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
11123 dup2(fd
, STDIN_FILENO
);
11124 dup2(fd
, STDOUT_FILENO
);
11125 dup2(fd
, STDERR_FILENO
);
11126 if (fd
> STDERR_FILENO
) close(fd
);
11128 /* Try to write the pid file */
11129 fp
= fopen(server
.pidfile
,"w");
11131 fprintf(fp
,"%d\n",getpid());
11136 static void version() {
11137 printf("Redis server version %s (%s:%d)\n", REDIS_VERSION
,
11138 REDIS_GIT_SHA1
, atoi(REDIS_GIT_DIRTY
) > 0);
11142 static void usage() {
11143 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
11144 fprintf(stderr
," ./redis-server - (read config from stdin)\n");
11148 int main(int argc
, char **argv
) {
11151 initServerConfig();
11152 sortCommandTable();
11154 if (strcmp(argv
[1], "-v") == 0 ||
11155 strcmp(argv
[1], "--version") == 0) version();
11156 if (strcmp(argv
[1], "--help") == 0) usage();
11157 resetServerSaveParams();
11158 loadServerConfig(argv
[1]);
11159 } else if ((argc
> 2)) {
11162 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'");
11164 if (server
.daemonize
) daemonize();
11166 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
11168 linuxOvercommitMemoryWarning();
11170 start
= time(NULL
);
11171 if (server
.appendonly
) {
11172 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
11173 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %ld seconds",time(NULL
)-start
);
11175 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
11176 redisLog(REDIS_NOTICE
,"DB loaded from disk: %ld seconds",time(NULL
)-start
);
11178 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
11179 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
11181 aeDeleteEventLoop(server
.el
);
11185 /* ============================= Backtrace support ========================= */
11187 #ifdef HAVE_BACKTRACE
11188 static char *findFuncName(void *pointer
, unsigned long *offset
);
11190 static void *getMcontextEip(ucontext_t
*uc
) {
11191 #if defined(__FreeBSD__)
11192 return (void*) uc
->uc_mcontext
.mc_eip
;
11193 #elif defined(__dietlibc__)
11194 return (void*) uc
->uc_mcontext
.eip
;
11195 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
11197 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
11199 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
11201 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
11202 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
11203 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
11205 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
11207 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
11208 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
11209 #elif defined(__ia64__) /* Linux IA64 */
11210 return (void*) uc
->uc_mcontext
.sc_ip
;
11216 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
11218 char **messages
= NULL
;
11219 int i
, trace_size
= 0;
11220 unsigned long offset
=0;
11221 ucontext_t
*uc
= (ucontext_t
*) secret
;
11223 REDIS_NOTUSED(info
);
11225 redisLog(REDIS_WARNING
,
11226 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
11227 infostring
= genRedisInfoString();
11228 redisLog(REDIS_WARNING
, "%s",infostring
);
11229 /* It's not safe to sdsfree() the returned string under memory
11230 * corruption conditions. Let it leak as we are going to abort */
11232 trace_size
= backtrace(trace
, 100);
11233 /* overwrite sigaction with caller's address */
11234 if (getMcontextEip(uc
) != NULL
) {
11235 trace
[1] = getMcontextEip(uc
);
11237 messages
= backtrace_symbols(trace
, trace_size
);
11239 for (i
=1; i
<trace_size
; ++i
) {
11240 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
11242 p
= strchr(messages
[i
],'+');
11243 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
11244 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
11246 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
11249 /* free(messages); Don't call free() with possibly corrupted memory. */
11253 static void sigtermHandler(int sig
) {
11254 REDIS_NOTUSED(sig
);
11256 redisLog(REDIS_WARNING
,"SIGTERM received, scheduling shutting down...");
11257 server
.shutdown_asap
= 1;
11260 static void setupSigSegvAction(void) {
11261 struct sigaction act
;
11263 sigemptyset (&act
.sa_mask
);
11264 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
11265 * is used. Otherwise, sa_handler is used */
11266 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
11267 act
.sa_sigaction
= segvHandler
;
11268 sigaction (SIGSEGV
, &act
, NULL
);
11269 sigaction (SIGBUS
, &act
, NULL
);
11270 sigaction (SIGFPE
, &act
, NULL
);
11271 sigaction (SIGILL
, &act
, NULL
);
11272 sigaction (SIGBUS
, &act
, NULL
);
11274 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
;
11275 act
.sa_handler
= sigtermHandler
;
11276 sigaction (SIGTERM
, &act
, NULL
);
11280 #include "staticsymbols.h"
11281 /* This function try to convert a pointer into a function name. It's used in
11282 * oreder to provide a backtrace under segmentation fault that's able to
11283 * display functions declared as static (otherwise the backtrace is useless). */
11284 static char *findFuncName(void *pointer
, unsigned long *offset
){
11286 unsigned long off
, minoff
= 0;
11288 /* Try to match against the Symbol with the smallest offset */
11289 for (i
=0; symsTable
[i
].pointer
; i
++) {
11290 unsigned long lp
= (unsigned long) pointer
;
11292 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
11293 off
=lp
-symsTable
[i
].pointer
;
11294 if (ret
< 0 || off
< minoff
) {
11300 if (ret
== -1) return NULL
;
11302 return symsTable
[ret
].name
;
11304 #else /* HAVE_BACKTRACE */
11305 static void setupSigSegvAction(void) {
11307 #endif /* HAVE_BACKTRACE */