2 * Copyright (c) 2009-2010, Salvatore Sanfilippo <antirez at gmail dot com>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
8 * * Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * * Neither the name of Redis nor the names of its contributors may be used
14 * to endorse or promote products derived from this software without
15 * specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 * POSSIBILITY OF SUCH DAMAGE.
30 #define REDIS_VERSION "1.3.8"
40 #define __USE_POSIX199309
47 #endif /* HAVE_BACKTRACE */
55 #include <arpa/inet.h>
59 #include <sys/resource.h>
66 #include "solarisfixes.h"
70 #include "ae.h" /* Event driven programming library */
71 #include "sds.h" /* Dynamic safe strings */
72 #include "anet.h" /* Networking the easy way */
73 #include "dict.h" /* Hash tables */
74 #include "adlist.h" /* Linked lists */
75 #include "zmalloc.h" /* total memory usage aware version of malloc/free */
76 #include "lzf.h" /* LZF compression library */
77 #include "pqsort.h" /* Partial qsort for SORT+LIMIT */
84 /* Static server configuration */
85 #define REDIS_SERVERPORT 6379 /* TCP port */
86 #define REDIS_MAXIDLETIME (60*5) /* default client timeout */
87 #define REDIS_IOBUF_LEN 1024
88 #define REDIS_LOADBUF_LEN 1024
89 #define REDIS_STATIC_ARGS 8
90 #define REDIS_DEFAULT_DBNUM 16
91 #define REDIS_CONFIGLINE_MAX 1024
92 #define REDIS_OBJFREELIST_MAX 1000000 /* Max number of objects to cache */
93 #define REDIS_MAX_SYNC_TIME 60 /* Slave can't take more to sync */
94 #define REDIS_EXPIRELOOKUPS_PER_CRON 10 /* lookup 10 expires per loop */
95 #define REDIS_MAX_WRITE_PER_EVENT (1024*64)
96 #define REDIS_REQUEST_MAX_SIZE (1024*1024*256) /* max bytes in inline command */
98 /* If more then REDIS_WRITEV_THRESHOLD write packets are pending use writev */
99 #define REDIS_WRITEV_THRESHOLD 3
100 /* Max number of iovecs used for each writev call */
101 #define REDIS_WRITEV_IOVEC_COUNT 256
103 /* Hash table parameters */
104 #define REDIS_HT_MINFILL 10 /* Minimal hash table fill 10% */
107 #define REDIS_CMD_BULK 1 /* Bulk write command */
108 #define REDIS_CMD_INLINE 2 /* Inline command */
109 /* REDIS_CMD_DENYOOM reserves a longer comment: all the commands marked with
110 this flags will return an error when the 'maxmemory' option is set in the
111 config file and the server is using more than maxmemory bytes of memory.
112 In short this commands are denied on low memory conditions. */
113 #define REDIS_CMD_DENYOOM 4
114 #define REDIS_CMD_FORCE_REPLICATION 8 /* Force replication even if dirty is 0 */
117 #define REDIS_STRING 0
123 /* Objects encoding. Some kind of objects like Strings and Hashes can be
124 * internally represented in multiple ways. The 'encoding' field of the object
125 * is set to one of this fields for this object. */
126 #define REDIS_ENCODING_RAW 0 /* Raw representation */
127 #define REDIS_ENCODING_INT 1 /* Encoded as integer */
128 #define REDIS_ENCODING_ZIPMAP 2 /* Encoded as zipmap */
129 #define REDIS_ENCODING_HT 3 /* Encoded as an hash table */
131 static char* strencoding
[] = {
132 "raw", "int", "zipmap", "hashtable"
135 /* Object types only used for dumping to disk */
136 #define REDIS_EXPIRETIME 253
137 #define REDIS_SELECTDB 254
138 #define REDIS_EOF 255
140 /* Defines related to the dump file format. To store 32 bits lengths for short
141 * keys requires a lot of space, so we check the most significant 2 bits of
142 * the first byte to interpreter the length:
144 * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
145 * 01|000000 00000000 => 01, the len is 14 byes, 6 bits + 8 bits of next byte
146 * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
147 * 11|000000 this means: specially encoded object will follow. The six bits
148 * number specify the kind of object that follows.
149 * See the REDIS_RDB_ENC_* defines.
151 * Lenghts up to 63 are stored using a single byte, most DB keys, and may
152 * values, will fit inside. */
153 #define REDIS_RDB_6BITLEN 0
154 #define REDIS_RDB_14BITLEN 1
155 #define REDIS_RDB_32BITLEN 2
156 #define REDIS_RDB_ENCVAL 3
157 #define REDIS_RDB_LENERR UINT_MAX
159 /* When a length of a string object stored on disk has the first two bits
160 * set, the remaining two bits specify a special encoding for the object
161 * accordingly to the following defines: */
162 #define REDIS_RDB_ENC_INT8 0 /* 8 bit signed integer */
163 #define REDIS_RDB_ENC_INT16 1 /* 16 bit signed integer */
164 #define REDIS_RDB_ENC_INT32 2 /* 32 bit signed integer */
165 #define REDIS_RDB_ENC_LZF 3 /* string compressed with FASTLZ */
167 /* Virtual memory object->where field. */
168 #define REDIS_VM_MEMORY 0 /* The object is on memory */
169 #define REDIS_VM_SWAPPED 1 /* The object is on disk */
170 #define REDIS_VM_SWAPPING 2 /* Redis is swapping this object on disk */
171 #define REDIS_VM_LOADING 3 /* Redis is loading this object from disk */
173 /* Virtual memory static configuration stuff.
174 * Check vmFindContiguousPages() to know more about this magic numbers. */
175 #define REDIS_VM_MAX_NEAR_PAGES 65536
176 #define REDIS_VM_MAX_RANDOM_JUMP 4096
177 #define REDIS_VM_MAX_THREADS 32
178 #define REDIS_THREAD_STACK_SIZE (1024*1024*4)
179 /* The following is the *percentage* of completed I/O jobs to process when the
180 * handelr is called. While Virtual Memory I/O operations are performed by
181 * threads, this operations must be processed by the main thread when completed
182 * in order to take effect. */
183 #define REDIS_MAX_COMPLETED_JOBS_PROCESSED 1
186 #define REDIS_SLAVE 1 /* This client is a slave server */
187 #define REDIS_MASTER 2 /* This client is a master server */
188 #define REDIS_MONITOR 4 /* This client is a slave monitor, see MONITOR */
189 #define REDIS_MULTI 8 /* This client is in a MULTI context */
190 #define REDIS_BLOCKED 16 /* The client is waiting in a blocking operation */
191 #define REDIS_IO_WAIT 32 /* The client is waiting for Virtual Memory I/O */
193 /* Slave replication state - slave side */
194 #define REDIS_REPL_NONE 0 /* No active replication */
195 #define REDIS_REPL_CONNECT 1 /* Must connect to master */
196 #define REDIS_REPL_CONNECTED 2 /* Connected to master */
198 /* Slave replication state - from the point of view of master
199 * Note that in SEND_BULK and ONLINE state the slave receives new updates
200 * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
201 * to start the next background saving in order to send updates to it. */
202 #define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
203 #define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
204 #define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
205 #define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
207 /* List related stuff */
211 /* Sort operations */
212 #define REDIS_SORT_GET 0
213 #define REDIS_SORT_ASC 1
214 #define REDIS_SORT_DESC 2
215 #define REDIS_SORTKEY_MAX 1024
218 #define REDIS_DEBUG 0
219 #define REDIS_VERBOSE 1
220 #define REDIS_NOTICE 2
221 #define REDIS_WARNING 3
223 /* Anti-warning macro... */
224 #define REDIS_NOTUSED(V) ((void) V)
226 #define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
227 #define ZSKIPLIST_P 0.25 /* Skiplist P = 1/4 */
229 /* Append only defines */
230 #define APPENDFSYNC_NO 0
231 #define APPENDFSYNC_ALWAYS 1
232 #define APPENDFSYNC_EVERYSEC 2
234 /* Hashes related defaults */
235 #define REDIS_HASH_MAX_ZIPMAP_ENTRIES 64
236 #define REDIS_HASH_MAX_ZIPMAP_VALUE 512
238 /* We can print the stacktrace, so our assert is defined this way: */
239 #define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
240 static void _redisAssert(char *estr
, char *file
, int line
);
242 /*================================= Data types ============================== */
244 /* A redis object, that is a type able to hold a string / list / set */
246 /* The VM object structure */
247 struct redisObjectVM
{
248 off_t page
; /* the page at witch the object is stored on disk */
249 off_t usedpages
; /* number of pages used on disk */
250 time_t atime
; /* Last access time */
253 /* The actual Redis Object */
254 typedef struct redisObject
{
257 unsigned char encoding
;
258 unsigned char storage
; /* If this object is a key, where is the value?
259 * REDIS_VM_MEMORY, REDIS_VM_SWAPPED, ... */
260 unsigned char vtype
; /* If this object is a key, and value is swapped out,
261 * this is the type of the swapped out object. */
263 /* VM fields, this are only allocated if VM is active, otherwise the
264 * object allocation function will just allocate
265 * sizeof(redisObjct) minus sizeof(redisObjectVM), so using
266 * Redis without VM active will not have any overhead. */
267 struct redisObjectVM vm
;
270 /* Macro used to initalize a Redis object allocated on the stack.
271 * Note that this macro is taken near the structure definition to make sure
272 * we'll update it when the structure is changed, to avoid bugs like
273 * bug #85 introduced exactly in this way. */
274 #define initStaticStringObject(_var,_ptr) do { \
276 _var.type = REDIS_STRING; \
277 _var.encoding = REDIS_ENCODING_RAW; \
279 if (server.vm_enabled) _var.storage = REDIS_VM_MEMORY; \
282 typedef struct redisDb
{
283 dict
*dict
; /* The keyspace for this DB */
284 dict
*expires
; /* Timeout of keys with a timeout set */
285 dict
*blockingkeys
; /* Keys with clients waiting for data (BLPOP) */
286 dict
*io_keys
; /* Keys with clients waiting for VM I/O */
290 /* Client MULTI/EXEC state */
291 typedef struct multiCmd
{
294 struct redisCommand
*cmd
;
297 typedef struct multiState
{
298 multiCmd
*commands
; /* Array of MULTI commands */
299 int count
; /* Total number of MULTI commands */
302 /* With multiplexing we need to take per-clinet state.
303 * Clients are taken in a liked list. */
304 typedef struct redisClient
{
309 robj
**argv
, **mbargv
;
311 int bulklen
; /* bulk read len. -1 if not in bulk read mode */
312 int multibulk
; /* multi bulk command format active */
315 time_t lastinteraction
; /* time of the last interaction, used for timeout */
316 int flags
; /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
317 int slaveseldb
; /* slave selected db, if this client is a slave */
318 int authenticated
; /* when requirepass is non-NULL */
319 int replstate
; /* replication state if this is a slave */
320 int repldbfd
; /* replication DB file descriptor */
321 long repldboff
; /* replication DB file offset */
322 off_t repldbsize
; /* replication DB file size */
323 multiState mstate
; /* MULTI/EXEC state */
324 robj
**blockingkeys
; /* The key we are waiting to terminate a blocking
325 * operation such as BLPOP. Otherwise NULL. */
326 int blockingkeysnum
; /* Number of blocking keys */
327 time_t blockingto
; /* Blocking operation timeout. If UNIX current time
328 * is >= blockingto then the operation timed out. */
329 list
*io_keys
; /* Keys this client is waiting to be loaded from the
330 * swap file in order to continue. */
331 dict
*pubsub_channels
; /* channels a client is interested in (SUBSCRIBE) */
332 list
*pubsub_patterns
; /* patterns a client is interested in (SUBSCRIBE) */
340 /* Global server state structure */
345 long long dirty
; /* changes to DB from the last save */
347 list
*slaves
, *monitors
;
348 char neterr
[ANET_ERR_LEN
];
350 int cronloops
; /* number of times the cron function run */
351 list
*objfreelist
; /* A list of freed objects to avoid malloc() */
352 time_t lastsave
; /* Unix time of last save succeeede */
353 /* Fields used only for stats */
354 time_t stat_starttime
; /* server start time */
355 long long stat_numcommands
; /* number of processed commands */
356 long long stat_numconnections
; /* number of connections received */
357 long long stat_expiredkeys
; /* number of expired keys */
370 pid_t bgsavechildpid
;
371 pid_t bgrewritechildpid
;
372 sds bgrewritebuf
; /* buffer taken by parent during oppend only rewrite */
373 struct saveparam
*saveparams
;
378 char *appendfilename
;
383 /* Replication related */
388 redisClient
*master
; /* client that is master for this slave */
390 unsigned int maxclients
;
391 unsigned long long maxmemory
;
392 unsigned int blpop_blocked_clients
;
393 unsigned int vm_blocked_clients
;
394 /* Sort parameters - qsort_r() is only available under BSD so we
395 * have to take this state global, in order to pass it to sortCompare() */
399 /* Virtual memory configuration */
404 unsigned long long vm_max_memory
;
406 size_t hash_max_zipmap_entries
;
407 size_t hash_max_zipmap_value
;
408 /* Virtual memory state */
411 off_t vm_next_page
; /* Next probably empty page */
412 off_t vm_near_pages
; /* Number of pages allocated sequentially */
413 unsigned char *vm_bitmap
; /* Bitmap of free/used pages */
414 time_t unixtime
; /* Unix time sampled every second. */
415 /* Virtual memory I/O threads stuff */
416 /* An I/O thread process an element taken from the io_jobs queue and
417 * put the result of the operation in the io_done list. While the
418 * job is being processed, it's put on io_processing queue. */
419 list
*io_newjobs
; /* List of VM I/O jobs yet to be processed */
420 list
*io_processing
; /* List of VM I/O jobs being processed */
421 list
*io_processed
; /* List of VM I/O jobs already processed */
422 list
*io_ready_clients
; /* Clients ready to be unblocked. All keys loaded */
423 pthread_mutex_t io_mutex
; /* lock to access io_jobs/io_done/io_thread_job */
424 pthread_mutex_t obj_freelist_mutex
; /* safe redis objects creation/free */
425 pthread_mutex_t io_swapfile_mutex
; /* So we can lseek + write */
426 pthread_attr_t io_threads_attr
; /* attributes for threads creation */
427 int io_active_threads
; /* Number of running I/O threads */
428 int vm_max_threads
; /* Max number of I/O threads running at the same time */
429 /* Our main thread is blocked on the event loop, locking for sockets ready
430 * to be read or written, so when a threaded I/O operation is ready to be
431 * processed by the main thread, the I/O thread will use a unix pipe to
432 * awake the main thread. The followings are the two pipe FDs. */
433 int io_ready_pipe_read
;
434 int io_ready_pipe_write
;
435 /* Virtual memory stats */
436 unsigned long long vm_stats_used_pages
;
437 unsigned long long vm_stats_swapped_objects
;
438 unsigned long long vm_stats_swapouts
;
439 unsigned long long vm_stats_swapins
;
441 dict
*pubsub_channels
; /* Map channels to list of subscribed clients */
442 list
*pubsub_patterns
; /* A list of pubsub_patterns */
447 typedef struct pubsubPattern
{
452 typedef void redisCommandProc(redisClient
*c
);
453 struct redisCommand
{
455 redisCommandProc
*proc
;
458 /* Use a function to determine which keys need to be loaded
459 * in the background prior to executing this command. Takes precedence
460 * over vm_firstkey and others, ignored when NULL */
461 redisCommandProc
*vm_preload_proc
;
462 /* What keys should be loaded in background when calling this command? */
463 int vm_firstkey
; /* The first argument that's a key (0 = no keys) */
464 int vm_lastkey
; /* THe last argument that's a key */
465 int vm_keystep
; /* The step between first and last key */
468 struct redisFunctionSym
{
470 unsigned long pointer
;
473 typedef struct _redisSortObject
{
481 typedef struct _redisSortOperation
{
484 } redisSortOperation
;
486 /* ZSETs use a specialized version of Skiplists */
488 typedef struct zskiplistNode
{
489 struct zskiplistNode
**forward
;
490 struct zskiplistNode
*backward
;
496 typedef struct zskiplist
{
497 struct zskiplistNode
*header
, *tail
;
498 unsigned long length
;
502 typedef struct zset
{
507 /* Our shared "common" objects */
509 #define REDIS_SHARED_INTEGERS 10000
510 struct sharedObjectsStruct
{
511 robj
*crlf
, *ok
, *err
, *emptybulk
, *czero
, *cone
, *pong
, *space
,
512 *colon
, *nullbulk
, *nullmultibulk
, *queued
,
513 *emptymultibulk
, *wrongtypeerr
, *nokeyerr
, *syntaxerr
, *sameobjecterr
,
514 *outofrangeerr
, *plus
,
515 *select0
, *select1
, *select2
, *select3
, *select4
,
516 *select5
, *select6
, *select7
, *select8
, *select9
,
517 *messagebulk
, *subscribebulk
, *unsubscribebulk
, *mbulk3
,
518 *psubscribebulk
, *punsubscribebulk
, *integers
[REDIS_SHARED_INTEGERS
];
521 /* Global vars that are actally used as constants. The following double
522 * values are used for double on-disk serialization, and are initialized
523 * at runtime to avoid strange compiler optimizations. */
525 static double R_Zero
, R_PosInf
, R_NegInf
, R_Nan
;
527 /* VM threaded I/O request message */
528 #define REDIS_IOJOB_LOAD 0 /* Load from disk to memory */
529 #define REDIS_IOJOB_PREPARE_SWAP 1 /* Compute needed pages */
530 #define REDIS_IOJOB_DO_SWAP 2 /* Swap from memory to disk */
531 typedef struct iojob
{
532 int type
; /* Request type, REDIS_IOJOB_* */
533 redisDb
*db
;/* Redis database */
534 robj
*key
; /* This I/O request is about swapping this key */
535 robj
*val
; /* the value to swap for REDIS_IOREQ_*_SWAP, otherwise this
536 * field is populated by the I/O thread for REDIS_IOREQ_LOAD. */
537 off_t page
; /* Swap page where to read/write the object */
538 off_t pages
; /* Swap pages needed to save object. PREPARE_SWAP return val */
539 int canceled
; /* True if this command was canceled by blocking side of VM */
540 pthread_t thread
; /* ID of the thread processing this entry */
543 /*================================ Prototypes =============================== */
545 static void freeStringObject(robj
*o
);
546 static void freeListObject(robj
*o
);
547 static void freeSetObject(robj
*o
);
548 static void decrRefCount(void *o
);
549 static robj
*createObject(int type
, void *ptr
);
550 static void freeClient(redisClient
*c
);
551 static int rdbLoad(char *filename
);
552 static void addReply(redisClient
*c
, robj
*obj
);
553 static void addReplySds(redisClient
*c
, sds s
);
554 static void incrRefCount(robj
*o
);
555 static int rdbSaveBackground(char *filename
);
556 static robj
*createStringObject(char *ptr
, size_t len
);
557 static robj
*dupStringObject(robj
*o
);
558 static void replicationFeedSlaves(list
*slaves
, int dictid
, robj
**argv
, int argc
);
559 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
560 static int syncWithMaster(void);
561 static robj
*tryObjectEncoding(robj
*o
);
562 static robj
*getDecodedObject(robj
*o
);
563 static int removeExpire(redisDb
*db
, robj
*key
);
564 static int expireIfNeeded(redisDb
*db
, robj
*key
);
565 static int deleteIfVolatile(redisDb
*db
, robj
*key
);
566 static int deleteIfSwapped(redisDb
*db
, robj
*key
);
567 static int deleteKey(redisDb
*db
, robj
*key
);
568 static time_t getExpire(redisDb
*db
, robj
*key
);
569 static int setExpire(redisDb
*db
, robj
*key
, time_t when
);
570 static void updateSlavesWaitingBgsave(int bgsaveerr
);
571 static void freeMemoryIfNeeded(void);
572 static int processCommand(redisClient
*c
);
573 static void setupSigSegvAction(void);
574 static void rdbRemoveTempFile(pid_t childpid
);
575 static void aofRemoveTempFile(pid_t childpid
);
576 static size_t stringObjectLen(robj
*o
);
577 static void processInputBuffer(redisClient
*c
);
578 static zskiplist
*zslCreate(void);
579 static void zslFree(zskiplist
*zsl
);
580 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
);
581 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
582 static void initClientMultiState(redisClient
*c
);
583 static void freeClientMultiState(redisClient
*c
);
584 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
);
585 static void unblockClientWaitingData(redisClient
*c
);
586 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
);
587 static void vmInit(void);
588 static void vmMarkPagesFree(off_t page
, off_t count
);
589 static robj
*vmLoadObject(robj
*key
);
590 static robj
*vmPreviewObject(robj
*key
);
591 static int vmSwapOneObjectBlocking(void);
592 static int vmSwapOneObjectThreaded(void);
593 static int vmCanSwapOut(void);
594 static int tryFreeOneObjectFromFreelist(void);
595 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
596 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
597 static void vmCancelThreadedIOJob(robj
*o
);
598 static void lockThreadedIO(void);
599 static void unlockThreadedIO(void);
600 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
);
601 static void freeIOJob(iojob
*j
);
602 static void queueIOJob(iojob
*j
);
603 static int vmWriteObjectOnSwap(robj
*o
, off_t page
);
604 static robj
*vmReadObjectFromSwap(off_t page
, int type
);
605 static void waitEmptyIOJobsQueue(void);
606 static void vmReopenSwapFile(void);
607 static int vmFreePage(off_t page
);
608 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
);
609 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
);
610 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
);
611 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
);
612 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
613 static struct redisCommand
*lookupCommand(char *name
);
614 static void call(redisClient
*c
, struct redisCommand
*cmd
);
615 static void resetClient(redisClient
*c
);
616 static void convertToRealHash(robj
*o
);
617 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
);
618 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
);
619 static void freePubsubPattern(void *p
);
620 static int listMatchPubsubPattern(void *a
, void *b
);
621 static int compareStringObjects(robj
*a
, robj
*b
);
624 static void authCommand(redisClient
*c
);
625 static void pingCommand(redisClient
*c
);
626 static void echoCommand(redisClient
*c
);
627 static void setCommand(redisClient
*c
);
628 static void setnxCommand(redisClient
*c
);
629 static void getCommand(redisClient
*c
);
630 static void delCommand(redisClient
*c
);
631 static void existsCommand(redisClient
*c
);
632 static void incrCommand(redisClient
*c
);
633 static void decrCommand(redisClient
*c
);
634 static void incrbyCommand(redisClient
*c
);
635 static void decrbyCommand(redisClient
*c
);
636 static void selectCommand(redisClient
*c
);
637 static void randomkeyCommand(redisClient
*c
);
638 static void keysCommand(redisClient
*c
);
639 static void dbsizeCommand(redisClient
*c
);
640 static void lastsaveCommand(redisClient
*c
);
641 static void saveCommand(redisClient
*c
);
642 static void bgsaveCommand(redisClient
*c
);
643 static void bgrewriteaofCommand(redisClient
*c
);
644 static void shutdownCommand(redisClient
*c
);
645 static void moveCommand(redisClient
*c
);
646 static void renameCommand(redisClient
*c
);
647 static void renamenxCommand(redisClient
*c
);
648 static void lpushCommand(redisClient
*c
);
649 static void rpushCommand(redisClient
*c
);
650 static void lpopCommand(redisClient
*c
);
651 static void rpopCommand(redisClient
*c
);
652 static void llenCommand(redisClient
*c
);
653 static void lindexCommand(redisClient
*c
);
654 static void lrangeCommand(redisClient
*c
);
655 static void ltrimCommand(redisClient
*c
);
656 static void typeCommand(redisClient
*c
);
657 static void lsetCommand(redisClient
*c
);
658 static void saddCommand(redisClient
*c
);
659 static void sremCommand(redisClient
*c
);
660 static void smoveCommand(redisClient
*c
);
661 static void sismemberCommand(redisClient
*c
);
662 static void scardCommand(redisClient
*c
);
663 static void spopCommand(redisClient
*c
);
664 static void srandmemberCommand(redisClient
*c
);
665 static void sinterCommand(redisClient
*c
);
666 static void sinterstoreCommand(redisClient
*c
);
667 static void sunionCommand(redisClient
*c
);
668 static void sunionstoreCommand(redisClient
*c
);
669 static void sdiffCommand(redisClient
*c
);
670 static void sdiffstoreCommand(redisClient
*c
);
671 static void syncCommand(redisClient
*c
);
672 static void flushdbCommand(redisClient
*c
);
673 static void flushallCommand(redisClient
*c
);
674 static void sortCommand(redisClient
*c
);
675 static void lremCommand(redisClient
*c
);
676 static void rpoplpushcommand(redisClient
*c
);
677 static void infoCommand(redisClient
*c
);
678 static void mgetCommand(redisClient
*c
);
679 static void monitorCommand(redisClient
*c
);
680 static void expireCommand(redisClient
*c
);
681 static void expireatCommand(redisClient
*c
);
682 static void getsetCommand(redisClient
*c
);
683 static void ttlCommand(redisClient
*c
);
684 static void slaveofCommand(redisClient
*c
);
685 static void debugCommand(redisClient
*c
);
686 static void msetCommand(redisClient
*c
);
687 static void msetnxCommand(redisClient
*c
);
688 static void zaddCommand(redisClient
*c
);
689 static void zincrbyCommand(redisClient
*c
);
690 static void zrangeCommand(redisClient
*c
);
691 static void zrangebyscoreCommand(redisClient
*c
);
692 static void zcountCommand(redisClient
*c
);
693 static void zrevrangeCommand(redisClient
*c
);
694 static void zcardCommand(redisClient
*c
);
695 static void zremCommand(redisClient
*c
);
696 static void zscoreCommand(redisClient
*c
);
697 static void zremrangebyscoreCommand(redisClient
*c
);
698 static void multiCommand(redisClient
*c
);
699 static void execCommand(redisClient
*c
);
700 static void discardCommand(redisClient
*c
);
701 static void blpopCommand(redisClient
*c
);
702 static void brpopCommand(redisClient
*c
);
703 static void appendCommand(redisClient
*c
);
704 static void substrCommand(redisClient
*c
);
705 static void zrankCommand(redisClient
*c
);
706 static void zrevrankCommand(redisClient
*c
);
707 static void hsetCommand(redisClient
*c
);
708 static void hsetnxCommand(redisClient
*c
);
709 static void hgetCommand(redisClient
*c
);
710 static void hmsetCommand(redisClient
*c
);
711 static void hmgetCommand(redisClient
*c
);
712 static void hdelCommand(redisClient
*c
);
713 static void hlenCommand(redisClient
*c
);
714 static void zremrangebyrankCommand(redisClient
*c
);
715 static void zunionCommand(redisClient
*c
);
716 static void zinterCommand(redisClient
*c
);
717 static void hkeysCommand(redisClient
*c
);
718 static void hvalsCommand(redisClient
*c
);
719 static void hgetallCommand(redisClient
*c
);
720 static void hexistsCommand(redisClient
*c
);
721 static void configCommand(redisClient
*c
);
722 static void hincrbyCommand(redisClient
*c
);
723 static void subscribeCommand(redisClient
*c
);
724 static void unsubscribeCommand(redisClient
*c
);
725 static void psubscribeCommand(redisClient
*c
);
726 static void punsubscribeCommand(redisClient
*c
);
727 static void publishCommand(redisClient
*c
);
729 /*================================= Globals ================================= */
732 static struct redisServer server
; /* server global state */
733 static struct redisCommand cmdTable
[] = {
734 {"get",getCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
735 {"set",setCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
736 {"setnx",setnxCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
737 {"append",appendCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
738 {"substr",substrCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
739 {"del",delCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
740 {"exists",existsCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
741 {"incr",incrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
742 {"decr",decrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
743 {"mget",mgetCommand
,-2,REDIS_CMD_INLINE
,NULL
,1,-1,1},
744 {"rpush",rpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
745 {"lpush",lpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
746 {"rpop",rpopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
747 {"lpop",lpopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
748 {"brpop",brpopCommand
,-3,REDIS_CMD_INLINE
,NULL
,1,1,1},
749 {"blpop",blpopCommand
,-3,REDIS_CMD_INLINE
,NULL
,1,1,1},
750 {"llen",llenCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
751 {"lindex",lindexCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
752 {"lset",lsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
753 {"lrange",lrangeCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
754 {"ltrim",ltrimCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
755 {"lrem",lremCommand
,4,REDIS_CMD_BULK
,NULL
,1,1,1},
756 {"rpoplpush",rpoplpushcommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,2,1},
757 {"sadd",saddCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
758 {"srem",sremCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
759 {"smove",smoveCommand
,4,REDIS_CMD_BULK
,NULL
,1,2,1},
760 {"sismember",sismemberCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
761 {"scard",scardCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
762 {"spop",spopCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
763 {"srandmember",srandmemberCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
764 {"sinter",sinterCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
765 {"sinterstore",sinterstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
766 {"sunion",sunionCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
767 {"sunionstore",sunionstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
768 {"sdiff",sdiffCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,-1,1},
769 {"sdiffstore",sdiffstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,2,-1,1},
770 {"smembers",sinterCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
771 {"zadd",zaddCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
772 {"zincrby",zincrbyCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
773 {"zrem",zremCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
774 {"zremrangebyscore",zremrangebyscoreCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
775 {"zremrangebyrank",zremrangebyrankCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
776 {"zunion",zunionCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,zunionInterBlockClientOnSwappedKeys
,0,0,0},
777 {"zinter",zinterCommand
,-4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,zunionInterBlockClientOnSwappedKeys
,0,0,0},
778 {"zrange",zrangeCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
779 {"zrangebyscore",zrangebyscoreCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
780 {"zcount",zcountCommand
,4,REDIS_CMD_INLINE
,NULL
,1,1,1},
781 {"zrevrange",zrevrangeCommand
,-4,REDIS_CMD_INLINE
,NULL
,1,1,1},
782 {"zcard",zcardCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
783 {"zscore",zscoreCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
784 {"zrank",zrankCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
785 {"zrevrank",zrevrankCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
786 {"hset",hsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
787 {"hsetnx",hsetnxCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
788 {"hget",hgetCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
789 {"hmset",hmsetCommand
,-4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
790 {"hmget",hmgetCommand
,-3,REDIS_CMD_BULK
,NULL
,1,1,1},
791 {"hincrby",hincrbyCommand
,4,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
792 {"hdel",hdelCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
793 {"hlen",hlenCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
794 {"hkeys",hkeysCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
795 {"hvals",hvalsCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
796 {"hgetall",hgetallCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
797 {"hexists",hexistsCommand
,3,REDIS_CMD_BULK
,NULL
,1,1,1},
798 {"incrby",incrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
799 {"decrby",decrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
800 {"getset",getsetCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
801 {"mset",msetCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,-1,2},
802 {"msetnx",msetnxCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,NULL
,1,-1,2},
803 {"randomkey",randomkeyCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
804 {"select",selectCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
805 {"move",moveCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
806 {"rename",renameCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
807 {"renamenx",renamenxCommand
,3,REDIS_CMD_INLINE
,NULL
,1,1,1},
808 {"expire",expireCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
809 {"expireat",expireatCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
810 {"keys",keysCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
811 {"dbsize",dbsizeCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
812 {"auth",authCommand
,2,REDIS_CMD_INLINE
,NULL
,0,0,0},
813 {"ping",pingCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
814 {"echo",echoCommand
,2,REDIS_CMD_BULK
,NULL
,0,0,0},
815 {"save",saveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
816 {"bgsave",bgsaveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
817 {"bgrewriteaof",bgrewriteaofCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
818 {"shutdown",shutdownCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
819 {"lastsave",lastsaveCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
820 {"type",typeCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
821 {"multi",multiCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
822 {"exec",execCommand
,1,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,0,0,0},
823 {"discard",discardCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
824 {"sync",syncCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
825 {"flushdb",flushdbCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
826 {"flushall",flushallCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
827 {"sort",sortCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,NULL
,1,1,1},
828 {"info",infoCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
829 {"monitor",monitorCommand
,1,REDIS_CMD_INLINE
,NULL
,0,0,0},
830 {"ttl",ttlCommand
,2,REDIS_CMD_INLINE
,NULL
,1,1,1},
831 {"slaveof",slaveofCommand
,3,REDIS_CMD_INLINE
,NULL
,0,0,0},
832 {"debug",debugCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
833 {"config",configCommand
,-2,REDIS_CMD_BULK
,NULL
,0,0,0},
834 {"subscribe",subscribeCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
835 {"unsubscribe",unsubscribeCommand
,-1,REDIS_CMD_INLINE
,NULL
,0,0,0},
836 {"psubscribe",psubscribeCommand
,-2,REDIS_CMD_INLINE
,NULL
,0,0,0},
837 {"punsubscribe",punsubscribeCommand
,-1,REDIS_CMD_INLINE
,NULL
,0,0,0},
838 {"publish",publishCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_FORCE_REPLICATION
,NULL
,0,0,0},
839 {NULL
,NULL
,0,0,NULL
,0,0,0}
842 /*============================ Utility functions ============================ */
844 /* Glob-style pattern matching. */
845 static int stringmatchlen(const char *pattern
, int patternLen
,
846 const char *string
, int stringLen
, int nocase
)
851 while (pattern
[1] == '*') {
856 return 1; /* match */
858 if (stringmatchlen(pattern
+1, patternLen
-1,
859 string
, stringLen
, nocase
))
860 return 1; /* match */
864 return 0; /* no match */
868 return 0; /* no match */
878 not = pattern
[0] == '^';
885 if (pattern
[0] == '\\') {
888 if (pattern
[0] == string
[0])
890 } else if (pattern
[0] == ']') {
892 } else if (patternLen
== 0) {
896 } else if (pattern
[1] == '-' && patternLen
>= 3) {
897 int start
= pattern
[0];
898 int end
= pattern
[2];
906 start
= tolower(start
);
912 if (c
>= start
&& c
<= end
)
916 if (pattern
[0] == string
[0])
919 if (tolower((int)pattern
[0]) == tolower((int)string
[0]))
929 return 0; /* no match */
935 if (patternLen
>= 2) {
942 if (pattern
[0] != string
[0])
943 return 0; /* no match */
945 if (tolower((int)pattern
[0]) != tolower((int)string
[0]))
946 return 0; /* no match */
954 if (stringLen
== 0) {
955 while(*pattern
== '*') {
962 if (patternLen
== 0 && stringLen
== 0)
967 static int stringmatch(const char *pattern
, const char *string
, int nocase
) {
968 return stringmatchlen(pattern
,strlen(pattern
),string
,strlen(string
),nocase
);
971 static void redisLog(int level
, const char *fmt
, ...) {
975 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
979 if (level
>= server
.verbosity
) {
985 strftime(buf
,64,"%d %b %H:%M:%S",localtime(&now
));
986 fprintf(fp
,"[%d] %s %c ",(int)getpid(),buf
,c
[level
]);
987 vfprintf(fp
, fmt
, ap
);
993 if (server
.logfile
) fclose(fp
);
996 /*====================== Hash table type implementation ==================== */
998 /* This is an hash table type that uses the SDS dynamic strings libary as
999 * keys and radis objects as values (objects can hold SDS strings,
1002 static void dictVanillaFree(void *privdata
, void *val
)
1004 DICT_NOTUSED(privdata
);
1008 static void dictListDestructor(void *privdata
, void *val
)
1010 DICT_NOTUSED(privdata
);
1011 listRelease((list
*)val
);
1014 static int sdsDictKeyCompare(void *privdata
, const void *key1
,
1018 DICT_NOTUSED(privdata
);
1020 l1
= sdslen((sds
)key1
);
1021 l2
= sdslen((sds
)key2
);
1022 if (l1
!= l2
) return 0;
1023 return memcmp(key1
, key2
, l1
) == 0;
1026 static void dictRedisObjectDestructor(void *privdata
, void *val
)
1028 DICT_NOTUSED(privdata
);
1030 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
1034 static int dictObjKeyCompare(void *privdata
, const void *key1
,
1037 const robj
*o1
= key1
, *o2
= key2
;
1038 return sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1041 static unsigned int dictObjHash(const void *key
) {
1042 const robj
*o
= key
;
1043 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1046 static int dictEncObjKeyCompare(void *privdata
, const void *key1
,
1049 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
1052 if (o1
->encoding
== REDIS_ENCODING_INT
&&
1053 o2
->encoding
== REDIS_ENCODING_INT
&&
1054 o1
->ptr
== o2
->ptr
) return 1;
1056 o1
= getDecodedObject(o1
);
1057 o2
= getDecodedObject(o2
);
1058 cmp
= sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
1064 static unsigned int dictEncObjHash(const void *key
) {
1065 robj
*o
= (robj
*) key
;
1067 if (o
->encoding
== REDIS_ENCODING_RAW
) {
1068 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1070 if (o
->encoding
== REDIS_ENCODING_INT
) {
1074 len
= snprintf(buf
,32,"%ld",(long)o
->ptr
);
1075 return dictGenHashFunction((unsigned char*)buf
, len
);
1079 o
= getDecodedObject(o
);
1080 hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
1087 /* Sets type and expires */
1088 static dictType setDictType
= {
1089 dictEncObjHash
, /* hash function */
1092 dictEncObjKeyCompare
, /* key compare */
1093 dictRedisObjectDestructor
, /* key destructor */
1094 NULL
/* val destructor */
1097 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
1098 static dictType zsetDictType
= {
1099 dictEncObjHash
, /* hash function */
1102 dictEncObjKeyCompare
, /* key compare */
1103 dictRedisObjectDestructor
, /* key destructor */
1104 dictVanillaFree
/* val destructor of malloc(sizeof(double)) */
1108 static dictType dbDictType
= {
1109 dictObjHash
, /* hash function */
1112 dictObjKeyCompare
, /* key compare */
1113 dictRedisObjectDestructor
, /* key destructor */
1114 dictRedisObjectDestructor
/* val destructor */
1118 static dictType keyptrDictType
= {
1119 dictObjHash
, /* hash function */
1122 dictObjKeyCompare
, /* key compare */
1123 dictRedisObjectDestructor
, /* key destructor */
1124 NULL
/* val destructor */
1127 /* Hash type hash table (note that small hashes are represented with zimpaps) */
1128 static dictType hashDictType
= {
1129 dictEncObjHash
, /* hash function */
1132 dictEncObjKeyCompare
, /* key compare */
1133 dictRedisObjectDestructor
, /* key destructor */
1134 dictRedisObjectDestructor
/* val destructor */
1137 /* Keylist hash table type has unencoded redis objects as keys and
1138 * lists as values. It's used for blocking operations (BLPOP) and to
1139 * map swapped keys to a list of clients waiting for this keys to be loaded. */
1140 static dictType keylistDictType
= {
1141 dictObjHash
, /* hash function */
1144 dictObjKeyCompare
, /* key compare */
1145 dictRedisObjectDestructor
, /* key destructor */
1146 dictListDestructor
/* val destructor */
1149 static void version();
1151 /* ========================= Random utility functions ======================= */
1153 /* Redis generally does not try to recover from out of memory conditions
1154 * when allocating objects or strings, it is not clear if it will be possible
1155 * to report this condition to the client since the networking layer itself
1156 * is based on heap allocation for send buffers, so we simply abort.
1157 * At least the code will be simpler to read... */
1158 static void oom(const char *msg
) {
1159 redisLog(REDIS_WARNING
, "%s: Out of memory\n",msg
);
1164 /* ====================== Redis server networking stuff ===================== */
1165 static void closeTimedoutClients(void) {
1168 time_t now
= time(NULL
);
1171 listRewind(server
.clients
,&li
);
1172 while ((ln
= listNext(&li
)) != NULL
) {
1173 c
= listNodeValue(ln
);
1174 if (server
.maxidletime
&&
1175 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
1176 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
1177 dictSize(c
->pubsub_channels
) == 0 && /* no timeout for pubsub */
1178 listLength(c
->pubsub_patterns
) == 0 &&
1179 (now
- c
->lastinteraction
> server
.maxidletime
))
1181 redisLog(REDIS_VERBOSE
,"Closing idle client");
1183 } else if (c
->flags
& REDIS_BLOCKED
) {
1184 if (c
->blockingto
!= 0 && c
->blockingto
< now
) {
1185 addReply(c
,shared
.nullmultibulk
);
1186 unblockClientWaitingData(c
);
1192 static int htNeedsResize(dict
*dict
) {
1193 long long size
, used
;
1195 size
= dictSlots(dict
);
1196 used
= dictSize(dict
);
1197 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
1198 (used
*100/size
< REDIS_HT_MINFILL
));
1201 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1202 * we resize the hash table to save memory */
1203 static void tryResizeHashTables(void) {
1206 for (j
= 0; j
< server
.dbnum
; j
++) {
1207 if (htNeedsResize(server
.db
[j
].dict
))
1208 dictResize(server
.db
[j
].dict
);
1209 if (htNeedsResize(server
.db
[j
].expires
))
1210 dictResize(server
.db
[j
].expires
);
1214 /* Our hash table implementation performs rehashing incrementally while
1215 * we write/read from the hash table. Still if the server is idle, the hash
1216 * table will use two tables for a long time. So we try to use 1 millisecond
1217 * of CPU time at every serverCron() loop in order to rehash some key. */
1218 static void incrementallyRehash(void) {
1221 for (j
= 0; j
< server
.dbnum
; j
++) {
1222 if (dictIsRehashing(server
.db
[j
].dict
)) {
1223 dictRehashMilliseconds(server
.db
[j
].dict
,1);
1224 break; /* already used our millisecond for this loop... */
1229 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1230 void backgroundSaveDoneHandler(int statloc
) {
1231 int exitcode
= WEXITSTATUS(statloc
);
1232 int bysignal
= WIFSIGNALED(statloc
);
1234 if (!bysignal
&& exitcode
== 0) {
1235 redisLog(REDIS_NOTICE
,
1236 "Background saving terminated with success");
1238 server
.lastsave
= time(NULL
);
1239 } else if (!bysignal
&& exitcode
!= 0) {
1240 redisLog(REDIS_WARNING
, "Background saving error");
1242 redisLog(REDIS_WARNING
,
1243 "Background saving terminated by signal %d", WTERMSIG(statloc
));
1244 rdbRemoveTempFile(server
.bgsavechildpid
);
1246 server
.bgsavechildpid
= -1;
1247 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1248 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1249 updateSlavesWaitingBgsave(exitcode
== 0 ? REDIS_OK
: REDIS_ERR
);
1252 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1254 void backgroundRewriteDoneHandler(int statloc
) {
1255 int exitcode
= WEXITSTATUS(statloc
);
1256 int bysignal
= WIFSIGNALED(statloc
);
1258 if (!bysignal
&& exitcode
== 0) {
1262 redisLog(REDIS_NOTICE
,
1263 "Background append only file rewriting terminated with success");
1264 /* Now it's time to flush the differences accumulated by the parent */
1265 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) server
.bgrewritechildpid
);
1266 fd
= open(tmpfile
,O_WRONLY
|O_APPEND
);
1268 redisLog(REDIS_WARNING
, "Not able to open the temp append only file produced by the child: %s", strerror(errno
));
1271 /* Flush our data... */
1272 if (write(fd
,server
.bgrewritebuf
,sdslen(server
.bgrewritebuf
)) !=
1273 (signed) sdslen(server
.bgrewritebuf
)) {
1274 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
));
1278 redisLog(REDIS_NOTICE
,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server
.bgrewritebuf
));
1279 /* Now our work is to rename the temp file into the stable file. And
1280 * switch the file descriptor used by the server for append only. */
1281 if (rename(tmpfile
,server
.appendfilename
) == -1) {
1282 redisLog(REDIS_WARNING
,"Can't rename the temp append only file into the stable one: %s", strerror(errno
));
1286 /* Mission completed... almost */
1287 redisLog(REDIS_NOTICE
,"Append only file successfully rewritten.");
1288 if (server
.appendfd
!= -1) {
1289 /* If append only is actually enabled... */
1290 close(server
.appendfd
);
1291 server
.appendfd
= fd
;
1293 server
.appendseldb
= -1; /* Make sure it will issue SELECT */
1294 redisLog(REDIS_NOTICE
,"The new append only file was selected for future appends.");
1296 /* If append only is disabled we just generate a dump in this
1297 * format. Why not? */
1300 } else if (!bysignal
&& exitcode
!= 0) {
1301 redisLog(REDIS_WARNING
, "Background append only file rewriting error");
1303 redisLog(REDIS_WARNING
,
1304 "Background append only file rewriting terminated by signal %d",
1308 sdsfree(server
.bgrewritebuf
);
1309 server
.bgrewritebuf
= sdsempty();
1310 aofRemoveTempFile(server
.bgrewritechildpid
);
1311 server
.bgrewritechildpid
= -1;
1314 /* This function is called once a background process of some kind terminates,
1315 * as we want to avoid resizing the hash tables when there is a child in order
1316 * to play well with copy-on-write (otherwise when a resize happens lots of
1317 * memory pages are copied). The goal of this function is to update the ability
1318 * for dict.c to resize the hash tables accordingly to the fact we have o not
1319 * running childs. */
1320 static void updateDictResizePolicy(void) {
1321 if (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1)
1324 dictDisableResize();
1327 static int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
1328 int j
, loops
= server
.cronloops
++;
1329 REDIS_NOTUSED(eventLoop
);
1331 REDIS_NOTUSED(clientData
);
1333 /* We take a cached value of the unix time in the global state because
1334 * with virtual memory and aging there is to store the current time
1335 * in objects at every object access, and accuracy is not needed.
1336 * To access a global var is faster than calling time(NULL) */
1337 server
.unixtime
= time(NULL
);
1339 /* Show some info about non-empty databases */
1340 for (j
= 0; j
< server
.dbnum
; j
++) {
1341 long long size
, used
, vkeys
;
1343 size
= dictSlots(server
.db
[j
].dict
);
1344 used
= dictSize(server
.db
[j
].dict
);
1345 vkeys
= dictSize(server
.db
[j
].expires
);
1346 if (!(loops
% 50) && (used
|| vkeys
)) {
1347 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
1348 /* dictPrintStats(server.dict); */
1352 /* We don't want to resize the hash tables while a bacground saving
1353 * is in progress: the saving child is created using fork() that is
1354 * implemented with a copy-on-write semantic in most modern systems, so
1355 * if we resize the HT while there is the saving child at work actually
1356 * a lot of memory movements in the parent will cause a lot of pages
1358 if (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1) {
1359 if (!(loops
% 10)) tryResizeHashTables();
1360 if (server
.activerehashing
) incrementallyRehash();
1363 /* Show information about connected clients */
1364 if (!(loops
% 50)) {
1365 redisLog(REDIS_VERBOSE
,"%d clients connected (%d slaves), %zu bytes in use",
1366 listLength(server
.clients
)-listLength(server
.slaves
),
1367 listLength(server
.slaves
),
1368 zmalloc_used_memory());
1371 /* Close connections of timedout clients */
1372 if ((server
.maxidletime
&& !(loops
% 100)) || server
.blpop_blocked_clients
)
1373 closeTimedoutClients();
1375 /* Check if a background saving or AOF rewrite in progress terminated */
1376 if (server
.bgsavechildpid
!= -1 || server
.bgrewritechildpid
!= -1) {
1380 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
1381 if (pid
== server
.bgsavechildpid
) {
1382 backgroundSaveDoneHandler(statloc
);
1384 backgroundRewriteDoneHandler(statloc
);
1386 updateDictResizePolicy();
1389 /* If there is not a background saving in progress check if
1390 * we have to save now */
1391 time_t now
= time(NULL
);
1392 for (j
= 0; j
< server
.saveparamslen
; j
++) {
1393 struct saveparam
*sp
= server
.saveparams
+j
;
1395 if (server
.dirty
>= sp
->changes
&&
1396 now
-server
.lastsave
> sp
->seconds
) {
1397 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
1398 sp
->changes
, sp
->seconds
);
1399 rdbSaveBackground(server
.dbfilename
);
1405 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1406 * will use few CPU cycles if there are few expiring keys, otherwise
1407 * it will get more aggressive to avoid that too much memory is used by
1408 * keys that can be removed from the keyspace. */
1409 for (j
= 0; j
< server
.dbnum
; j
++) {
1411 redisDb
*db
= server
.db
+j
;
1413 /* Continue to expire if at the end of the cycle more than 25%
1414 * of the keys were expired. */
1416 long num
= dictSize(db
->expires
);
1417 time_t now
= time(NULL
);
1420 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
1421 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
1426 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
1427 t
= (time_t) dictGetEntryVal(de
);
1429 deleteKey(db
,dictGetEntryKey(de
));
1431 server
.stat_expiredkeys
++;
1434 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
1437 /* Swap a few keys on disk if we are over the memory limit and VM
1438 * is enbled. Try to free objects from the free list first. */
1439 if (vmCanSwapOut()) {
1440 while (server
.vm_enabled
&& zmalloc_used_memory() >
1441 server
.vm_max_memory
)
1445 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
1446 retval
= (server
.vm_max_threads
== 0) ?
1447 vmSwapOneObjectBlocking() :
1448 vmSwapOneObjectThreaded();
1449 if (retval
== REDIS_ERR
&& !(loops
% 300) &&
1450 zmalloc_used_memory() >
1451 (server
.vm_max_memory
+server
.vm_max_memory
/10))
1453 redisLog(REDIS_WARNING
,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1455 /* Note that when using threade I/O we free just one object,
1456 * because anyway when the I/O thread in charge to swap this
1457 * object out will finish, the handler of completed jobs
1458 * will try to swap more objects if we are still out of memory. */
1459 if (retval
== REDIS_ERR
|| server
.vm_max_threads
> 0) break;
1463 /* Check if we should connect to a MASTER */
1464 if (server
.replstate
== REDIS_REPL_CONNECT
&& !(loops
% 10)) {
1465 redisLog(REDIS_NOTICE
,"Connecting to MASTER...");
1466 if (syncWithMaster() == REDIS_OK
) {
1467 redisLog(REDIS_NOTICE
,"MASTER <-> SLAVE sync succeeded");
1473 /* This function gets called every time Redis is entering the
1474 * main loop of the event driven library, that is, before to sleep
1475 * for ready file descriptors. */
1476 static void beforeSleep(struct aeEventLoop
*eventLoop
) {
1477 REDIS_NOTUSED(eventLoop
);
1479 if (server
.vm_enabled
&& listLength(server
.io_ready_clients
)) {
1483 listRewind(server
.io_ready_clients
,&li
);
1484 while((ln
= listNext(&li
))) {
1485 redisClient
*c
= ln
->value
;
1486 struct redisCommand
*cmd
;
1488 /* Resume the client. */
1489 listDelNode(server
.io_ready_clients
,ln
);
1490 c
->flags
&= (~REDIS_IO_WAIT
);
1491 server
.vm_blocked_clients
--;
1492 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
1493 readQueryFromClient
, c
);
1494 cmd
= lookupCommand(c
->argv
[0]->ptr
);
1495 assert(cmd
!= NULL
);
1498 /* There may be more data to process in the input buffer. */
1499 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0)
1500 processInputBuffer(c
);
1505 static void createSharedObjects(void) {
1508 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1509 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1510 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1511 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1512 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1513 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1514 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1515 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1516 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1517 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1518 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1519 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1520 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1521 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1522 "-ERR no such key\r\n"));
1523 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1524 "-ERR syntax error\r\n"));
1525 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1526 "-ERR source and destination objects are the same\r\n"));
1527 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1528 "-ERR index out of range\r\n"));
1529 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1530 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1531 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1532 shared
.select0
= createStringObject("select 0\r\n",10);
1533 shared
.select1
= createStringObject("select 1\r\n",10);
1534 shared
.select2
= createStringObject("select 2\r\n",10);
1535 shared
.select3
= createStringObject("select 3\r\n",10);
1536 shared
.select4
= createStringObject("select 4\r\n",10);
1537 shared
.select5
= createStringObject("select 5\r\n",10);
1538 shared
.select6
= createStringObject("select 6\r\n",10);
1539 shared
.select7
= createStringObject("select 7\r\n",10);
1540 shared
.select8
= createStringObject("select 8\r\n",10);
1541 shared
.select9
= createStringObject("select 9\r\n",10);
1542 shared
.messagebulk
= createStringObject("$7\r\nmessage\r\n",13);
1543 shared
.subscribebulk
= createStringObject("$9\r\nsubscribe\r\n",15);
1544 shared
.unsubscribebulk
= createStringObject("$11\r\nunsubscribe\r\n",18);
1545 shared
.psubscribebulk
= createStringObject("$10\r\npsubscribe\r\n",17);
1546 shared
.punsubscribebulk
= createStringObject("$12\r\npunsubscribe\r\n",19);
1547 shared
.mbulk3
= createStringObject("*3\r\n",4);
1548 for (j
= 0; j
< REDIS_SHARED_INTEGERS
; j
++) {
1549 shared
.integers
[j
] = createObject(REDIS_STRING
,(void*)(long)j
);
1550 shared
.integers
[j
]->encoding
= REDIS_ENCODING_INT
;
1554 static void appendServerSaveParams(time_t seconds
, int changes
) {
1555 server
.saveparams
= zrealloc(server
.saveparams
,sizeof(struct saveparam
)*(server
.saveparamslen
+1));
1556 server
.saveparams
[server
.saveparamslen
].seconds
= seconds
;
1557 server
.saveparams
[server
.saveparamslen
].changes
= changes
;
1558 server
.saveparamslen
++;
1561 static void resetServerSaveParams() {
1562 zfree(server
.saveparams
);
1563 server
.saveparams
= NULL
;
1564 server
.saveparamslen
= 0;
1567 static void initServerConfig() {
1568 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1569 server
.port
= REDIS_SERVERPORT
;
1570 server
.verbosity
= REDIS_VERBOSE
;
1571 server
.maxidletime
= REDIS_MAXIDLETIME
;
1572 server
.saveparams
= NULL
;
1573 server
.logfile
= NULL
; /* NULL = log on standard output */
1574 server
.bindaddr
= NULL
;
1575 server
.glueoutputbuf
= 1;
1576 server
.daemonize
= 0;
1577 server
.appendonly
= 0;
1578 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1579 server
.lastfsync
= time(NULL
);
1580 server
.appendfd
= -1;
1581 server
.appendseldb
= -1; /* Make sure the first time will not match */
1582 server
.pidfile
= zstrdup("/var/run/redis.pid");
1583 server
.dbfilename
= zstrdup("dump.rdb");
1584 server
.appendfilename
= zstrdup("appendonly.aof");
1585 server
.requirepass
= NULL
;
1586 server
.shareobjects
= 0;
1587 server
.rdbcompression
= 1;
1588 server
.activerehashing
= 1;
1589 server
.maxclients
= 0;
1590 server
.blpop_blocked_clients
= 0;
1591 server
.maxmemory
= 0;
1592 server
.vm_enabled
= 0;
1593 server
.vm_swap_file
= zstrdup("/tmp/redis-%p.vm");
1594 server
.vm_page_size
= 256; /* 256 bytes per page */
1595 server
.vm_pages
= 1024*1024*100; /* 104 millions of pages */
1596 server
.vm_max_memory
= 1024LL*1024*1024*1; /* 1 GB of RAM */
1597 server
.vm_max_threads
= 4;
1598 server
.vm_blocked_clients
= 0;
1599 server
.hash_max_zipmap_entries
= REDIS_HASH_MAX_ZIPMAP_ENTRIES
;
1600 server
.hash_max_zipmap_value
= REDIS_HASH_MAX_ZIPMAP_VALUE
;
1602 resetServerSaveParams();
1604 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1605 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1606 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1607 /* Replication related */
1609 server
.masterauth
= NULL
;
1610 server
.masterhost
= NULL
;
1611 server
.masterport
= 6379;
1612 server
.master
= NULL
;
1613 server
.replstate
= REDIS_REPL_NONE
;
1615 /* Double constants initialization */
1617 R_PosInf
= 1.0/R_Zero
;
1618 R_NegInf
= -1.0/R_Zero
;
1619 R_Nan
= R_Zero
/R_Zero
;
1622 static void initServer() {
1625 signal(SIGHUP
, SIG_IGN
);
1626 signal(SIGPIPE
, SIG_IGN
);
1627 setupSigSegvAction();
1629 server
.devnull
= fopen("/dev/null","w");
1630 if (server
.devnull
== NULL
) {
1631 redisLog(REDIS_WARNING
, "Can't open /dev/null: %s", server
.neterr
);
1634 server
.clients
= listCreate();
1635 server
.slaves
= listCreate();
1636 server
.monitors
= listCreate();
1637 server
.objfreelist
= listCreate();
1638 createSharedObjects();
1639 server
.el
= aeCreateEventLoop();
1640 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1641 server
.fd
= anetTcpServer(server
.neterr
, server
.port
, server
.bindaddr
);
1642 if (server
.fd
== -1) {
1643 redisLog(REDIS_WARNING
, "Opening TCP port: %s", server
.neterr
);
1646 for (j
= 0; j
< server
.dbnum
; j
++) {
1647 server
.db
[j
].dict
= dictCreate(&dbDictType
,NULL
);
1648 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1649 server
.db
[j
].blockingkeys
= dictCreate(&keylistDictType
,NULL
);
1650 if (server
.vm_enabled
)
1651 server
.db
[j
].io_keys
= dictCreate(&keylistDictType
,NULL
);
1652 server
.db
[j
].id
= j
;
1654 server
.pubsub_channels
= dictCreate(&keylistDictType
,NULL
);
1655 server
.pubsub_patterns
= listCreate();
1656 listSetFreeMethod(server
.pubsub_patterns
,freePubsubPattern
);
1657 listSetMatchMethod(server
.pubsub_patterns
,listMatchPubsubPattern
);
1658 server
.cronloops
= 0;
1659 server
.bgsavechildpid
= -1;
1660 server
.bgrewritechildpid
= -1;
1661 server
.bgrewritebuf
= sdsempty();
1662 server
.lastsave
= time(NULL
);
1664 server
.stat_numcommands
= 0;
1665 server
.stat_numconnections
= 0;
1666 server
.stat_expiredkeys
= 0;
1667 server
.stat_starttime
= time(NULL
);
1668 server
.unixtime
= time(NULL
);
1669 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1670 if (aeCreateFileEvent(server
.el
, server
.fd
, AE_READABLE
,
1671 acceptHandler
, NULL
) == AE_ERR
) oom("creating file event");
1673 if (server
.appendonly
) {
1674 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1675 if (server
.appendfd
== -1) {
1676 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1682 if (server
.vm_enabled
) vmInit();
1685 /* Empty the whole database */
1686 static long long emptyDb() {
1688 long long removed
= 0;
1690 for (j
= 0; j
< server
.dbnum
; j
++) {
1691 removed
+= dictSize(server
.db
[j
].dict
);
1692 dictEmpty(server
.db
[j
].dict
);
1693 dictEmpty(server
.db
[j
].expires
);
1698 static int yesnotoi(char *s
) {
1699 if (!strcasecmp(s
,"yes")) return 1;
1700 else if (!strcasecmp(s
,"no")) return 0;
1704 /* I agree, this is a very rudimental way to load a configuration...
1705 will improve later if the config gets more complex */
1706 static void loadServerConfig(char *filename
) {
1708 char buf
[REDIS_CONFIGLINE_MAX
+1], *err
= NULL
;
1712 if (filename
[0] == '-' && filename
[1] == '\0')
1715 if ((fp
= fopen(filename
,"r")) == NULL
) {
1716 redisLog(REDIS_WARNING
, "Fatal error, can't open config file '%s'", filename
);
1721 while(fgets(buf
,REDIS_CONFIGLINE_MAX
+1,fp
) != NULL
) {
1727 line
= sdstrim(line
," \t\r\n");
1729 /* Skip comments and blank lines*/
1730 if (line
[0] == '#' || line
[0] == '\0') {
1735 /* Split into arguments */
1736 argv
= sdssplitlen(line
,sdslen(line
)," ",1,&argc
);
1737 sdstolower(argv
[0]);
1739 /* Execute config directives */
1740 if (!strcasecmp(argv
[0],"timeout") && argc
== 2) {
1741 server
.maxidletime
= atoi(argv
[1]);
1742 if (server
.maxidletime
< 0) {
1743 err
= "Invalid timeout value"; goto loaderr
;
1745 } else if (!strcasecmp(argv
[0],"port") && argc
== 2) {
1746 server
.port
= atoi(argv
[1]);
1747 if (server
.port
< 1 || server
.port
> 65535) {
1748 err
= "Invalid port"; goto loaderr
;
1750 } else if (!strcasecmp(argv
[0],"bind") && argc
== 2) {
1751 server
.bindaddr
= zstrdup(argv
[1]);
1752 } else if (!strcasecmp(argv
[0],"save") && argc
== 3) {
1753 int seconds
= atoi(argv
[1]);
1754 int changes
= atoi(argv
[2]);
1755 if (seconds
< 1 || changes
< 0) {
1756 err
= "Invalid save parameters"; goto loaderr
;
1758 appendServerSaveParams(seconds
,changes
);
1759 } else if (!strcasecmp(argv
[0],"dir") && argc
== 2) {
1760 if (chdir(argv
[1]) == -1) {
1761 redisLog(REDIS_WARNING
,"Can't chdir to '%s': %s",
1762 argv
[1], strerror(errno
));
1765 } else if (!strcasecmp(argv
[0],"loglevel") && argc
== 2) {
1766 if (!strcasecmp(argv
[1],"debug")) server
.verbosity
= REDIS_DEBUG
;
1767 else if (!strcasecmp(argv
[1],"verbose")) server
.verbosity
= REDIS_VERBOSE
;
1768 else if (!strcasecmp(argv
[1],"notice")) server
.verbosity
= REDIS_NOTICE
;
1769 else if (!strcasecmp(argv
[1],"warning")) server
.verbosity
= REDIS_WARNING
;
1771 err
= "Invalid log level. Must be one of debug, notice, warning";
1774 } else if (!strcasecmp(argv
[0],"logfile") && argc
== 2) {
1777 server
.logfile
= zstrdup(argv
[1]);
1778 if (!strcasecmp(server
.logfile
,"stdout")) {
1779 zfree(server
.logfile
);
1780 server
.logfile
= NULL
;
1782 if (server
.logfile
) {
1783 /* Test if we are able to open the file. The server will not
1784 * be able to abort just for this problem later... */
1785 logfp
= fopen(server
.logfile
,"a");
1786 if (logfp
== NULL
) {
1787 err
= sdscatprintf(sdsempty(),
1788 "Can't open the log file: %s", strerror(errno
));
1793 } else if (!strcasecmp(argv
[0],"databases") && argc
== 2) {
1794 server
.dbnum
= atoi(argv
[1]);
1795 if (server
.dbnum
< 1) {
1796 err
= "Invalid number of databases"; goto loaderr
;
1798 } else if (!strcasecmp(argv
[0],"include") && argc
== 2) {
1799 loadServerConfig(argv
[1]);
1800 } else if (!strcasecmp(argv
[0],"maxclients") && argc
== 2) {
1801 server
.maxclients
= atoi(argv
[1]);
1802 } else if (!strcasecmp(argv
[0],"maxmemory") && argc
== 2) {
1803 server
.maxmemory
= strtoll(argv
[1], NULL
, 10);
1804 } else if (!strcasecmp(argv
[0],"slaveof") && argc
== 3) {
1805 server
.masterhost
= sdsnew(argv
[1]);
1806 server
.masterport
= atoi(argv
[2]);
1807 server
.replstate
= REDIS_REPL_CONNECT
;
1808 } else if (!strcasecmp(argv
[0],"masterauth") && argc
== 2) {
1809 server
.masterauth
= zstrdup(argv
[1]);
1810 } else if (!strcasecmp(argv
[0],"glueoutputbuf") && argc
== 2) {
1811 if ((server
.glueoutputbuf
= yesnotoi(argv
[1])) == -1) {
1812 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1814 } else if (!strcasecmp(argv
[0],"shareobjects") && argc
== 2) {
1815 if ((server
.shareobjects
= yesnotoi(argv
[1])) == -1) {
1816 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1818 } else if (!strcasecmp(argv
[0],"rdbcompression") && argc
== 2) {
1819 if ((server
.rdbcompression
= yesnotoi(argv
[1])) == -1) {
1820 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1822 } else if (!strcasecmp(argv
[0],"activerehashing") && argc
== 2) {
1823 if ((server
.activerehashing
= yesnotoi(argv
[1])) == -1) {
1824 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1826 } else if (!strcasecmp(argv
[0],"daemonize") && argc
== 2) {
1827 if ((server
.daemonize
= yesnotoi(argv
[1])) == -1) {
1828 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1830 } else if (!strcasecmp(argv
[0],"appendonly") && argc
== 2) {
1831 if ((server
.appendonly
= yesnotoi(argv
[1])) == -1) {
1832 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1834 } else if (!strcasecmp(argv
[0],"appendfsync") && argc
== 2) {
1835 if (!strcasecmp(argv
[1],"no")) {
1836 server
.appendfsync
= APPENDFSYNC_NO
;
1837 } else if (!strcasecmp(argv
[1],"always")) {
1838 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1839 } else if (!strcasecmp(argv
[1],"everysec")) {
1840 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1842 err
= "argument must be 'no', 'always' or 'everysec'";
1845 } else if (!strcasecmp(argv
[0],"requirepass") && argc
== 2) {
1846 server
.requirepass
= zstrdup(argv
[1]);
1847 } else if (!strcasecmp(argv
[0],"pidfile") && argc
== 2) {
1848 zfree(server
.pidfile
);
1849 server
.pidfile
= zstrdup(argv
[1]);
1850 } else if (!strcasecmp(argv
[0],"dbfilename") && argc
== 2) {
1851 zfree(server
.dbfilename
);
1852 server
.dbfilename
= zstrdup(argv
[1]);
1853 } else if (!strcasecmp(argv
[0],"vm-enabled") && argc
== 2) {
1854 if ((server
.vm_enabled
= yesnotoi(argv
[1])) == -1) {
1855 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1857 } else if (!strcasecmp(argv
[0],"vm-swap-file") && argc
== 2) {
1858 zfree(server
.vm_swap_file
);
1859 server
.vm_swap_file
= zstrdup(argv
[1]);
1860 } else if (!strcasecmp(argv
[0],"vm-max-memory") && argc
== 2) {
1861 server
.vm_max_memory
= strtoll(argv
[1], NULL
, 10);
1862 } else if (!strcasecmp(argv
[0],"vm-page-size") && argc
== 2) {
1863 server
.vm_page_size
= strtoll(argv
[1], NULL
, 10);
1864 } else if (!strcasecmp(argv
[0],"vm-pages") && argc
== 2) {
1865 server
.vm_pages
= strtoll(argv
[1], NULL
, 10);
1866 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1867 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1868 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-entries") && argc
== 2){
1869 server
.hash_max_zipmap_entries
= strtol(argv
[1], NULL
, 10);
1870 } else if (!strcasecmp(argv
[0],"hash-max-zipmap-value") && argc
== 2){
1871 server
.hash_max_zipmap_value
= strtol(argv
[1], NULL
, 10);
1872 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1873 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1875 err
= "Bad directive or wrong number of arguments"; goto loaderr
;
1877 for (j
= 0; j
< argc
; j
++)
1882 if (fp
!= stdin
) fclose(fp
);
1886 fprintf(stderr
, "\n*** FATAL CONFIG FILE ERROR ***\n");
1887 fprintf(stderr
, "Reading the configuration file, at line %d\n", linenum
);
1888 fprintf(stderr
, ">>> '%s'\n", line
);
1889 fprintf(stderr
, "%s\n", err
);
1893 static void freeClientArgv(redisClient
*c
) {
1896 for (j
= 0; j
< c
->argc
; j
++)
1897 decrRefCount(c
->argv
[j
]);
1898 for (j
= 0; j
< c
->mbargc
; j
++)
1899 decrRefCount(c
->mbargv
[j
]);
1904 static void freeClient(redisClient
*c
) {
1907 /* Note that if the client we are freeing is blocked into a blocking
1908 * call, we have to set querybuf to NULL *before* to call
1909 * unblockClientWaitingData() to avoid processInputBuffer() will get
1910 * called. Also it is important to remove the file events after
1911 * this, because this call adds the READABLE event. */
1912 sdsfree(c
->querybuf
);
1914 if (c
->flags
& REDIS_BLOCKED
)
1915 unblockClientWaitingData(c
);
1917 /* Unsubscribe from all the pubsub channels */
1918 pubsubUnsubscribeAllChannels(c
,0);
1919 pubsubUnsubscribeAllPatterns(c
,0);
1920 dictRelease(c
->pubsub_channels
);
1921 listRelease(c
->pubsub_patterns
);
1922 /* Obvious cleanup */
1923 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
1924 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1925 listRelease(c
->reply
);
1928 /* Remove from the list of clients */
1929 ln
= listSearchKey(server
.clients
,c
);
1930 redisAssert(ln
!= NULL
);
1931 listDelNode(server
.clients
,ln
);
1932 /* Remove from the list of clients waiting for swapped keys */
1933 if (c
->flags
& REDIS_IO_WAIT
&& listLength(c
->io_keys
) == 0) {
1934 ln
= listSearchKey(server
.io_ready_clients
,c
);
1936 listDelNode(server
.io_ready_clients
,ln
);
1937 server
.vm_blocked_clients
--;
1940 while (server
.vm_enabled
&& listLength(c
->io_keys
)) {
1941 ln
= listFirst(c
->io_keys
);
1942 dontWaitForSwappedKey(c
,ln
->value
);
1944 listRelease(c
->io_keys
);
1945 /* Master/slave cleanup */
1946 if (c
->flags
& REDIS_SLAVE
) {
1947 if (c
->replstate
== REDIS_REPL_SEND_BULK
&& c
->repldbfd
!= -1)
1949 list
*l
= (c
->flags
& REDIS_MONITOR
) ? server
.monitors
: server
.slaves
;
1950 ln
= listSearchKey(l
,c
);
1951 redisAssert(ln
!= NULL
);
1954 if (c
->flags
& REDIS_MASTER
) {
1955 server
.master
= NULL
;
1956 server
.replstate
= REDIS_REPL_CONNECT
;
1958 /* Release memory */
1961 freeClientMultiState(c
);
1965 #define GLUEREPLY_UP_TO (1024)
1966 static void glueReplyBuffersIfNeeded(redisClient
*c
) {
1968 char buf
[GLUEREPLY_UP_TO
];
1973 listRewind(c
->reply
,&li
);
1974 while((ln
= listNext(&li
))) {
1978 objlen
= sdslen(o
->ptr
);
1979 if (copylen
+ objlen
<= GLUEREPLY_UP_TO
) {
1980 memcpy(buf
+copylen
,o
->ptr
,objlen
);
1982 listDelNode(c
->reply
,ln
);
1984 if (copylen
== 0) return;
1988 /* Now the output buffer is empty, add the new single element */
1989 o
= createObject(REDIS_STRING
,sdsnewlen(buf
,copylen
));
1990 listAddNodeHead(c
->reply
,o
);
1993 static void sendReplyToClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
1994 redisClient
*c
= privdata
;
1995 int nwritten
= 0, totwritten
= 0, objlen
;
1998 REDIS_NOTUSED(mask
);
2000 /* Use writev() if we have enough buffers to send */
2001 if (!server
.glueoutputbuf
&&
2002 listLength(c
->reply
) > REDIS_WRITEV_THRESHOLD
&&
2003 !(c
->flags
& REDIS_MASTER
))
2005 sendReplyToClientWritev(el
, fd
, privdata
, mask
);
2009 while(listLength(c
->reply
)) {
2010 if (server
.glueoutputbuf
&& listLength(c
->reply
) > 1)
2011 glueReplyBuffersIfNeeded(c
);
2013 o
= listNodeValue(listFirst(c
->reply
));
2014 objlen
= sdslen(o
->ptr
);
2017 listDelNode(c
->reply
,listFirst(c
->reply
));
2021 if (c
->flags
& REDIS_MASTER
) {
2022 /* Don't reply to a master */
2023 nwritten
= objlen
- c
->sentlen
;
2025 nwritten
= write(fd
, ((char*)o
->ptr
)+c
->sentlen
, objlen
- c
->sentlen
);
2026 if (nwritten
<= 0) break;
2028 c
->sentlen
+= nwritten
;
2029 totwritten
+= nwritten
;
2030 /* If we fully sent the object on head go to the next one */
2031 if (c
->sentlen
== objlen
) {
2032 listDelNode(c
->reply
,listFirst(c
->reply
));
2035 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
2036 * bytes, in a single threaded server it's a good idea to serve
2037 * other clients as well, even if a very large request comes from
2038 * super fast link that is always able to accept data (in real world
2039 * scenario think about 'KEYS *' against the loopback interfae) */
2040 if (totwritten
> REDIS_MAX_WRITE_PER_EVENT
) break;
2042 if (nwritten
== -1) {
2043 if (errno
== EAGAIN
) {
2046 redisLog(REDIS_VERBOSE
,
2047 "Error writing to client: %s", strerror(errno
));
2052 if (totwritten
> 0) c
->lastinteraction
= time(NULL
);
2053 if (listLength(c
->reply
) == 0) {
2055 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2059 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
)
2061 redisClient
*c
= privdata
;
2062 int nwritten
= 0, totwritten
= 0, objlen
, willwrite
;
2064 struct iovec iov
[REDIS_WRITEV_IOVEC_COUNT
];
2065 int offset
, ion
= 0;
2067 REDIS_NOTUSED(mask
);
2070 while (listLength(c
->reply
)) {
2071 offset
= c
->sentlen
;
2075 /* fill-in the iov[] array */
2076 for(node
= listFirst(c
->reply
); node
; node
= listNextNode(node
)) {
2077 o
= listNodeValue(node
);
2078 objlen
= sdslen(o
->ptr
);
2080 if (totwritten
+ objlen
- offset
> REDIS_MAX_WRITE_PER_EVENT
)
2083 if(ion
== REDIS_WRITEV_IOVEC_COUNT
)
2084 break; /* no more iovecs */
2086 iov
[ion
].iov_base
= ((char*)o
->ptr
) + offset
;
2087 iov
[ion
].iov_len
= objlen
- offset
;
2088 willwrite
+= objlen
- offset
;
2089 offset
= 0; /* just for the first item */
2096 /* write all collected blocks at once */
2097 if((nwritten
= writev(fd
, iov
, ion
)) < 0) {
2098 if (errno
!= EAGAIN
) {
2099 redisLog(REDIS_VERBOSE
,
2100 "Error writing to client: %s", strerror(errno
));
2107 totwritten
+= nwritten
;
2108 offset
= c
->sentlen
;
2110 /* remove written robjs from c->reply */
2111 while (nwritten
&& listLength(c
->reply
)) {
2112 o
= listNodeValue(listFirst(c
->reply
));
2113 objlen
= sdslen(o
->ptr
);
2115 if(nwritten
>= objlen
- offset
) {
2116 listDelNode(c
->reply
, listFirst(c
->reply
));
2117 nwritten
-= objlen
- offset
;
2121 c
->sentlen
+= nwritten
;
2129 c
->lastinteraction
= time(NULL
);
2131 if (listLength(c
->reply
) == 0) {
2133 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
2137 static struct redisCommand
*lookupCommand(char *name
) {
2139 while(cmdTable
[j
].name
!= NULL
) {
2140 if (!strcasecmp(name
,cmdTable
[j
].name
)) return &cmdTable
[j
];
2146 /* resetClient prepare the client to process the next command */
2147 static void resetClient(redisClient
*c
) {
2153 /* Call() is the core of Redis execution of a command */
2154 static void call(redisClient
*c
, struct redisCommand
*cmd
) {
2157 dirty
= server
.dirty
;
2159 dirty
= server
.dirty
-dirty
;
2161 if (server
.appendonly
&& dirty
)
2162 feedAppendOnlyFile(cmd
,c
->db
->id
,c
->argv
,c
->argc
);
2163 if ((dirty
|| cmd
->flags
& REDIS_CMD_FORCE_REPLICATION
) &&
2164 listLength(server
.slaves
))
2165 replicationFeedSlaves(server
.slaves
,c
->db
->id
,c
->argv
,c
->argc
);
2166 if (listLength(server
.monitors
))
2167 replicationFeedSlaves(server
.monitors
,c
->db
->id
,c
->argv
,c
->argc
);
2168 server
.stat_numcommands
++;
2171 /* If this function gets called we already read a whole
2172 * command, argments are in the client argv/argc fields.
2173 * processCommand() execute the command or prepare the
2174 * server for a bulk read from the client.
2176 * If 1 is returned the client is still alive and valid and
2177 * and other operations can be performed by the caller. Otherwise
2178 * if 0 is returned the client was destroied (i.e. after QUIT). */
2179 static int processCommand(redisClient
*c
) {
2180 struct redisCommand
*cmd
;
2182 /* Free some memory if needed (maxmemory setting) */
2183 if (server
.maxmemory
) freeMemoryIfNeeded();
2185 /* Handle the multi bulk command type. This is an alternative protocol
2186 * supported by Redis in order to receive commands that are composed of
2187 * multiple binary-safe "bulk" arguments. The latency of processing is
2188 * a bit higher but this allows things like multi-sets, so if this
2189 * protocol is used only for MSET and similar commands this is a big win. */
2190 if (c
->multibulk
== 0 && c
->argc
== 1 && ((char*)(c
->argv
[0]->ptr
))[0] == '*') {
2191 c
->multibulk
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2192 if (c
->multibulk
<= 0) {
2196 decrRefCount(c
->argv
[c
->argc
-1]);
2200 } else if (c
->multibulk
) {
2201 if (c
->bulklen
== -1) {
2202 if (((char*)c
->argv
[0]->ptr
)[0] != '$') {
2203 addReplySds(c
,sdsnew("-ERR multi bulk protocol error\r\n"));
2207 int bulklen
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2208 decrRefCount(c
->argv
[0]);
2209 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2211 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2216 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2220 c
->mbargv
= zrealloc(c
->mbargv
,(sizeof(robj
*))*(c
->mbargc
+1));
2221 c
->mbargv
[c
->mbargc
] = c
->argv
[0];
2225 if (c
->multibulk
== 0) {
2229 /* Here we need to swap the multi-bulk argc/argv with the
2230 * normal argc/argv of the client structure. */
2232 c
->argv
= c
->mbargv
;
2233 c
->mbargv
= auxargv
;
2236 c
->argc
= c
->mbargc
;
2237 c
->mbargc
= auxargc
;
2239 /* We need to set bulklen to something different than -1
2240 * in order for the code below to process the command without
2241 * to try to read the last argument of a bulk command as
2242 * a special argument. */
2244 /* continue below and process the command */
2251 /* -- end of multi bulk commands processing -- */
2253 /* The QUIT command is handled as a special case. Normal command
2254 * procs are unable to close the client connection safely */
2255 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
2260 /* Now lookup the command and check ASAP about trivial error conditions
2261 * such wrong arity, bad command name and so forth. */
2262 cmd
= lookupCommand(c
->argv
[0]->ptr
);
2265 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2266 (char*)c
->argv
[0]->ptr
));
2269 } else if ((cmd
->arity
> 0 && cmd
->arity
!= c
->argc
) ||
2270 (c
->argc
< -cmd
->arity
)) {
2272 sdscatprintf(sdsempty(),
2273 "-ERR wrong number of arguments for '%s' command\r\n",
2277 } else if (cmd
->flags
& REDIS_CMD_BULK
&& c
->bulklen
== -1) {
2278 /* This is a bulk command, we have to read the last argument yet. */
2279 int bulklen
= atoi(c
->argv
[c
->argc
-1]->ptr
);
2281 decrRefCount(c
->argv
[c
->argc
-1]);
2282 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2284 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2289 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2290 /* It is possible that the bulk read is already in the
2291 * buffer. Check this condition and handle it accordingly.
2292 * This is just a fast path, alternative to call processInputBuffer().
2293 * It's a good idea since the code is small and this condition
2294 * happens most of the times. */
2295 if ((signed)sdslen(c
->querybuf
) >= c
->bulklen
) {
2296 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2298 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2300 /* Otherwise return... there is to read the last argument
2301 * from the socket. */
2305 /* Let's try to encode the bulk object to save space. */
2306 if (cmd
->flags
& REDIS_CMD_BULK
)
2307 c
->argv
[c
->argc
-1] = tryObjectEncoding(c
->argv
[c
->argc
-1]);
2309 /* Check if the user is authenticated */
2310 if (server
.requirepass
&& !c
->authenticated
&& cmd
->proc
!= authCommand
) {
2311 addReplySds(c
,sdsnew("-ERR operation not permitted\r\n"));
2316 /* Handle the maxmemory directive */
2317 if (server
.maxmemory
&& (cmd
->flags
& REDIS_CMD_DENYOOM
) &&
2318 zmalloc_used_memory() > server
.maxmemory
)
2320 addReplySds(c
,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2325 /* Only allow SUBSCRIBE and UNSUBSCRIBE in the context of Pub/Sub */
2326 if ((dictSize(c
->pubsub_channels
) > 0 || listLength(c
->pubsub_patterns
) > 0)
2328 cmd
->proc
!= subscribeCommand
&& cmd
->proc
!= unsubscribeCommand
&&
2329 cmd
->proc
!= psubscribeCommand
&& cmd
->proc
!= punsubscribeCommand
) {
2330 addReplySds(c
,sdsnew("-ERR only (P)SUBSCRIBE / (P)UNSUBSCRIBE / QUIT allowed in this context\r\n"));
2335 /* Exec the command */
2336 if (c
->flags
& REDIS_MULTI
&& cmd
->proc
!= execCommand
&& cmd
->proc
!= discardCommand
) {
2337 queueMultiCommand(c
,cmd
);
2338 addReply(c
,shared
.queued
);
2340 if (server
.vm_enabled
&& server
.vm_max_threads
> 0 &&
2341 blockClientOnSwappedKeys(cmd
,c
)) return 1;
2345 /* Prepare the client for the next command */
2350 static void replicationFeedSlaves(list
*slaves
, int dictid
, robj
**argv
, int argc
) {
2355 /* We need 1+(ARGS*3) objects since commands are using the new protocol
2356 * and we one 1 object for the first "*<count>\r\n" multibulk count, then
2357 * for every additional object we have "$<count>\r\n" + object + "\r\n". */
2358 robj
*static_outv
[REDIS_STATIC_ARGS
*3+1];
2361 if (argc
<= REDIS_STATIC_ARGS
) {
2364 outv
= zmalloc(sizeof(robj
*)*(argc
*3+1));
2367 lenobj
= createObject(REDIS_STRING
,
2368 sdscatprintf(sdsempty(), "*%d\r\n", argc
));
2369 lenobj
->refcount
= 0;
2370 outv
[outc
++] = lenobj
;
2371 for (j
= 0; j
< argc
; j
++) {
2372 lenobj
= createObject(REDIS_STRING
,
2373 sdscatprintf(sdsempty(),"$%lu\r\n",
2374 (unsigned long) stringObjectLen(argv
[j
])));
2375 lenobj
->refcount
= 0;
2376 outv
[outc
++] = lenobj
;
2377 outv
[outc
++] = argv
[j
];
2378 outv
[outc
++] = shared
.crlf
;
2381 /* Increment all the refcounts at start and decrement at end in order to
2382 * be sure to free objects if there is no slave in a replication state
2383 * able to be feed with commands */
2384 for (j
= 0; j
< outc
; j
++) incrRefCount(outv
[j
]);
2385 listRewind(slaves
,&li
);
2386 while((ln
= listNext(&li
))) {
2387 redisClient
*slave
= ln
->value
;
2389 /* Don't feed slaves that are still waiting for BGSAVE to start */
2390 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) continue;
2392 /* Feed all the other slaves, MONITORs and so on */
2393 if (slave
->slaveseldb
!= dictid
) {
2397 case 0: selectcmd
= shared
.select0
; break;
2398 case 1: selectcmd
= shared
.select1
; break;
2399 case 2: selectcmd
= shared
.select2
; break;
2400 case 3: selectcmd
= shared
.select3
; break;
2401 case 4: selectcmd
= shared
.select4
; break;
2402 case 5: selectcmd
= shared
.select5
; break;
2403 case 6: selectcmd
= shared
.select6
; break;
2404 case 7: selectcmd
= shared
.select7
; break;
2405 case 8: selectcmd
= shared
.select8
; break;
2406 case 9: selectcmd
= shared
.select9
; break;
2408 selectcmd
= createObject(REDIS_STRING
,
2409 sdscatprintf(sdsempty(),"select %d\r\n",dictid
));
2410 selectcmd
->refcount
= 0;
2413 addReply(slave
,selectcmd
);
2414 slave
->slaveseldb
= dictid
;
2416 for (j
= 0; j
< outc
; j
++) addReply(slave
,outv
[j
]);
2418 for (j
= 0; j
< outc
; j
++) decrRefCount(outv
[j
]);
2419 if (outv
!= static_outv
) zfree(outv
);
2422 static void processInputBuffer(redisClient
*c
) {
2424 /* Before to process the input buffer, make sure the client is not
2425 * waitig for a blocking operation such as BLPOP. Note that the first
2426 * iteration the client is never blocked, otherwise the processInputBuffer
2427 * would not be called at all, but after the execution of the first commands
2428 * in the input buffer the client may be blocked, and the "goto again"
2429 * will try to reiterate. The following line will make it return asap. */
2430 if (c
->flags
& REDIS_BLOCKED
|| c
->flags
& REDIS_IO_WAIT
) return;
2431 if (c
->bulklen
== -1) {
2432 /* Read the first line of the query */
2433 char *p
= strchr(c
->querybuf
,'\n');
2440 query
= c
->querybuf
;
2441 c
->querybuf
= sdsempty();
2442 querylen
= 1+(p
-(query
));
2443 if (sdslen(query
) > querylen
) {
2444 /* leave data after the first line of the query in the buffer */
2445 c
->querybuf
= sdscatlen(c
->querybuf
,query
+querylen
,sdslen(query
)-querylen
);
2447 *p
= '\0'; /* remove "\n" */
2448 if (*(p
-1) == '\r') *(p
-1) = '\0'; /* and "\r" if any */
2449 sdsupdatelen(query
);
2451 /* Now we can split the query in arguments */
2452 argv
= sdssplitlen(query
,sdslen(query
)," ",1,&argc
);
2455 if (c
->argv
) zfree(c
->argv
);
2456 c
->argv
= zmalloc(sizeof(robj
*)*argc
);
2458 for (j
= 0; j
< argc
; j
++) {
2459 if (sdslen(argv
[j
])) {
2460 c
->argv
[c
->argc
] = createObject(REDIS_STRING
,argv
[j
]);
2468 /* Execute the command. If the client is still valid
2469 * after processCommand() return and there is something
2470 * on the query buffer try to process the next command. */
2471 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2473 /* Nothing to process, argc == 0. Just process the query
2474 * buffer if it's not empty or return to the caller */
2475 if (sdslen(c
->querybuf
)) goto again
;
2478 } else if (sdslen(c
->querybuf
) >= REDIS_REQUEST_MAX_SIZE
) {
2479 redisLog(REDIS_VERBOSE
, "Client protocol error");
2484 /* Bulk read handling. Note that if we are at this point
2485 the client already sent a command terminated with a newline,
2486 we are reading the bulk data that is actually the last
2487 argument of the command. */
2488 int qbl
= sdslen(c
->querybuf
);
2490 if (c
->bulklen
<= qbl
) {
2491 /* Copy everything but the final CRLF as final argument */
2492 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2494 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2495 /* Process the command. If the client is still valid after
2496 * the processing and there is more data in the buffer
2497 * try to parse it. */
2498 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2504 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2505 redisClient
*c
= (redisClient
*) privdata
;
2506 char buf
[REDIS_IOBUF_LEN
];
2509 REDIS_NOTUSED(mask
);
2511 nread
= read(fd
, buf
, REDIS_IOBUF_LEN
);
2513 if (errno
== EAGAIN
) {
2516 redisLog(REDIS_VERBOSE
, "Reading from client: %s",strerror(errno
));
2520 } else if (nread
== 0) {
2521 redisLog(REDIS_VERBOSE
, "Client closed connection");
2526 c
->querybuf
= sdscatlen(c
->querybuf
, buf
, nread
);
2527 c
->lastinteraction
= time(NULL
);
2531 processInputBuffer(c
);
2534 static int selectDb(redisClient
*c
, int id
) {
2535 if (id
< 0 || id
>= server
.dbnum
)
2537 c
->db
= &server
.db
[id
];
2541 static void *dupClientReplyValue(void *o
) {
2542 incrRefCount((robj
*)o
);
2546 static int listMatchObjects(void *a
, void *b
) {
2547 return compareStringObjects(a
,b
) == 0;
2550 static redisClient
*createClient(int fd
) {
2551 redisClient
*c
= zmalloc(sizeof(*c
));
2553 anetNonBlock(NULL
,fd
);
2554 anetTcpNoDelay(NULL
,fd
);
2555 if (!c
) return NULL
;
2558 c
->querybuf
= sdsempty();
2567 c
->lastinteraction
= time(NULL
);
2568 c
->authenticated
= 0;
2569 c
->replstate
= REDIS_REPL_NONE
;
2570 c
->reply
= listCreate();
2571 listSetFreeMethod(c
->reply
,decrRefCount
);
2572 listSetDupMethod(c
->reply
,dupClientReplyValue
);
2573 c
->blockingkeys
= NULL
;
2574 c
->blockingkeysnum
= 0;
2575 c
->io_keys
= listCreate();
2576 listSetFreeMethod(c
->io_keys
,decrRefCount
);
2577 c
->pubsub_channels
= dictCreate(&setDictType
,NULL
);
2578 c
->pubsub_patterns
= listCreate();
2579 listSetFreeMethod(c
->pubsub_patterns
,decrRefCount
);
2580 listSetMatchMethod(c
->pubsub_patterns
,listMatchObjects
);
2581 if (aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
2582 readQueryFromClient
, c
) == AE_ERR
) {
2586 listAddNodeTail(server
.clients
,c
);
2587 initClientMultiState(c
);
2591 static void addReply(redisClient
*c
, robj
*obj
) {
2592 if (listLength(c
->reply
) == 0 &&
2593 (c
->replstate
== REDIS_REPL_NONE
||
2594 c
->replstate
== REDIS_REPL_ONLINE
) &&
2595 aeCreateFileEvent(server
.el
, c
->fd
, AE_WRITABLE
,
2596 sendReplyToClient
, c
) == AE_ERR
) return;
2598 if (server
.vm_enabled
&& obj
->storage
!= REDIS_VM_MEMORY
) {
2599 obj
= dupStringObject(obj
);
2600 obj
->refcount
= 0; /* getDecodedObject() will increment the refcount */
2602 listAddNodeTail(c
->reply
,getDecodedObject(obj
));
2605 static void addReplySds(redisClient
*c
, sds s
) {
2606 robj
*o
= createObject(REDIS_STRING
,s
);
2611 static void addReplyDouble(redisClient
*c
, double d
) {
2614 snprintf(buf
,sizeof(buf
),"%.17g",d
);
2615 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2616 (unsigned long) strlen(buf
),buf
));
2619 static void addReplyLong(redisClient
*c
, long l
) {
2624 addReply(c
,shared
.czero
);
2626 } else if (l
== 1) {
2627 addReply(c
,shared
.cone
);
2630 len
= snprintf(buf
,sizeof(buf
),":%ld\r\n",l
);
2631 addReplySds(c
,sdsnewlen(buf
,len
));
2634 static void addReplyLongLong(redisClient
*c
, long long ll
) {
2639 addReply(c
,shared
.czero
);
2641 } else if (ll
== 1) {
2642 addReply(c
,shared
.cone
);
2645 len
= snprintf(buf
,sizeof(buf
),":%lld\r\n",ll
);
2646 addReplySds(c
,sdsnewlen(buf
,len
));
2649 static void addReplyUlong(redisClient
*c
, unsigned long ul
) {
2654 addReply(c
,shared
.czero
);
2656 } else if (ul
== 1) {
2657 addReply(c
,shared
.cone
);
2660 len
= snprintf(buf
,sizeof(buf
),":%lu\r\n",ul
);
2661 addReplySds(c
,sdsnewlen(buf
,len
));
2664 static void addReplyBulkLen(redisClient
*c
, robj
*obj
) {
2667 if (obj
->encoding
== REDIS_ENCODING_RAW
) {
2668 len
= sdslen(obj
->ptr
);
2670 long n
= (long)obj
->ptr
;
2672 /* Compute how many bytes will take this integer as a radix 10 string */
2678 while((n
= n
/10) != 0) {
2682 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",(unsigned long)len
));
2685 static void addReplyBulk(redisClient
*c
, robj
*obj
) {
2686 addReplyBulkLen(c
,obj
);
2688 addReply(c
,shared
.crlf
);
2691 /* In the CONFIG command we need to add vanilla C string as bulk replies */
2692 static void addReplyBulkCString(redisClient
*c
, char *s
) {
2694 addReply(c
,shared
.nullbulk
);
2696 robj
*o
= createStringObject(s
,strlen(s
));
2702 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2707 REDIS_NOTUSED(mask
);
2708 REDIS_NOTUSED(privdata
);
2710 cfd
= anetAccept(server
.neterr
, fd
, cip
, &cport
);
2711 if (cfd
== AE_ERR
) {
2712 redisLog(REDIS_VERBOSE
,"Accepting client connection: %s", server
.neterr
);
2715 redisLog(REDIS_VERBOSE
,"Accepted %s:%d", cip
, cport
);
2716 if ((c
= createClient(cfd
)) == NULL
) {
2717 redisLog(REDIS_WARNING
,"Error allocating resoures for the client");
2718 close(cfd
); /* May be already closed, just ingore errors */
2721 /* If maxclient directive is set and this is one client more... close the
2722 * connection. Note that we create the client instead to check before
2723 * for this condition, since now the socket is already set in nonblocking
2724 * mode and we can send an error for free using the Kernel I/O */
2725 if (server
.maxclients
&& listLength(server
.clients
) > server
.maxclients
) {
2726 char *err
= "-ERR max number of clients reached\r\n";
2728 /* That's a best effort error message, don't check write errors */
2729 if (write(c
->fd
,err
,strlen(err
)) == -1) {
2730 /* Nothing to do, Just to avoid the warning... */
2735 server
.stat_numconnections
++;
2738 /* ======================= Redis objects implementation ===================== */
2740 static robj
*createObject(int type
, void *ptr
) {
2743 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2744 if (listLength(server
.objfreelist
)) {
2745 listNode
*head
= listFirst(server
.objfreelist
);
2746 o
= listNodeValue(head
);
2747 listDelNode(server
.objfreelist
,head
);
2748 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2750 if (server
.vm_enabled
) {
2751 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2752 o
= zmalloc(sizeof(*o
));
2754 o
= zmalloc(sizeof(*o
)-sizeof(struct redisObjectVM
));
2758 o
->encoding
= REDIS_ENCODING_RAW
;
2761 if (server
.vm_enabled
) {
2762 /* Note that this code may run in the context of an I/O thread
2763 * and accessing to server.unixtime in theory is an error
2764 * (no locks). But in practice this is safe, and even if we read
2765 * garbage Redis will not fail, as it's just a statistical info */
2766 o
->vm
.atime
= server
.unixtime
;
2767 o
->storage
= REDIS_VM_MEMORY
;
2772 static robj
*createStringObject(char *ptr
, size_t len
) {
2773 return createObject(REDIS_STRING
,sdsnewlen(ptr
,len
));
2776 static robj
*dupStringObject(robj
*o
) {
2777 assert(o
->encoding
== REDIS_ENCODING_RAW
);
2778 return createStringObject(o
->ptr
,sdslen(o
->ptr
));
2781 static robj
*createListObject(void) {
2782 list
*l
= listCreate();
2784 listSetFreeMethod(l
,decrRefCount
);
2785 return createObject(REDIS_LIST
,l
);
2788 static robj
*createSetObject(void) {
2789 dict
*d
= dictCreate(&setDictType
,NULL
);
2790 return createObject(REDIS_SET
,d
);
2793 static robj
*createHashObject(void) {
2794 /* All the Hashes start as zipmaps. Will be automatically converted
2795 * into hash tables if there are enough elements or big elements
2797 unsigned char *zm
= zipmapNew();
2798 robj
*o
= createObject(REDIS_HASH
,zm
);
2799 o
->encoding
= REDIS_ENCODING_ZIPMAP
;
2803 static robj
*createZsetObject(void) {
2804 zset
*zs
= zmalloc(sizeof(*zs
));
2806 zs
->dict
= dictCreate(&zsetDictType
,NULL
);
2807 zs
->zsl
= zslCreate();
2808 return createObject(REDIS_ZSET
,zs
);
2811 static void freeStringObject(robj
*o
) {
2812 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2817 static void freeListObject(robj
*o
) {
2818 listRelease((list
*) o
->ptr
);
2821 static void freeSetObject(robj
*o
) {
2822 dictRelease((dict
*) o
->ptr
);
2825 static void freeZsetObject(robj
*o
) {
2828 dictRelease(zs
->dict
);
2833 static void freeHashObject(robj
*o
) {
2834 switch (o
->encoding
) {
2835 case REDIS_ENCODING_HT
:
2836 dictRelease((dict
*) o
->ptr
);
2838 case REDIS_ENCODING_ZIPMAP
:
2847 static void incrRefCount(robj
*o
) {
2851 static void decrRefCount(void *obj
) {
2854 /* Object is a key of a swapped out value, or in the process of being
2856 if (server
.vm_enabled
&&
2857 (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
))
2859 if (o
->storage
== REDIS_VM_LOADING
) vmCancelThreadedIOJob(obj
);
2860 redisAssert(o
->type
== REDIS_STRING
);
2861 freeStringObject(o
);
2862 vmMarkPagesFree(o
->vm
.page
,o
->vm
.usedpages
);
2863 pthread_mutex_lock(&server
.obj_freelist_mutex
);
2864 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2865 !listAddNodeHead(server
.objfreelist
,o
))
2867 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2868 server
.vm_stats_swapped_objects
--;
2871 /* Object is in memory, or in the process of being swapped out. */
2872 if (--(o
->refcount
) == 0) {
2873 if (server
.vm_enabled
&& o
->storage
== REDIS_VM_SWAPPING
)
2874 vmCancelThreadedIOJob(obj
);
2876 case REDIS_STRING
: freeStringObject(o
); break;
2877 case REDIS_LIST
: freeListObject(o
); break;
2878 case REDIS_SET
: freeSetObject(o
); break;
2879 case REDIS_ZSET
: freeZsetObject(o
); break;
2880 case REDIS_HASH
: freeHashObject(o
); break;
2881 default: redisAssert(0); break;
2883 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2884 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2885 !listAddNodeHead(server
.objfreelist
,o
))
2887 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2891 static robj
*lookupKey(redisDb
*db
, robj
*key
) {
2892 dictEntry
*de
= dictFind(db
->dict
,key
);
2894 robj
*key
= dictGetEntryKey(de
);
2895 robj
*val
= dictGetEntryVal(de
);
2897 if (server
.vm_enabled
) {
2898 if (key
->storage
== REDIS_VM_MEMORY
||
2899 key
->storage
== REDIS_VM_SWAPPING
)
2901 /* If we were swapping the object out, stop it, this key
2903 if (key
->storage
== REDIS_VM_SWAPPING
)
2904 vmCancelThreadedIOJob(key
);
2905 /* Update the access time of the key for the aging algorithm. */
2906 key
->vm
.atime
= server
.unixtime
;
2908 int notify
= (key
->storage
== REDIS_VM_LOADING
);
2910 /* Our value was swapped on disk. Bring it at home. */
2911 redisAssert(val
== NULL
);
2912 val
= vmLoadObject(key
);
2913 dictGetEntryVal(de
) = val
;
2915 /* Clients blocked by the VM subsystem may be waiting for
2917 if (notify
) handleClientsBlockedOnSwappedKey(db
,key
);
2926 static robj
*lookupKeyRead(redisDb
*db
, robj
*key
) {
2927 expireIfNeeded(db
,key
);
2928 return lookupKey(db
,key
);
2931 static robj
*lookupKeyWrite(redisDb
*db
, robj
*key
) {
2932 deleteIfVolatile(db
,key
);
2933 return lookupKey(db
,key
);
2936 static robj
*lookupKeyReadOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
2937 robj
*o
= lookupKeyRead(c
->db
, key
);
2938 if (!o
) addReply(c
,reply
);
2942 static robj
*lookupKeyWriteOrReply(redisClient
*c
, robj
*key
, robj
*reply
) {
2943 robj
*o
= lookupKeyWrite(c
->db
, key
);
2944 if (!o
) addReply(c
,reply
);
2948 static int checkType(redisClient
*c
, robj
*o
, int type
) {
2949 if (o
->type
!= type
) {
2950 addReply(c
,shared
.wrongtypeerr
);
2956 static int deleteKey(redisDb
*db
, robj
*key
) {
2959 /* We need to protect key from destruction: after the first dictDelete()
2960 * it may happen that 'key' is no longer valid if we don't increment
2961 * it's count. This may happen when we get the object reference directly
2962 * from the hash table with dictRandomKey() or dict iterators */
2964 if (dictSize(db
->expires
)) dictDelete(db
->expires
,key
);
2965 retval
= dictDelete(db
->dict
,key
);
2968 return retval
== DICT_OK
;
2971 /* Check if the nul-terminated string 's' can be represented by a long
2972 * (that is, is a number that fits into long without any other space or
2973 * character before or after the digits).
2975 * If so, the function returns REDIS_OK and *longval is set to the value
2976 * of the number. Otherwise REDIS_ERR is returned */
2977 static int isStringRepresentableAsLong(sds s
, long *longval
) {
2978 char buf
[32], *endptr
;
2982 value
= strtol(s
, &endptr
, 10);
2983 if (endptr
[0] != '\0') return REDIS_ERR
;
2984 slen
= snprintf(buf
,32,"%ld",value
);
2986 /* If the number converted back into a string is not identical
2987 * then it's not possible to encode the string as integer */
2988 if (sdslen(s
) != (unsigned)slen
|| memcmp(buf
,s
,slen
)) return REDIS_ERR
;
2989 if (longval
) *longval
= value
;
2993 /* Try to encode a string object in order to save space */
2994 static robj
*tryObjectEncoding(robj
*o
) {
2998 if (o
->encoding
!= REDIS_ENCODING_RAW
)
2999 return o
; /* Already encoded */
3001 /* It's not safe to encode shared objects: shared objects can be shared
3002 * everywhere in the "object space" of Redis. Encoded objects can only
3003 * appear as "values" (and not, for instance, as keys) */
3004 if (o
->refcount
> 1) return o
;
3006 /* Currently we try to encode only strings */
3007 redisAssert(o
->type
== REDIS_STRING
);
3009 /* Check if we can represent this string as a long integer */
3010 if (isStringRepresentableAsLong(s
,&value
) == REDIS_ERR
) return o
;
3012 /* Ok, this object can be encoded */
3013 if (value
>= 0 && value
< REDIS_SHARED_INTEGERS
) {
3015 incrRefCount(shared
.integers
[value
]);
3016 return shared
.integers
[value
];
3018 o
->encoding
= REDIS_ENCODING_INT
;
3020 o
->ptr
= (void*) value
;
3025 /* Get a decoded version of an encoded object (returned as a new object).
3026 * If the object is already raw-encoded just increment the ref count. */
3027 static robj
*getDecodedObject(robj
*o
) {
3030 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3034 if (o
->type
== REDIS_STRING
&& o
->encoding
== REDIS_ENCODING_INT
) {
3037 snprintf(buf
,32,"%ld",(long)o
->ptr
);
3038 dec
= createStringObject(buf
,strlen(buf
));
3041 redisAssert(1 != 1);
3045 /* Compare two string objects via strcmp() or alike.
3046 * Note that the objects may be integer-encoded. In such a case we
3047 * use snprintf() to get a string representation of the numbers on the stack
3048 * and compare the strings, it's much faster than calling getDecodedObject().
3050 * Important note: if objects are not integer encoded, but binary-safe strings,
3051 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
3053 static int compareStringObjects(robj
*a
, robj
*b
) {
3054 redisAssert(a
->type
== REDIS_STRING
&& b
->type
== REDIS_STRING
);
3055 char bufa
[128], bufb
[128], *astr
, *bstr
;
3058 if (a
== b
) return 0;
3059 if (a
->encoding
!= REDIS_ENCODING_RAW
) {
3060 snprintf(bufa
,sizeof(bufa
),"%ld",(long) a
->ptr
);
3066 if (b
->encoding
!= REDIS_ENCODING_RAW
) {
3067 snprintf(bufb
,sizeof(bufb
),"%ld",(long) b
->ptr
);
3073 return bothsds
? sdscmp(astr
,bstr
) : strcmp(astr
,bstr
);
3076 static size_t stringObjectLen(robj
*o
) {
3077 redisAssert(o
->type
== REDIS_STRING
);
3078 if (o
->encoding
== REDIS_ENCODING_RAW
) {
3079 return sdslen(o
->ptr
);
3083 return snprintf(buf
,32,"%ld",(long)o
->ptr
);
3087 static int getDoubleFromObject(redisClient
*c
, robj
*o
, double *value
) {
3091 if (o
&& o
->type
!= REDIS_STRING
) {
3092 addReplySds(c
,sdsnew("-ERR value is not a double\r\n"));
3098 else if (o
->encoding
== REDIS_ENCODING_RAW
)
3099 parsedValue
= strtod(o
->ptr
, &eptr
);
3100 else if (o
->encoding
== REDIS_ENCODING_INT
)
3101 parsedValue
= (long)o
->ptr
;
3103 redisAssert(1 != 1);
3105 if (eptr
!= NULL
&& *eptr
!= '\0') {
3106 addReplySds(c
,sdsnew("-ERR value is not a double\r\n"));
3110 *value
= parsedValue
;
3115 static int getLongLongFromObject(redisClient
*c
, robj
*o
, long long *value
) {
3116 long long parsedValue
;
3119 if (o
&& o
->type
!= REDIS_STRING
) {
3120 addReplySds(c
,sdsnew("-ERR value is not an integer\r\n"));
3126 else if (o
->encoding
== REDIS_ENCODING_RAW
)
3127 parsedValue
= strtoll(o
->ptr
, &eptr
, 10);
3128 else if (o
->encoding
== REDIS_ENCODING_INT
)
3129 parsedValue
= (long)o
->ptr
;
3131 redisAssert(1 != 1);
3133 if (eptr
!= NULL
&& *eptr
!= '\0') {
3134 addReplySds(c
,sdsnew("-ERR value is not an integer\r\n"));
3138 *value
= parsedValue
;
3143 static int getLongFromObject(redisClient
*c
, robj
*o
, long *value
) {
3144 long long actualValue
;
3146 if (getLongLongFromObject(c
, o
, &actualValue
) != REDIS_OK
) return REDIS_ERR
;
3148 if (actualValue
< LONG_MIN
|| actualValue
> LONG_MAX
) {
3149 addReplySds(c
,sdsnew("-ERR value is out of range\r\n"));
3153 *value
= actualValue
;
3158 /*============================ RDB saving/loading =========================== */
3160 static int rdbSaveType(FILE *fp
, unsigned char type
) {
3161 if (fwrite(&type
,1,1,fp
) == 0) return -1;
3165 static int rdbSaveTime(FILE *fp
, time_t t
) {
3166 int32_t t32
= (int32_t) t
;
3167 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
3171 /* check rdbLoadLen() comments for more info */
3172 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
3173 unsigned char buf
[2];
3176 /* Save a 6 bit len */
3177 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
3178 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3179 } else if (len
< (1<<14)) {
3180 /* Save a 14 bit len */
3181 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
3183 if (fwrite(buf
,2,1,fp
) == 0) return -1;
3185 /* Save a 32 bit len */
3186 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
3187 if (fwrite(buf
,1,1,fp
) == 0) return -1;
3189 if (fwrite(&len
,4,1,fp
) == 0) return -1;
3194 /* String objects in the form "2391" "-100" without any space and with a
3195 * range of values that can fit in an 8, 16 or 32 bit signed value can be
3196 * encoded as integers to save space */
3197 static int rdbTryIntegerEncoding(char *s
, size_t len
, unsigned char *enc
) {
3199 char *endptr
, buf
[32];
3201 /* Check if it's possible to encode this value as a number */
3202 value
= strtoll(s
, &endptr
, 10);
3203 if (endptr
[0] != '\0') return 0;
3204 snprintf(buf
,32,"%lld",value
);
3206 /* If the number converted back into a string is not identical
3207 * then it's not possible to encode the string as integer */
3208 if (strlen(buf
) != len
|| memcmp(buf
,s
,len
)) return 0;
3210 /* Finally check if it fits in our ranges */
3211 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
3212 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
3213 enc
[1] = value
&0xFF;
3215 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
3216 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
3217 enc
[1] = value
&0xFF;
3218 enc
[2] = (value
>>8)&0xFF;
3220 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
3221 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
3222 enc
[1] = value
&0xFF;
3223 enc
[2] = (value
>>8)&0xFF;
3224 enc
[3] = (value
>>16)&0xFF;
3225 enc
[4] = (value
>>24)&0xFF;
3232 static int rdbSaveLzfStringObject(FILE *fp
, unsigned char *s
, size_t len
) {
3233 size_t comprlen
, outlen
;
3237 /* We require at least four bytes compression for this to be worth it */
3238 if (len
<= 4) return 0;
3240 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
3241 comprlen
= lzf_compress(s
, len
, out
, outlen
);
3242 if (comprlen
== 0) {
3246 /* Data compressed! Let's save it on disk */
3247 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
3248 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
3249 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
3250 if (rdbSaveLen(fp
,len
) == -1) goto writeerr
;
3251 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
3260 /* Save a string objet as [len][data] on disk. If the object is a string
3261 * representation of an integer value we try to safe it in a special form */
3262 static int rdbSaveRawString(FILE *fp
, unsigned char *s
, size_t len
) {
3265 /* Try integer encoding */
3267 unsigned char buf
[5];
3268 if ((enclen
= rdbTryIntegerEncoding((char*)s
,len
,buf
)) > 0) {
3269 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
3274 /* Try LZF compression - under 20 bytes it's unable to compress even
3275 * aaaaaaaaaaaaaaaaaa so skip it */
3276 if (server
.rdbcompression
&& len
> 20) {
3279 retval
= rdbSaveLzfStringObject(fp
,s
,len
);
3280 if (retval
== -1) return -1;
3281 if (retval
> 0) return 0;
3282 /* retval == 0 means data can't be compressed, save the old way */
3285 /* Store verbatim */
3286 if (rdbSaveLen(fp
,len
) == -1) return -1;
3287 if (len
&& fwrite(s
,len
,1,fp
) == 0) return -1;
3291 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
3292 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
3295 /* Avoid incr/decr ref count business when possible.
3296 * This plays well with copy-on-write given that we are probably
3297 * in a child process (BGSAVE). Also this makes sure key objects
3298 * of swapped objects are not incRefCount-ed (an assert does not allow
3299 * this in order to avoid bugs) */
3300 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
3301 obj
= getDecodedObject(obj
);
3302 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3305 retval
= rdbSaveRawString(fp
,obj
->ptr
,sdslen(obj
->ptr
));
3310 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
3311 * 8 bit integer specifing the length of the representation.
3312 * This 8 bit integer has special values in order to specify the following
3318 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
3319 unsigned char buf
[128];
3325 } else if (!isfinite(val
)) {
3327 buf
[0] = (val
< 0) ? 255 : 254;
3329 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
3330 buf
[0] = strlen((char*)buf
+1);
3333 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
3337 /* Save a Redis object. */
3338 static int rdbSaveObject(FILE *fp
, robj
*o
) {
3339 if (o
->type
== REDIS_STRING
) {
3340 /* Save a string value */
3341 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
3342 } else if (o
->type
== REDIS_LIST
) {
3343 /* Save a list value */
3344 list
*list
= o
->ptr
;
3348 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
3349 listRewind(list
,&li
);
3350 while((ln
= listNext(&li
))) {
3351 robj
*eleobj
= listNodeValue(ln
);
3353 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3355 } else if (o
->type
== REDIS_SET
) {
3356 /* Save a set value */
3358 dictIterator
*di
= dictGetIterator(set
);
3361 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
3362 while((de
= dictNext(di
)) != NULL
) {
3363 robj
*eleobj
= dictGetEntryKey(de
);
3365 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3367 dictReleaseIterator(di
);
3368 } else if (o
->type
== REDIS_ZSET
) {
3369 /* Save a set value */
3371 dictIterator
*di
= dictGetIterator(zs
->dict
);
3374 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
3375 while((de
= dictNext(di
)) != NULL
) {
3376 robj
*eleobj
= dictGetEntryKey(de
);
3377 double *score
= dictGetEntryVal(de
);
3379 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3380 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
3382 dictReleaseIterator(di
);
3383 } else if (o
->type
== REDIS_HASH
) {
3384 /* Save a hash value */
3385 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3386 unsigned char *p
= zipmapRewind(o
->ptr
);
3387 unsigned int count
= zipmapLen(o
->ptr
);
3388 unsigned char *key
, *val
;
3389 unsigned int klen
, vlen
;
3391 if (rdbSaveLen(fp
,count
) == -1) return -1;
3392 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
3393 if (rdbSaveRawString(fp
,key
,klen
) == -1) return -1;
3394 if (rdbSaveRawString(fp
,val
,vlen
) == -1) return -1;
3397 dictIterator
*di
= dictGetIterator(o
->ptr
);
3400 if (rdbSaveLen(fp
,dictSize((dict
*)o
->ptr
)) == -1) return -1;
3401 while((de
= dictNext(di
)) != NULL
) {
3402 robj
*key
= dictGetEntryKey(de
);
3403 robj
*val
= dictGetEntryVal(de
);
3405 if (rdbSaveStringObject(fp
,key
) == -1) return -1;
3406 if (rdbSaveStringObject(fp
,val
) == -1) return -1;
3408 dictReleaseIterator(di
);
3416 /* Return the length the object will have on disk if saved with
3417 * the rdbSaveObject() function. Currently we use a trick to get
3418 * this length with very little changes to the code. In the future
3419 * we could switch to a faster solution. */
3420 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
3421 if (fp
== NULL
) fp
= server
.devnull
;
3423 assert(rdbSaveObject(fp
,o
) != 1);
3427 /* Return the number of pages required to save this object in the swap file */
3428 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
3429 off_t bytes
= rdbSavedObjectLen(o
,fp
);
3431 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
3434 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3435 static int rdbSave(char *filename
) {
3436 dictIterator
*di
= NULL
;
3441 time_t now
= time(NULL
);
3443 /* Wait for I/O therads to terminate, just in case this is a
3444 * foreground-saving, to avoid seeking the swap file descriptor at the
3446 if (server
.vm_enabled
)
3447 waitEmptyIOJobsQueue();
3449 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3450 fp
= fopen(tmpfile
,"w");
3452 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3455 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3456 for (j
= 0; j
< server
.dbnum
; j
++) {
3457 redisDb
*db
= server
.db
+j
;
3459 if (dictSize(d
) == 0) continue;
3460 di
= dictGetIterator(d
);
3466 /* Write the SELECT DB opcode */
3467 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3468 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3470 /* Iterate this DB writing every entry */
3471 while((de
= dictNext(di
)) != NULL
) {
3472 robj
*key
= dictGetEntryKey(de
);
3473 robj
*o
= dictGetEntryVal(de
);
3474 time_t expiretime
= getExpire(db
,key
);
3476 /* Save the expire time */
3477 if (expiretime
!= -1) {
3478 /* If this key is already expired skip it */
3479 if (expiretime
< now
) continue;
3480 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3481 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3483 /* Save the key and associated value. This requires special
3484 * handling if the value is swapped out. */
3485 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
3486 key
->storage
== REDIS_VM_SWAPPING
) {
3487 /* Save type, key, value */
3488 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3489 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3490 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3492 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3494 /* Get a preview of the object in memory */
3495 po
= vmPreviewObject(key
);
3496 /* Save type, key, value */
3497 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
3498 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3499 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3500 /* Remove the loaded object from memory */
3504 dictReleaseIterator(di
);
3507 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3509 /* Make sure data will not remain on the OS's output buffers */
3514 /* Use RENAME to make sure the DB file is changed atomically only
3515 * if the generate DB file is ok. */
3516 if (rename(tmpfile
,filename
) == -1) {
3517 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3521 redisLog(REDIS_NOTICE
,"DB saved on disk");
3523 server
.lastsave
= time(NULL
);
3529 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3530 if (di
) dictReleaseIterator(di
);
3534 static int rdbSaveBackground(char *filename
) {
3537 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3538 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
3539 if ((childpid
= fork()) == 0) {
3541 if (server
.vm_enabled
) vmReopenSwapFile();
3543 if (rdbSave(filename
) == REDIS_OK
) {
3550 if (childpid
== -1) {
3551 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3555 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3556 server
.bgsavechildpid
= childpid
;
3557 updateDictResizePolicy();
3560 return REDIS_OK
; /* unreached */
3563 static void rdbRemoveTempFile(pid_t childpid
) {
3566 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
3570 static int rdbLoadType(FILE *fp
) {
3572 if (fread(&type
,1,1,fp
) == 0) return -1;
3576 static time_t rdbLoadTime(FILE *fp
) {
3578 if (fread(&t32
,4,1,fp
) == 0) return -1;
3579 return (time_t) t32
;
3582 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3583 * of this file for a description of how this are stored on disk.
3585 * isencoded is set to 1 if the readed length is not actually a length but
3586 * an "encoding type", check the above comments for more info */
3587 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3588 unsigned char buf
[2];
3592 if (isencoded
) *isencoded
= 0;
3593 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3594 type
= (buf
[0]&0xC0)>>6;
3595 if (type
== REDIS_RDB_6BITLEN
) {
3596 /* Read a 6 bit len */
3598 } else if (type
== REDIS_RDB_ENCVAL
) {
3599 /* Read a 6 bit len encoding type */
3600 if (isencoded
) *isencoded
= 1;
3602 } else if (type
== REDIS_RDB_14BITLEN
) {
3603 /* Read a 14 bit len */
3604 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3605 return ((buf
[0]&0x3F)<<8)|buf
[1];
3607 /* Read a 32 bit len */
3608 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3613 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
) {
3614 unsigned char enc
[4];
3617 if (enctype
== REDIS_RDB_ENC_INT8
) {
3618 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3619 val
= (signed char)enc
[0];
3620 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3622 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3623 v
= enc
[0]|(enc
[1]<<8);
3625 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3627 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3628 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3631 val
= 0; /* anti-warning */
3634 return createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",val
));
3637 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3638 unsigned int len
, clen
;
3639 unsigned char *c
= NULL
;
3642 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3643 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3644 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3645 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3646 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3647 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3649 return createObject(REDIS_STRING
,val
);
3656 static robj
*rdbLoadStringObject(FILE*fp
) {
3661 len
= rdbLoadLen(fp
,&isencoded
);
3664 case REDIS_RDB_ENC_INT8
:
3665 case REDIS_RDB_ENC_INT16
:
3666 case REDIS_RDB_ENC_INT32
:
3667 return rdbLoadIntegerObject(fp
,len
);
3668 case REDIS_RDB_ENC_LZF
:
3669 return rdbLoadLzfStringObject(fp
);
3675 if (len
== REDIS_RDB_LENERR
) return NULL
;
3676 val
= sdsnewlen(NULL
,len
);
3677 if (len
&& fread(val
,len
,1,fp
) == 0) {
3681 return createObject(REDIS_STRING
,val
);
3684 /* For information about double serialization check rdbSaveDoubleValue() */
3685 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
3689 if (fread(&len
,1,1,fp
) == 0) return -1;
3691 case 255: *val
= R_NegInf
; return 0;
3692 case 254: *val
= R_PosInf
; return 0;
3693 case 253: *val
= R_Nan
; return 0;
3695 if (fread(buf
,len
,1,fp
) == 0) return -1;
3697 sscanf(buf
, "%lg", val
);
3702 /* Load a Redis object of the specified type from the specified file.
3703 * On success a newly allocated object is returned, otherwise NULL. */
3704 static robj
*rdbLoadObject(int type
, FILE *fp
) {
3707 redisLog(REDIS_DEBUG
,"LOADING OBJECT %d (at %d)\n",type
,ftell(fp
));
3708 if (type
== REDIS_STRING
) {
3709 /* Read string value */
3710 if ((o
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3711 o
= tryObjectEncoding(o
);
3712 } else if (type
== REDIS_LIST
|| type
== REDIS_SET
) {
3713 /* Read list/set value */
3716 if ((listlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3717 o
= (type
== REDIS_LIST
) ? createListObject() : createSetObject();
3718 /* It's faster to expand the dict to the right size asap in order
3719 * to avoid rehashing */
3720 if (type
== REDIS_SET
&& listlen
> DICT_HT_INITIAL_SIZE
)
3721 dictExpand(o
->ptr
,listlen
);
3722 /* Load every single element of the list/set */
3726 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3727 ele
= tryObjectEncoding(ele
);
3728 if (type
== REDIS_LIST
) {
3729 listAddNodeTail((list
*)o
->ptr
,ele
);
3731 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
3734 } else if (type
== REDIS_ZSET
) {
3735 /* Read list/set value */
3739 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3740 o
= createZsetObject();
3742 /* Load every single element of the list/set */
3745 double *score
= zmalloc(sizeof(double));
3747 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3748 ele
= tryObjectEncoding(ele
);
3749 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
3750 dictAdd(zs
->dict
,ele
,score
);
3751 zslInsert(zs
->zsl
,*score
,ele
);
3752 incrRefCount(ele
); /* added to skiplist */
3754 } else if (type
== REDIS_HASH
) {
3757 if ((hashlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3758 o
= createHashObject();
3759 /* Too many entries? Use an hash table. */
3760 if (hashlen
> server
.hash_max_zipmap_entries
)
3761 convertToRealHash(o
);
3762 /* Load every key/value, then set it into the zipmap or hash
3763 * table, as needed. */
3767 if ((key
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3768 if ((val
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3769 /* If we are using a zipmap and there are too big values
3770 * the object is converted to real hash table encoding. */
3771 if (o
->encoding
!= REDIS_ENCODING_HT
&&
3772 (sdslen(key
->ptr
) > server
.hash_max_zipmap_value
||
3773 sdslen(val
->ptr
) > server
.hash_max_zipmap_value
))
3775 convertToRealHash(o
);
3778 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
3779 unsigned char *zm
= o
->ptr
;
3781 zm
= zipmapSet(zm
,key
->ptr
,sdslen(key
->ptr
),
3782 val
->ptr
,sdslen(val
->ptr
),NULL
);
3787 key
= tryObjectEncoding(key
);
3788 val
= tryObjectEncoding(val
);
3789 dictAdd((dict
*)o
->ptr
,key
,val
);
3798 static int rdbLoad(char *filename
) {
3800 robj
*keyobj
= NULL
;
3802 int type
, retval
, rdbver
;
3803 dict
*d
= server
.db
[0].dict
;
3804 redisDb
*db
= server
.db
+0;
3806 time_t expiretime
= -1, now
= time(NULL
);
3807 long long loadedkeys
= 0;
3809 fp
= fopen(filename
,"r");
3810 if (!fp
) return REDIS_ERR
;
3811 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
3813 if (memcmp(buf
,"REDIS",5) != 0) {
3815 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
3818 rdbver
= atoi(buf
+5);
3821 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
3828 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3829 if (type
== REDIS_EXPIRETIME
) {
3830 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
3831 /* We read the time so we need to read the object type again */
3832 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3834 if (type
== REDIS_EOF
) break;
3835 /* Handle SELECT DB opcode as a special case */
3836 if (type
== REDIS_SELECTDB
) {
3837 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
3839 if (dbid
>= (unsigned)server
.dbnum
) {
3840 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
3843 db
= server
.db
+dbid
;
3848 if ((keyobj
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
3850 if ((o
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
3851 /* Add the new object in the hash table */
3852 retval
= dictAdd(d
,keyobj
,o
);
3853 if (retval
== DICT_ERR
) {
3854 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", keyobj
->ptr
);
3857 /* Set the expire time if needed */
3858 if (expiretime
!= -1) {
3859 setExpire(db
,keyobj
,expiretime
);
3860 /* Delete this key if already expired */
3861 if (expiretime
< now
) deleteKey(db
,keyobj
);
3865 /* Handle swapping while loading big datasets when VM is on */
3867 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
3868 while (zmalloc_used_memory() > server
.vm_max_memory
) {
3869 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
3876 eoferr
: /* unexpected end of file is handled here with a fatal exit */
3877 if (keyobj
) decrRefCount(keyobj
);
3878 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
3880 return REDIS_ERR
; /* Just to avoid warning */
3883 /*================================== Commands =============================== */
3885 static void authCommand(redisClient
*c
) {
3886 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
3887 c
->authenticated
= 1;
3888 addReply(c
,shared
.ok
);
3890 c
->authenticated
= 0;
3891 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
3895 static void pingCommand(redisClient
*c
) {
3896 addReply(c
,shared
.pong
);
3899 static void echoCommand(redisClient
*c
) {
3900 addReplyBulk(c
,c
->argv
[1]);
3903 /*=================================== Strings =============================== */
3905 static void setGenericCommand(redisClient
*c
, int nx
) {
3908 if (nx
) deleteIfVolatile(c
->db
,c
->argv
[1]);
3909 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3910 if (retval
== DICT_ERR
) {
3912 /* If the key is about a swapped value, we want a new key object
3913 * to overwrite the old. So we delete the old key in the database.
3914 * This will also make sure that swap pages about the old object
3915 * will be marked as free. */
3916 if (server
.vm_enabled
&& deleteIfSwapped(c
->db
,c
->argv
[1]))
3917 incrRefCount(c
->argv
[1]);
3918 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3919 incrRefCount(c
->argv
[2]);
3921 addReply(c
,shared
.czero
);
3925 incrRefCount(c
->argv
[1]);
3926 incrRefCount(c
->argv
[2]);
3929 removeExpire(c
->db
,c
->argv
[1]);
3930 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3933 static void setCommand(redisClient
*c
) {
3934 setGenericCommand(c
,0);
3937 static void setnxCommand(redisClient
*c
) {
3938 setGenericCommand(c
,1);
3941 static int getGenericCommand(redisClient
*c
) {
3944 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
)
3947 if (o
->type
!= REDIS_STRING
) {
3948 addReply(c
,shared
.wrongtypeerr
);
3956 static void getCommand(redisClient
*c
) {
3957 getGenericCommand(c
);
3960 static void getsetCommand(redisClient
*c
) {
3961 if (getGenericCommand(c
) == REDIS_ERR
) return;
3962 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
3963 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3965 incrRefCount(c
->argv
[1]);
3967 incrRefCount(c
->argv
[2]);
3969 removeExpire(c
->db
,c
->argv
[1]);
3972 static void mgetCommand(redisClient
*c
) {
3975 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
3976 for (j
= 1; j
< c
->argc
; j
++) {
3977 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
3979 addReply(c
,shared
.nullbulk
);
3981 if (o
->type
!= REDIS_STRING
) {
3982 addReply(c
,shared
.nullbulk
);
3990 static void msetGenericCommand(redisClient
*c
, int nx
) {
3991 int j
, busykeys
= 0;
3993 if ((c
->argc
% 2) == 0) {
3994 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
3997 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
3998 * set nothing at all if at least one already key exists. */
4000 for (j
= 1; j
< c
->argc
; j
+= 2) {
4001 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
4007 addReply(c
, shared
.czero
);
4011 for (j
= 1; j
< c
->argc
; j
+= 2) {
4014 c
->argv
[j
+1] = tryObjectEncoding(c
->argv
[j
+1]);
4015 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
4016 if (retval
== DICT_ERR
) {
4017 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
4018 incrRefCount(c
->argv
[j
+1]);
4020 incrRefCount(c
->argv
[j
]);
4021 incrRefCount(c
->argv
[j
+1]);
4023 removeExpire(c
->db
,c
->argv
[j
]);
4025 server
.dirty
+= (c
->argc
-1)/2;
4026 addReply(c
, nx
? shared
.cone
: shared
.ok
);
4029 static void msetCommand(redisClient
*c
) {
4030 msetGenericCommand(c
,0);
4033 static void msetnxCommand(redisClient
*c
) {
4034 msetGenericCommand(c
,1);
4037 static void incrDecrCommand(redisClient
*c
, long long incr
) {
4042 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4044 if (getLongLongFromObject(c
, o
, &value
) != REDIS_OK
) return;
4047 o
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
4048 o
= tryObjectEncoding(o
);
4049 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
4050 if (retval
== DICT_ERR
) {
4051 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4052 removeExpire(c
->db
,c
->argv
[1]);
4054 incrRefCount(c
->argv
[1]);
4057 addReply(c
,shared
.colon
);
4059 addReply(c
,shared
.crlf
);
4062 static void incrCommand(redisClient
*c
) {
4063 incrDecrCommand(c
,1);
4066 static void decrCommand(redisClient
*c
) {
4067 incrDecrCommand(c
,-1);
4070 static void incrbyCommand(redisClient
*c
) {
4073 if (getLongLongFromObject(c
, c
->argv
[2], &incr
) != REDIS_OK
) return;
4075 incrDecrCommand(c
,incr
);
4078 static void decrbyCommand(redisClient
*c
) {
4081 if (getLongLongFromObject(c
, c
->argv
[2], &incr
) != REDIS_OK
) return;
4083 incrDecrCommand(c
,-incr
);
4086 static void appendCommand(redisClient
*c
) {
4091 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4093 /* Create the key */
4094 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
4095 incrRefCount(c
->argv
[1]);
4096 incrRefCount(c
->argv
[2]);
4097 totlen
= stringObjectLen(c
->argv
[2]);
4101 de
= dictFind(c
->db
->dict
,c
->argv
[1]);
4104 o
= dictGetEntryVal(de
);
4105 if (o
->type
!= REDIS_STRING
) {
4106 addReply(c
,shared
.wrongtypeerr
);
4109 /* If the object is specially encoded or shared we have to make
4111 if (o
->refcount
!= 1 || o
->encoding
!= REDIS_ENCODING_RAW
) {
4112 robj
*decoded
= getDecodedObject(o
);
4114 o
= createStringObject(decoded
->ptr
, sdslen(decoded
->ptr
));
4115 decrRefCount(decoded
);
4116 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
4119 if (c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
) {
4120 o
->ptr
= sdscatlen(o
->ptr
,
4121 c
->argv
[2]->ptr
, sdslen(c
->argv
[2]->ptr
));
4123 o
->ptr
= sdscatprintf(o
->ptr
, "%ld",
4124 (unsigned long) c
->argv
[2]->ptr
);
4126 totlen
= sdslen(o
->ptr
);
4129 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen
));
4132 static void substrCommand(redisClient
*c
) {
4134 long start
= atoi(c
->argv
[2]->ptr
);
4135 long end
= atoi(c
->argv
[3]->ptr
);
4136 size_t rangelen
, strlen
;
4139 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4140 checkType(c
,o
,REDIS_STRING
)) return;
4142 o
= getDecodedObject(o
);
4143 strlen
= sdslen(o
->ptr
);
4145 /* convert negative indexes */
4146 if (start
< 0) start
= strlen
+start
;
4147 if (end
< 0) end
= strlen
+end
;
4148 if (start
< 0) start
= 0;
4149 if (end
< 0) end
= 0;
4151 /* indexes sanity checks */
4152 if (start
> end
|| (size_t)start
>= strlen
) {
4153 /* Out of range start or start > end result in null reply */
4154 addReply(c
,shared
.nullbulk
);
4158 if ((size_t)end
>= strlen
) end
= strlen
-1;
4159 rangelen
= (end
-start
)+1;
4161 /* Return the result */
4162 addReplySds(c
,sdscatprintf(sdsempty(),"$%zu\r\n",rangelen
));
4163 range
= sdsnewlen((char*)o
->ptr
+start
,rangelen
);
4164 addReplySds(c
,range
);
4165 addReply(c
,shared
.crlf
);
4169 /* ========================= Type agnostic commands ========================= */
4171 static void delCommand(redisClient
*c
) {
4174 for (j
= 1; j
< c
->argc
; j
++) {
4175 if (deleteKey(c
->db
,c
->argv
[j
])) {
4180 addReplyLong(c
,deleted
);
4183 static void existsCommand(redisClient
*c
) {
4184 addReply(c
,lookupKeyRead(c
->db
,c
->argv
[1]) ? shared
.cone
: shared
.czero
);
4187 static void selectCommand(redisClient
*c
) {
4188 int id
= atoi(c
->argv
[1]->ptr
);
4190 if (selectDb(c
,id
) == REDIS_ERR
) {
4191 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
4193 addReply(c
,shared
.ok
);
4197 static void randomkeyCommand(redisClient
*c
) {
4201 de
= dictGetRandomKey(c
->db
->dict
);
4202 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
4205 addReply(c
,shared
.plus
);
4206 addReply(c
,shared
.crlf
);
4208 addReply(c
,shared
.plus
);
4209 addReply(c
,dictGetEntryKey(de
));
4210 addReply(c
,shared
.crlf
);
4214 static void keysCommand(redisClient
*c
) {
4217 sds pattern
= c
->argv
[1]->ptr
;
4218 int plen
= sdslen(pattern
);
4219 unsigned long numkeys
= 0;
4220 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
4222 di
= dictGetIterator(c
->db
->dict
);
4224 decrRefCount(lenobj
);
4225 while((de
= dictNext(di
)) != NULL
) {
4226 robj
*keyobj
= dictGetEntryKey(de
);
4228 sds key
= keyobj
->ptr
;
4229 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
4230 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
4231 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
4232 addReplyBulk(c
,keyobj
);
4237 dictReleaseIterator(di
);
4238 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",numkeys
);
4241 static void dbsizeCommand(redisClient
*c
) {
4243 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
4246 static void lastsaveCommand(redisClient
*c
) {
4248 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
4251 static void typeCommand(redisClient
*c
) {
4255 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4260 case REDIS_STRING
: type
= "+string"; break;
4261 case REDIS_LIST
: type
= "+list"; break;
4262 case REDIS_SET
: type
= "+set"; break;
4263 case REDIS_ZSET
: type
= "+zset"; break;
4264 case REDIS_HASH
: type
= "+hash"; break;
4265 default: type
= "+unknown"; break;
4268 addReplySds(c
,sdsnew(type
));
4269 addReply(c
,shared
.crlf
);
4272 static void saveCommand(redisClient
*c
) {
4273 if (server
.bgsavechildpid
!= -1) {
4274 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
4277 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4278 addReply(c
,shared
.ok
);
4280 addReply(c
,shared
.err
);
4284 static void bgsaveCommand(redisClient
*c
) {
4285 if (server
.bgsavechildpid
!= -1) {
4286 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
4289 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
4290 char *status
= "+Background saving started\r\n";
4291 addReplySds(c
,sdsnew(status
));
4293 addReply(c
,shared
.err
);
4297 static void shutdownCommand(redisClient
*c
) {
4298 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
4299 /* Kill the saving child if there is a background saving in progress.
4300 We want to avoid race conditions, for instance our saving child may
4301 overwrite the synchronous saving did by SHUTDOWN. */
4302 if (server
.bgsavechildpid
!= -1) {
4303 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
4304 kill(server
.bgsavechildpid
,SIGKILL
);
4305 rdbRemoveTempFile(server
.bgsavechildpid
);
4307 if (server
.appendonly
) {
4308 /* Append only file: fsync() the AOF and exit */
4309 fsync(server
.appendfd
);
4310 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4313 /* Snapshotting. Perform a SYNC SAVE and exit */
4314 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
4315 if (server
.daemonize
)
4316 unlink(server
.pidfile
);
4317 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
4318 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
4319 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
4322 /* Ooops.. error saving! The best we can do is to continue
4323 * operating. Note that if there was a background saving process,
4324 * in the next cron() Redis will be notified that the background
4325 * saving aborted, handling special stuff like slaves pending for
4326 * synchronization... */
4327 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
4329 sdsnew("-ERR can't quit, problems saving the DB\r\n"));
4334 static void renameGenericCommand(redisClient
*c
, int nx
) {
4337 /* To use the same key as src and dst is probably an error */
4338 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
4339 addReply(c
,shared
.sameobjecterr
);
4343 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
)
4347 deleteIfVolatile(c
->db
,c
->argv
[2]);
4348 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
4351 addReply(c
,shared
.czero
);
4354 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
4356 incrRefCount(c
->argv
[2]);
4358 deleteKey(c
->db
,c
->argv
[1]);
4360 addReply(c
,nx
? shared
.cone
: shared
.ok
);
4363 static void renameCommand(redisClient
*c
) {
4364 renameGenericCommand(c
,0);
4367 static void renamenxCommand(redisClient
*c
) {
4368 renameGenericCommand(c
,1);
4371 static void moveCommand(redisClient
*c
) {
4376 /* Obtain source and target DB pointers */
4379 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
4380 addReply(c
,shared
.outofrangeerr
);
4384 selectDb(c
,srcid
); /* Back to the source DB */
4386 /* If the user is moving using as target the same
4387 * DB as the source DB it is probably an error. */
4389 addReply(c
,shared
.sameobjecterr
);
4393 /* Check if the element exists and get a reference */
4394 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4396 addReply(c
,shared
.czero
);
4400 /* Try to add the element to the target DB */
4401 deleteIfVolatile(dst
,c
->argv
[1]);
4402 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
4403 addReply(c
,shared
.czero
);
4406 incrRefCount(c
->argv
[1]);
4409 /* OK! key moved, free the entry in the source DB */
4410 deleteKey(src
,c
->argv
[1]);
4412 addReply(c
,shared
.cone
);
4415 /* =================================== Lists ================================ */
4416 static void pushGenericCommand(redisClient
*c
, int where
) {
4420 lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4422 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4423 addReply(c
,shared
.cone
);
4426 lobj
= createListObject();
4428 if (where
== REDIS_HEAD
) {
4429 listAddNodeHead(list
,c
->argv
[2]);
4431 listAddNodeTail(list
,c
->argv
[2]);
4433 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
4434 incrRefCount(c
->argv
[1]);
4435 incrRefCount(c
->argv
[2]);
4437 if (lobj
->type
!= REDIS_LIST
) {
4438 addReply(c
,shared
.wrongtypeerr
);
4441 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4442 addReply(c
,shared
.cone
);
4446 if (where
== REDIS_HEAD
) {
4447 listAddNodeHead(list
,c
->argv
[2]);
4449 listAddNodeTail(list
,c
->argv
[2]);
4451 incrRefCount(c
->argv
[2]);
4454 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",listLength(list
)));
4457 static void lpushCommand(redisClient
*c
) {
4458 pushGenericCommand(c
,REDIS_HEAD
);
4461 static void rpushCommand(redisClient
*c
) {
4462 pushGenericCommand(c
,REDIS_TAIL
);
4465 static void llenCommand(redisClient
*c
) {
4469 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4470 checkType(c
,o
,REDIS_LIST
)) return;
4473 addReplyUlong(c
,listLength(l
));
4476 static void lindexCommand(redisClient
*c
) {
4478 int index
= atoi(c
->argv
[2]->ptr
);
4482 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4483 checkType(c
,o
,REDIS_LIST
)) return;
4486 ln
= listIndex(list
, index
);
4488 addReply(c
,shared
.nullbulk
);
4490 robj
*ele
= listNodeValue(ln
);
4491 addReplyBulk(c
,ele
);
4495 static void lsetCommand(redisClient
*c
) {
4497 int index
= atoi(c
->argv
[2]->ptr
);
4501 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nokeyerr
)) == NULL
||
4502 checkType(c
,o
,REDIS_LIST
)) return;
4505 ln
= listIndex(list
, index
);
4507 addReply(c
,shared
.outofrangeerr
);
4509 robj
*ele
= listNodeValue(ln
);
4512 listNodeValue(ln
) = c
->argv
[3];
4513 incrRefCount(c
->argv
[3]);
4514 addReply(c
,shared
.ok
);
4519 static void popGenericCommand(redisClient
*c
, int where
) {
4524 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4525 checkType(c
,o
,REDIS_LIST
)) return;
4528 if (where
== REDIS_HEAD
)
4529 ln
= listFirst(list
);
4531 ln
= listLast(list
);
4534 addReply(c
,shared
.nullbulk
);
4536 robj
*ele
= listNodeValue(ln
);
4537 addReplyBulk(c
,ele
);
4538 listDelNode(list
,ln
);
4539 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4544 static void lpopCommand(redisClient
*c
) {
4545 popGenericCommand(c
,REDIS_HEAD
);
4548 static void rpopCommand(redisClient
*c
) {
4549 popGenericCommand(c
,REDIS_TAIL
);
4552 static void lrangeCommand(redisClient
*c
) {
4554 int start
= atoi(c
->argv
[2]->ptr
);
4555 int end
= atoi(c
->argv
[3]->ptr
);
4562 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
4563 || checkType(c
,o
,REDIS_LIST
)) return;
4565 llen
= listLength(list
);
4567 /* convert negative indexes */
4568 if (start
< 0) start
= llen
+start
;
4569 if (end
< 0) end
= llen
+end
;
4570 if (start
< 0) start
= 0;
4571 if (end
< 0) end
= 0;
4573 /* indexes sanity checks */
4574 if (start
> end
|| start
>= llen
) {
4575 /* Out of range start or start > end result in empty list */
4576 addReply(c
,shared
.emptymultibulk
);
4579 if (end
>= llen
) end
= llen
-1;
4580 rangelen
= (end
-start
)+1;
4582 /* Return the result in form of a multi-bulk reply */
4583 ln
= listIndex(list
, start
);
4584 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
4585 for (j
= 0; j
< rangelen
; j
++) {
4586 ele
= listNodeValue(ln
);
4587 addReplyBulk(c
,ele
);
4592 static void ltrimCommand(redisClient
*c
) {
4594 int start
= atoi(c
->argv
[2]->ptr
);
4595 int end
= atoi(c
->argv
[3]->ptr
);
4597 int j
, ltrim
, rtrim
;
4601 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.ok
)) == NULL
||
4602 checkType(c
,o
,REDIS_LIST
)) return;
4604 llen
= listLength(list
);
4606 /* convert negative indexes */
4607 if (start
< 0) start
= llen
+start
;
4608 if (end
< 0) end
= llen
+end
;
4609 if (start
< 0) start
= 0;
4610 if (end
< 0) end
= 0;
4612 /* indexes sanity checks */
4613 if (start
> end
|| start
>= llen
) {
4614 /* Out of range start or start > end result in empty list */
4618 if (end
>= llen
) end
= llen
-1;
4623 /* Remove list elements to perform the trim */
4624 for (j
= 0; j
< ltrim
; j
++) {
4625 ln
= listFirst(list
);
4626 listDelNode(list
,ln
);
4628 for (j
= 0; j
< rtrim
; j
++) {
4629 ln
= listLast(list
);
4630 listDelNode(list
,ln
);
4632 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4634 addReply(c
,shared
.ok
);
4637 static void lremCommand(redisClient
*c
) {
4640 listNode
*ln
, *next
;
4641 int toremove
= atoi(c
->argv
[2]->ptr
);
4645 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4646 checkType(c
,o
,REDIS_LIST
)) return;
4650 toremove
= -toremove
;
4653 ln
= fromtail
? list
->tail
: list
->head
;
4655 robj
*ele
= listNodeValue(ln
);
4657 next
= fromtail
? ln
->prev
: ln
->next
;
4658 if (compareStringObjects(ele
,c
->argv
[3]) == 0) {
4659 listDelNode(list
,ln
);
4662 if (toremove
&& removed
== toremove
) break;
4666 if (listLength(list
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4667 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
4670 /* This is the semantic of this command:
4671 * RPOPLPUSH srclist dstlist:
4672 * IF LLEN(srclist) > 0
4673 * element = RPOP srclist
4674 * LPUSH dstlist element
4681 * The idea is to be able to get an element from a list in a reliable way
4682 * since the element is not just returned but pushed against another list
4683 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4685 static void rpoplpushcommand(redisClient
*c
) {
4690 if ((sobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4691 checkType(c
,sobj
,REDIS_LIST
)) return;
4692 srclist
= sobj
->ptr
;
4693 ln
= listLast(srclist
);
4696 addReply(c
,shared
.nullbulk
);
4698 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4699 robj
*ele
= listNodeValue(ln
);
4702 if (dobj
&& dobj
->type
!= REDIS_LIST
) {
4703 addReply(c
,shared
.wrongtypeerr
);
4707 /* Add the element to the target list (unless it's directly
4708 * passed to some BLPOP-ing client */
4709 if (!handleClientsWaitingListPush(c
,c
->argv
[2],ele
)) {
4711 /* Create the list if the key does not exist */
4712 dobj
= createListObject();
4713 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
4714 incrRefCount(c
->argv
[2]);
4716 dstlist
= dobj
->ptr
;
4717 listAddNodeHead(dstlist
,ele
);
4721 /* Send the element to the client as reply as well */
4722 addReplyBulk(c
,ele
);
4724 /* Finally remove the element from the source list */
4725 listDelNode(srclist
,ln
);
4726 if (listLength(srclist
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4731 /* ==================================== Sets ================================ */
4733 static void saddCommand(redisClient
*c
) {
4736 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4738 set
= createSetObject();
4739 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
4740 incrRefCount(c
->argv
[1]);
4742 if (set
->type
!= REDIS_SET
) {
4743 addReply(c
,shared
.wrongtypeerr
);
4747 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
4748 incrRefCount(c
->argv
[2]);
4750 addReply(c
,shared
.cone
);
4752 addReply(c
,shared
.czero
);
4756 static void sremCommand(redisClient
*c
) {
4759 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4760 checkType(c
,set
,REDIS_SET
)) return;
4762 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
4764 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4765 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4766 addReply(c
,shared
.cone
);
4768 addReply(c
,shared
.czero
);
4772 static void smoveCommand(redisClient
*c
) {
4773 robj
*srcset
, *dstset
;
4775 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4776 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4778 /* If the source key does not exist return 0, if it's of the wrong type
4780 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
4781 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
4784 /* Error if the destination key is not a set as well */
4785 if (dstset
&& dstset
->type
!= REDIS_SET
) {
4786 addReply(c
,shared
.wrongtypeerr
);
4789 /* Remove the element from the source set */
4790 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
4791 /* Key not found in the src set! return zero */
4792 addReply(c
,shared
.czero
);
4795 if (dictSize((dict
*)srcset
->ptr
) == 0 && srcset
!= dstset
)
4796 deleteKey(c
->db
,c
->argv
[1]);
4798 /* Add the element to the destination set */
4800 dstset
= createSetObject();
4801 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
4802 incrRefCount(c
->argv
[2]);
4804 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
4805 incrRefCount(c
->argv
[3]);
4806 addReply(c
,shared
.cone
);
4809 static void sismemberCommand(redisClient
*c
) {
4812 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4813 checkType(c
,set
,REDIS_SET
)) return;
4815 if (dictFind(set
->ptr
,c
->argv
[2]))
4816 addReply(c
,shared
.cone
);
4818 addReply(c
,shared
.czero
);
4821 static void scardCommand(redisClient
*c
) {
4825 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
4826 checkType(c
,o
,REDIS_SET
)) return;
4829 addReplyUlong(c
,dictSize(s
));
4832 static void spopCommand(redisClient
*c
) {
4836 if ((set
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4837 checkType(c
,set
,REDIS_SET
)) return;
4839 de
= dictGetRandomKey(set
->ptr
);
4841 addReply(c
,shared
.nullbulk
);
4843 robj
*ele
= dictGetEntryKey(de
);
4845 addReplyBulk(c
,ele
);
4846 dictDelete(set
->ptr
,ele
);
4847 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4848 if (dictSize((dict
*)set
->ptr
) == 0) deleteKey(c
->db
,c
->argv
[1]);
4853 static void srandmemberCommand(redisClient
*c
) {
4857 if ((set
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
4858 checkType(c
,set
,REDIS_SET
)) return;
4860 de
= dictGetRandomKey(set
->ptr
);
4862 addReply(c
,shared
.nullbulk
);
4864 robj
*ele
= dictGetEntryKey(de
);
4866 addReplyBulk(c
,ele
);
4870 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
4871 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
4873 return dictSize(*d1
)-dictSize(*d2
);
4876 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
4877 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4880 robj
*lenobj
= NULL
, *dstset
= NULL
;
4881 unsigned long j
, cardinality
= 0;
4883 for (j
= 0; j
< setsnum
; j
++) {
4887 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4888 lookupKeyRead(c
->db
,setskeys
[j
]);
4892 if (deleteKey(c
->db
,dstkey
))
4894 addReply(c
,shared
.czero
);
4896 addReply(c
,shared
.emptymultibulk
);
4900 if (setobj
->type
!= REDIS_SET
) {
4902 addReply(c
,shared
.wrongtypeerr
);
4905 dv
[j
] = setobj
->ptr
;
4907 /* Sort sets from the smallest to largest, this will improve our
4908 * algorithm's performace */
4909 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
4911 /* The first thing we should output is the total number of elements...
4912 * since this is a multi-bulk write, but at this stage we don't know
4913 * the intersection set size, so we use a trick, append an empty object
4914 * to the output list and save the pointer to later modify it with the
4917 lenobj
= createObject(REDIS_STRING
,NULL
);
4919 decrRefCount(lenobj
);
4921 /* If we have a target key where to store the resulting set
4922 * create this key with an empty set inside */
4923 dstset
= createSetObject();
4926 /* Iterate all the elements of the first (smallest) set, and test
4927 * the element against all the other sets, if at least one set does
4928 * not include the element it is discarded */
4929 di
= dictGetIterator(dv
[0]);
4931 while((de
= dictNext(di
)) != NULL
) {
4934 for (j
= 1; j
< setsnum
; j
++)
4935 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
4937 continue; /* at least one set does not contain the member */
4938 ele
= dictGetEntryKey(de
);
4940 addReplyBulk(c
,ele
);
4943 dictAdd(dstset
->ptr
,ele
,NULL
);
4947 dictReleaseIterator(di
);
4950 /* Store the resulting set into the target, if the intersection
4951 * is not an empty set. */
4952 deleteKey(c
->db
,dstkey
);
4953 if (dictSize((dict
*)dstset
->ptr
) > 0) {
4954 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4955 incrRefCount(dstkey
);
4956 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
4958 decrRefCount(dstset
);
4959 addReply(c
,shared
.czero
);
4963 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
4968 static void sinterCommand(redisClient
*c
) {
4969 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
4972 static void sinterstoreCommand(redisClient
*c
) {
4973 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
4976 #define REDIS_OP_UNION 0
4977 #define REDIS_OP_DIFF 1
4978 #define REDIS_OP_INTER 2
4980 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
4981 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4984 robj
*dstset
= NULL
;
4985 int j
, cardinality
= 0;
4987 for (j
= 0; j
< setsnum
; j
++) {
4991 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4992 lookupKeyRead(c
->db
,setskeys
[j
]);
4997 if (setobj
->type
!= REDIS_SET
) {
4999 addReply(c
,shared
.wrongtypeerr
);
5002 dv
[j
] = setobj
->ptr
;
5005 /* We need a temp set object to store our union. If the dstkey
5006 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
5007 * this set object will be the resulting object to set into the target key*/
5008 dstset
= createSetObject();
5010 /* Iterate all the elements of all the sets, add every element a single
5011 * time to the result set */
5012 for (j
= 0; j
< setsnum
; j
++) {
5013 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
5014 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
5016 di
= dictGetIterator(dv
[j
]);
5018 while((de
= dictNext(di
)) != NULL
) {
5021 /* dictAdd will not add the same element multiple times */
5022 ele
= dictGetEntryKey(de
);
5023 if (op
== REDIS_OP_UNION
|| j
== 0) {
5024 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
5028 } else if (op
== REDIS_OP_DIFF
) {
5029 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
5034 dictReleaseIterator(di
);
5036 /* result set is empty? Exit asap. */
5037 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break;
5040 /* Output the content of the resulting set, if not in STORE mode */
5042 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
5043 di
= dictGetIterator(dstset
->ptr
);
5044 while((de
= dictNext(di
)) != NULL
) {
5047 ele
= dictGetEntryKey(de
);
5048 addReplyBulk(c
,ele
);
5050 dictReleaseIterator(di
);
5051 decrRefCount(dstset
);
5053 /* If we have a target key where to store the resulting set
5054 * create this key with the result set inside */
5055 deleteKey(c
->db
,dstkey
);
5056 if (dictSize((dict
*)dstset
->ptr
) > 0) {
5057 dictAdd(c
->db
->dict
,dstkey
,dstset
);
5058 incrRefCount(dstkey
);
5059 addReplyLong(c
,dictSize((dict
*)dstset
->ptr
));
5061 decrRefCount(dstset
);
5062 addReply(c
,shared
.czero
);
5069 static void sunionCommand(redisClient
*c
) {
5070 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
5073 static void sunionstoreCommand(redisClient
*c
) {
5074 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
5077 static void sdiffCommand(redisClient
*c
) {
5078 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
5081 static void sdiffstoreCommand(redisClient
*c
) {
5082 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
5085 /* ==================================== ZSets =============================== */
5087 /* ZSETs are ordered sets using two data structures to hold the same elements
5088 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
5091 * The elements are added to an hash table mapping Redis objects to scores.
5092 * At the same time the elements are added to a skip list mapping scores
5093 * to Redis objects (so objects are sorted by scores in this "view"). */
5095 /* This skiplist implementation is almost a C translation of the original
5096 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
5097 * Alternative to Balanced Trees", modified in three ways:
5098 * a) this implementation allows for repeated values.
5099 * b) the comparison is not just by key (our 'score') but by satellite data.
5100 * c) there is a back pointer, so it's a doubly linked list with the back
5101 * pointers being only at "level 1". This allows to traverse the list
5102 * from tail to head, useful for ZREVRANGE. */
5104 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
5105 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
5107 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
5109 zn
->span
= zmalloc(sizeof(unsigned int) * (level
- 1));
5115 static zskiplist
*zslCreate(void) {
5119 zsl
= zmalloc(sizeof(*zsl
));
5122 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
5123 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++) {
5124 zsl
->header
->forward
[j
] = NULL
;
5126 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
5127 if (j
< ZSKIPLIST_MAXLEVEL
-1)
5128 zsl
->header
->span
[j
] = 0;
5130 zsl
->header
->backward
= NULL
;
5135 static void zslFreeNode(zskiplistNode
*node
) {
5136 decrRefCount(node
->obj
);
5137 zfree(node
->forward
);
5142 static void zslFree(zskiplist
*zsl
) {
5143 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
5145 zfree(zsl
->header
->forward
);
5146 zfree(zsl
->header
->span
);
5149 next
= node
->forward
[0];
5156 static int zslRandomLevel(void) {
5158 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
5160 return (level
<ZSKIPLIST_MAXLEVEL
) ? level
: ZSKIPLIST_MAXLEVEL
;
5163 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
5164 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5165 unsigned int rank
[ZSKIPLIST_MAXLEVEL
];
5169 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5170 /* store rank that is crossed to reach the insert position */
5171 rank
[i
] = i
== (zsl
->level
-1) ? 0 : rank
[i
+1];
5173 while (x
->forward
[i
] &&
5174 (x
->forward
[i
]->score
< score
||
5175 (x
->forward
[i
]->score
== score
&&
5176 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0))) {
5177 rank
[i
] += i
> 0 ? x
->span
[i
-1] : 1;
5182 /* we assume the key is not already inside, since we allow duplicated
5183 * scores, and the re-insertion of score and redis object should never
5184 * happpen since the caller of zslInsert() should test in the hash table
5185 * if the element is already inside or not. */
5186 level
= zslRandomLevel();
5187 if (level
> zsl
->level
) {
5188 for (i
= zsl
->level
; i
< level
; i
++) {
5190 update
[i
] = zsl
->header
;
5191 update
[i
]->span
[i
-1] = zsl
->length
;
5195 x
= zslCreateNode(level
,score
,obj
);
5196 for (i
= 0; i
< level
; i
++) {
5197 x
->forward
[i
] = update
[i
]->forward
[i
];
5198 update
[i
]->forward
[i
] = x
;
5200 /* update span covered by update[i] as x is inserted here */
5202 x
->span
[i
-1] = update
[i
]->span
[i
-1] - (rank
[0] - rank
[i
]);
5203 update
[i
]->span
[i
-1] = (rank
[0] - rank
[i
]) + 1;
5207 /* increment span for untouched levels */
5208 for (i
= level
; i
< zsl
->level
; i
++) {
5209 update
[i
]->span
[i
-1]++;
5212 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
5214 x
->forward
[0]->backward
= x
;
5220 /* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank */
5221 void zslDeleteNode(zskiplist
*zsl
, zskiplistNode
*x
, zskiplistNode
**update
) {
5223 for (i
= 0; i
< zsl
->level
; i
++) {
5224 if (update
[i
]->forward
[i
] == x
) {
5226 update
[i
]->span
[i
-1] += x
->span
[i
-1] - 1;
5228 update
[i
]->forward
[i
] = x
->forward
[i
];
5230 /* invariant: i > 0, because update[0]->forward[0]
5231 * is always equal to x */
5232 update
[i
]->span
[i
-1] -= 1;
5235 if (x
->forward
[0]) {
5236 x
->forward
[0]->backward
= x
->backward
;
5238 zsl
->tail
= x
->backward
;
5240 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
5245 /* Delete an element with matching score/object from the skiplist. */
5246 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
5247 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5251 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5252 while (x
->forward
[i
] &&
5253 (x
->forward
[i
]->score
< score
||
5254 (x
->forward
[i
]->score
== score
&&
5255 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
5259 /* We may have multiple elements with the same score, what we need
5260 * is to find the element with both the right score and object. */
5262 if (x
&& score
== x
->score
&& compareStringObjects(x
->obj
,obj
) == 0) {
5263 zslDeleteNode(zsl
, x
, update
);
5267 return 0; /* not found */
5269 return 0; /* not found */
5272 /* Delete all the elements with score between min and max from the skiplist.
5273 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
5274 * Note that this function takes the reference to the hash table view of the
5275 * sorted set, in order to remove the elements from the hash table too. */
5276 static unsigned long zslDeleteRangeByScore(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
5277 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5278 unsigned long removed
= 0;
5282 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5283 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
5287 /* We may have multiple elements with the same score, what we need
5288 * is to find the element with both the right score and object. */
5290 while (x
&& x
->score
<= max
) {
5291 zskiplistNode
*next
= x
->forward
[0];
5292 zslDeleteNode(zsl
, x
, update
);
5293 dictDelete(dict
,x
->obj
);
5298 return removed
; /* not found */
5301 /* Delete all the elements with rank between start and end from the skiplist.
5302 * Start and end are inclusive. Note that start and end need to be 1-based */
5303 static unsigned long zslDeleteRangeByRank(zskiplist
*zsl
, unsigned int start
, unsigned int end
, dict
*dict
) {
5304 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
5305 unsigned long traversed
= 0, removed
= 0;
5309 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5310 while (x
->forward
[i
] && (traversed
+ (i
> 0 ? x
->span
[i
-1] : 1)) < start
) {
5311 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5319 while (x
&& traversed
<= end
) {
5320 zskiplistNode
*next
= x
->forward
[0];
5321 zslDeleteNode(zsl
, x
, update
);
5322 dictDelete(dict
,x
->obj
);
5331 /* Find the first node having a score equal or greater than the specified one.
5332 * Returns NULL if there is no match. */
5333 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
5338 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5339 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
5342 /* We may have multiple elements with the same score, what we need
5343 * is to find the element with both the right score and object. */
5344 return x
->forward
[0];
5347 /* Find the rank for an element by both score and key.
5348 * Returns 0 when the element cannot be found, rank otherwise.
5349 * Note that the rank is 1-based due to the span of zsl->header to the
5351 static unsigned long zslGetRank(zskiplist
*zsl
, double score
, robj
*o
) {
5353 unsigned long rank
= 0;
5357 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5358 while (x
->forward
[i
] &&
5359 (x
->forward
[i
]->score
< score
||
5360 (x
->forward
[i
]->score
== score
&&
5361 compareStringObjects(x
->forward
[i
]->obj
,o
) <= 0))) {
5362 rank
+= i
> 0 ? x
->span
[i
-1] : 1;
5366 /* x might be equal to zsl->header, so test if obj is non-NULL */
5367 if (x
->obj
&& compareStringObjects(x
->obj
,o
) == 0) {
5374 /* Finds an element by its rank. The rank argument needs to be 1-based. */
5375 zskiplistNode
* zslGetElementByRank(zskiplist
*zsl
, unsigned long rank
) {
5377 unsigned long traversed
= 0;
5381 for (i
= zsl
->level
-1; i
>= 0; i
--) {
5382 while (x
->forward
[i
] && (traversed
+ (i
>0 ? x
->span
[i
-1] : 1)) <= rank
)
5384 traversed
+= i
> 0 ? x
->span
[i
-1] : 1;
5387 if (traversed
== rank
) {
5394 /* The actual Z-commands implementations */
5396 /* This generic command implements both ZADD and ZINCRBY.
5397 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
5398 * the increment if the operation is a ZINCRBY (doincrement == 1). */
5399 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
5404 zsetobj
= lookupKeyWrite(c
->db
,key
);
5405 if (zsetobj
== NULL
) {
5406 zsetobj
= createZsetObject();
5407 dictAdd(c
->db
->dict
,key
,zsetobj
);
5410 if (zsetobj
->type
!= REDIS_ZSET
) {
5411 addReply(c
,shared
.wrongtypeerr
);
5417 /* Ok now since we implement both ZADD and ZINCRBY here the code
5418 * needs to handle the two different conditions. It's all about setting
5419 * '*score', that is, the new score to set, to the right value. */
5420 score
= zmalloc(sizeof(double));
5424 /* Read the old score. If the element was not present starts from 0 */
5425 de
= dictFind(zs
->dict
,ele
);
5427 double *oldscore
= dictGetEntryVal(de
);
5428 *score
= *oldscore
+ scoreval
;
5436 /* What follows is a simple remove and re-insert operation that is common
5437 * to both ZADD and ZINCRBY... */
5438 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
5439 /* case 1: New element */
5440 incrRefCount(ele
); /* added to hash */
5441 zslInsert(zs
->zsl
,*score
,ele
);
5442 incrRefCount(ele
); /* added to skiplist */
5445 addReplyDouble(c
,*score
);
5447 addReply(c
,shared
.cone
);
5452 /* case 2: Score update operation */
5453 de
= dictFind(zs
->dict
,ele
);
5454 redisAssert(de
!= NULL
);
5455 oldscore
= dictGetEntryVal(de
);
5456 if (*score
!= *oldscore
) {
5459 /* Remove and insert the element in the skip list with new score */
5460 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
5461 redisAssert(deleted
!= 0);
5462 zslInsert(zs
->zsl
,*score
,ele
);
5464 /* Update the score in the hash table */
5465 dictReplace(zs
->dict
,ele
,score
);
5471 addReplyDouble(c
,*score
);
5473 addReply(c
,shared
.czero
);
5477 static void zaddCommand(redisClient
*c
) {
5480 if (getDoubleFromObject(c
, c
->argv
[2], &scoreval
) != REDIS_OK
) return;
5482 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
5485 static void zincrbyCommand(redisClient
*c
) {
5488 if (getDoubleFromObject(c
, c
->argv
[2], &scoreval
) != REDIS_OK
) return;
5490 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
5493 static void zremCommand(redisClient
*c
) {
5500 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5501 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5504 de
= dictFind(zs
->dict
,c
->argv
[2]);
5506 addReply(c
,shared
.czero
);
5509 /* Delete from the skiplist */
5510 oldscore
= dictGetEntryVal(de
);
5511 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
5512 redisAssert(deleted
!= 0);
5514 /* Delete from the hash table */
5515 dictDelete(zs
->dict
,c
->argv
[2]);
5516 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5517 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5519 addReply(c
,shared
.cone
);
5522 static void zremrangebyscoreCommand(redisClient
*c
) {
5529 if ((getDoubleFromObject(c
, c
->argv
[2], &min
) != REDIS_OK
) ||
5530 (getDoubleFromObject(c
, c
->argv
[3], &max
) != REDIS_OK
)) return;
5532 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5533 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5536 deleted
= zslDeleteRangeByScore(zs
->zsl
,min
,max
,zs
->dict
);
5537 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5538 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5539 server
.dirty
+= deleted
;
5540 addReplyLong(c
,deleted
);
5543 static void zremrangebyrankCommand(redisClient
*c
) {
5551 if ((getLongFromObject(c
, c
->argv
[2], &start
) != REDIS_OK
) ||
5552 (getLongFromObject(c
, c
->argv
[3], &end
) != REDIS_OK
)) return;
5554 if ((zsetobj
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5555 checkType(c
,zsetobj
,REDIS_ZSET
)) return;
5557 llen
= zs
->zsl
->length
;
5559 /* convert negative indexes */
5560 if (start
< 0) start
= llen
+start
;
5561 if (end
< 0) end
= llen
+end
;
5562 if (start
< 0) start
= 0;
5563 if (end
< 0) end
= 0;
5565 /* indexes sanity checks */
5566 if (start
> end
|| start
>= llen
) {
5567 addReply(c
,shared
.czero
);
5570 if (end
>= llen
) end
= llen
-1;
5572 /* increment start and end because zsl*Rank functions
5573 * use 1-based rank */
5574 deleted
= zslDeleteRangeByRank(zs
->zsl
,start
+1,end
+1,zs
->dict
);
5575 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5576 if (dictSize(zs
->dict
) == 0) deleteKey(c
->db
,c
->argv
[1]);
5577 server
.dirty
+= deleted
;
5578 addReplyLong(c
, deleted
);
5586 static int qsortCompareZsetopsrcByCardinality(const void *s1
, const void *s2
) {
5587 zsetopsrc
*d1
= (void*) s1
, *d2
= (void*) s2
;
5588 unsigned long size1
, size2
;
5589 size1
= d1
->dict
? dictSize(d1
->dict
) : 0;
5590 size2
= d2
->dict
? dictSize(d2
->dict
) : 0;
5591 return size1
- size2
;
5594 #define REDIS_AGGR_SUM 1
5595 #define REDIS_AGGR_MIN 2
5596 #define REDIS_AGGR_MAX 3
5598 inline static void zunionInterAggregate(double *target
, double val
, int aggregate
) {
5599 if (aggregate
== REDIS_AGGR_SUM
) {
5600 *target
= *target
+ val
;
5601 } else if (aggregate
== REDIS_AGGR_MIN
) {
5602 *target
= val
< *target
? val
: *target
;
5603 } else if (aggregate
== REDIS_AGGR_MAX
) {
5604 *target
= val
> *target
? val
: *target
;
5607 redisAssert(0 != 0);
5611 static void zunionInterGenericCommand(redisClient
*c
, robj
*dstkey
, int op
) {
5613 int aggregate
= REDIS_AGGR_SUM
;
5620 /* expect zsetnum input keys to be given */
5621 zsetnum
= atoi(c
->argv
[2]->ptr
);
5623 addReplySds(c
,sdsnew("-ERR at least 1 input key is needed for ZUNION/ZINTER\r\n"));
5627 /* test if the expected number of keys would overflow */
5628 if (3+zsetnum
> c
->argc
) {
5629 addReply(c
,shared
.syntaxerr
);
5633 /* read keys to be used for input */
5634 src
= zmalloc(sizeof(zsetopsrc
) * zsetnum
);
5635 for (i
= 0, j
= 3; i
< zsetnum
; i
++, j
++) {
5636 robj
*zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
5640 if (zsetobj
->type
!= REDIS_ZSET
) {
5642 addReply(c
,shared
.wrongtypeerr
);
5645 src
[i
].dict
= ((zset
*)zsetobj
->ptr
)->dict
;
5648 /* default all weights to 1 */
5649 src
[i
].weight
= 1.0;
5652 /* parse optional extra arguments */
5654 int remaining
= c
->argc
- j
;
5657 if (remaining
>= (zsetnum
+ 1) && !strcasecmp(c
->argv
[j
]->ptr
,"weights")) {
5659 for (i
= 0; i
< zsetnum
; i
++, j
++, remaining
--) {
5660 if (getDoubleFromObject(c
, c
->argv
[j
], &src
[i
].weight
) != REDIS_OK
)
5663 } else if (remaining
>= 2 && !strcasecmp(c
->argv
[j
]->ptr
,"aggregate")) {
5665 if (!strcasecmp(c
->argv
[j
]->ptr
,"sum")) {
5666 aggregate
= REDIS_AGGR_SUM
;
5667 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"min")) {
5668 aggregate
= REDIS_AGGR_MIN
;
5669 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"max")) {
5670 aggregate
= REDIS_AGGR_MAX
;
5673 addReply(c
,shared
.syntaxerr
);
5679 addReply(c
,shared
.syntaxerr
);
5685 /* sort sets from the smallest to largest, this will improve our
5686 * algorithm's performance */
5687 qsort(src
,zsetnum
,sizeof(zsetopsrc
), qsortCompareZsetopsrcByCardinality
);
5689 dstobj
= createZsetObject();
5690 dstzset
= dstobj
->ptr
;
5692 if (op
== REDIS_OP_INTER
) {
5693 /* skip going over all entries if the smallest zset is NULL or empty */
5694 if (src
[0].dict
&& dictSize(src
[0].dict
) > 0) {
5695 /* precondition: as src[0].dict is non-empty and the zsets are ordered
5696 * from small to large, all src[i > 0].dict are non-empty too */
5697 di
= dictGetIterator(src
[0].dict
);
5698 while((de
= dictNext(di
)) != NULL
) {
5699 double *score
= zmalloc(sizeof(double)), value
;
5700 *score
= src
[0].weight
* (*(double*)dictGetEntryVal(de
));
5702 for (j
= 1; j
< zsetnum
; j
++) {
5703 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5705 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5706 zunionInterAggregate(score
, value
, aggregate
);
5712 /* skip entry when not present in every source dict */
5716 robj
*o
= dictGetEntryKey(de
);
5717 dictAdd(dstzset
->dict
,o
,score
);
5718 incrRefCount(o
); /* added to dictionary */
5719 zslInsert(dstzset
->zsl
,*score
,o
);
5720 incrRefCount(o
); /* added to skiplist */
5723 dictReleaseIterator(di
);
5725 } else if (op
== REDIS_OP_UNION
) {
5726 for (i
= 0; i
< zsetnum
; i
++) {
5727 if (!src
[i
].dict
) continue;
5729 di
= dictGetIterator(src
[i
].dict
);
5730 while((de
= dictNext(di
)) != NULL
) {
5731 /* skip key when already processed */
5732 if (dictFind(dstzset
->dict
,dictGetEntryKey(de
)) != NULL
) continue;
5734 double *score
= zmalloc(sizeof(double)), value
;
5735 *score
= src
[i
].weight
* (*(double*)dictGetEntryVal(de
));
5737 /* because the zsets are sorted by size, its only possible
5738 * for sets at larger indices to hold this entry */
5739 for (j
= (i
+1); j
< zsetnum
; j
++) {
5740 dictEntry
*other
= dictFind(src
[j
].dict
,dictGetEntryKey(de
));
5742 value
= src
[j
].weight
* (*(double*)dictGetEntryVal(other
));
5743 zunionInterAggregate(score
, value
, aggregate
);
5747 robj
*o
= dictGetEntryKey(de
);
5748 dictAdd(dstzset
->dict
,o
,score
);
5749 incrRefCount(o
); /* added to dictionary */
5750 zslInsert(dstzset
->zsl
,*score
,o
);
5751 incrRefCount(o
); /* added to skiplist */
5753 dictReleaseIterator(di
);
5756 /* unknown operator */
5757 redisAssert(op
== REDIS_OP_INTER
|| op
== REDIS_OP_UNION
);
5760 deleteKey(c
->db
,dstkey
);
5761 if (dstzset
->zsl
->length
) {
5762 dictAdd(c
->db
->dict
,dstkey
,dstobj
);
5763 incrRefCount(dstkey
);
5764 addReplyLong(c
, dstzset
->zsl
->length
);
5767 decrRefCount(dstobj
);
5768 addReply(c
, shared
.czero
);
5773 static void zunionCommand(redisClient
*c
) {
5774 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_UNION
);
5777 static void zinterCommand(redisClient
*c
) {
5778 zunionInterGenericCommand(c
,c
->argv
[1], REDIS_OP_INTER
);
5781 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
5793 if ((getLongFromObject(c
, c
->argv
[2], &start
) != REDIS_OK
) ||
5794 (getLongFromObject(c
, c
->argv
[3], &end
) != REDIS_OK
)) return;
5796 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
5798 } else if (c
->argc
>= 5) {
5799 addReply(c
,shared
.syntaxerr
);
5803 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
5804 || checkType(c
,o
,REDIS_ZSET
)) return;
5809 /* convert negative indexes */
5810 if (start
< 0) start
= llen
+start
;
5811 if (end
< 0) end
= llen
+end
;
5812 if (start
< 0) start
= 0;
5813 if (end
< 0) end
= 0;
5815 /* indexes sanity checks */
5816 if (start
> end
|| start
>= llen
) {
5817 /* Out of range start or start > end result in empty list */
5818 addReply(c
,shared
.emptymultibulk
);
5821 if (end
>= llen
) end
= llen
-1;
5822 rangelen
= (end
-start
)+1;
5824 /* check if starting point is trivial, before searching
5825 * the element in log(N) time */
5827 ln
= start
== 0 ? zsl
->tail
: zslGetElementByRank(zsl
, llen
-start
);
5830 zsl
->header
->forward
[0] : zslGetElementByRank(zsl
, start
+1);
5833 /* Return the result in form of a multi-bulk reply */
5834 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
5835 withscores
? (rangelen
*2) : rangelen
));
5836 for (j
= 0; j
< rangelen
; j
++) {
5838 addReplyBulk(c
,ele
);
5840 addReplyDouble(c
,ln
->score
);
5841 ln
= reverse
? ln
->backward
: ln
->forward
[0];
5845 static void zrangeCommand(redisClient
*c
) {
5846 zrangeGenericCommand(c
,0);
5849 static void zrevrangeCommand(redisClient
*c
) {
5850 zrangeGenericCommand(c
,1);
5853 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
5854 * If justcount is non-zero, just the count is returned. */
5855 static void genericZrangebyscoreCommand(redisClient
*c
, int justcount
) {
5858 int minex
= 0, maxex
= 0; /* are min or max exclusive? */
5859 int offset
= 0, limit
= -1;
5863 /* Parse the min-max interval. If one of the values is prefixed
5864 * by the "(" character, it's considered "open". For instance
5865 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
5866 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
5867 if (((char*)c
->argv
[2]->ptr
)[0] == '(') {
5868 min
= strtod((char*)c
->argv
[2]->ptr
+1,NULL
);
5871 min
= strtod(c
->argv
[2]->ptr
,NULL
);
5873 if (((char*)c
->argv
[3]->ptr
)[0] == '(') {
5874 max
= strtod((char*)c
->argv
[3]->ptr
+1,NULL
);
5877 max
= strtod(c
->argv
[3]->ptr
,NULL
);
5880 /* Parse "WITHSCORES": note that if the command was called with
5881 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
5882 * enter the following paths to parse WITHSCORES and LIMIT. */
5883 if (c
->argc
== 5 || c
->argc
== 8) {
5884 if (strcasecmp(c
->argv
[c
->argc
-1]->ptr
,"withscores") == 0)
5889 if (c
->argc
!= (4 + withscores
) && c
->argc
!= (7 + withscores
))
5893 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
5898 if (c
->argc
== (7 + withscores
) && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
5899 addReply(c
,shared
.syntaxerr
);
5901 } else if (c
->argc
== (7 + withscores
)) {
5902 offset
= atoi(c
->argv
[5]->ptr
);
5903 limit
= atoi(c
->argv
[6]->ptr
);
5904 if (offset
< 0) offset
= 0;
5907 /* Ok, lookup the key and get the range */
5908 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5910 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
5912 if (o
->type
!= REDIS_ZSET
) {
5913 addReply(c
,shared
.wrongtypeerr
);
5915 zset
*zsetobj
= o
->ptr
;
5916 zskiplist
*zsl
= zsetobj
->zsl
;
5918 robj
*ele
, *lenobj
= NULL
;
5919 unsigned long rangelen
= 0;
5921 /* Get the first node with the score >= min, or with
5922 * score > min if 'minex' is true. */
5923 ln
= zslFirstWithScore(zsl
,min
);
5924 while (minex
&& ln
&& ln
->score
== min
) ln
= ln
->forward
[0];
5927 /* No element matching the speciifed interval */
5928 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
5932 /* We don't know in advance how many matching elements there
5933 * are in the list, so we push this object that will represent
5934 * the multi-bulk length in the output buffer, and will "fix"
5937 lenobj
= createObject(REDIS_STRING
,NULL
);
5939 decrRefCount(lenobj
);
5942 while(ln
&& (maxex
? (ln
->score
< max
) : (ln
->score
<= max
))) {
5945 ln
= ln
->forward
[0];
5948 if (limit
== 0) break;
5951 addReplyBulk(c
,ele
);
5953 addReplyDouble(c
,ln
->score
);
5955 ln
= ln
->forward
[0];
5957 if (limit
> 0) limit
--;
5960 addReplyLong(c
,(long)rangelen
);
5962 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",
5963 withscores
? (rangelen
*2) : rangelen
);
5969 static void zrangebyscoreCommand(redisClient
*c
) {
5970 genericZrangebyscoreCommand(c
,0);
5973 static void zcountCommand(redisClient
*c
) {
5974 genericZrangebyscoreCommand(c
,1);
5977 static void zcardCommand(redisClient
*c
) {
5981 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
5982 checkType(c
,o
,REDIS_ZSET
)) return;
5985 addReplyUlong(c
,zs
->zsl
->length
);
5988 static void zscoreCommand(redisClient
*c
) {
5993 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
5994 checkType(c
,o
,REDIS_ZSET
)) return;
5997 de
= dictFind(zs
->dict
,c
->argv
[2]);
5999 addReply(c
,shared
.nullbulk
);
6001 double *score
= dictGetEntryVal(de
);
6003 addReplyDouble(c
,*score
);
6007 static void zrankGenericCommand(redisClient
*c
, int reverse
) {
6015 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6016 checkType(c
,o
,REDIS_ZSET
)) return;
6020 de
= dictFind(zs
->dict
,c
->argv
[2]);
6022 addReply(c
,shared
.nullbulk
);
6026 score
= dictGetEntryVal(de
);
6027 rank
= zslGetRank(zsl
, *score
, c
->argv
[2]);
6030 addReplyLong(c
, zsl
->length
- rank
);
6032 addReplyLong(c
, rank
-1);
6035 addReply(c
,shared
.nullbulk
);
6039 static void zrankCommand(redisClient
*c
) {
6040 zrankGenericCommand(c
, 0);
6043 static void zrevrankCommand(redisClient
*c
) {
6044 zrankGenericCommand(c
, 1);
6047 /* ========================= Hashes utility functions ======================= */
6048 #define REDIS_HASH_KEY 1
6049 #define REDIS_HASH_VALUE 2
6051 /* Check the length of a number of objects to see if we need to convert a
6052 * zipmap to a real hash. Note that we only check string encoded objects
6053 * as their string length can be queried in constant time. */
6054 static void hashTryConversion(robj
*subject
, robj
**argv
, int start
, int end
) {
6056 if (subject
->encoding
!= REDIS_ENCODING_ZIPMAP
) return;
6058 for (i
= start
; i
<= end
; i
++) {
6059 if (argv
[i
]->encoding
== REDIS_ENCODING_RAW
&&
6060 sdslen(argv
[i
]->ptr
) > server
.hash_max_zipmap_value
)
6062 convertToRealHash(subject
);
6068 /* Get the value from a hash identified by key. Returns either a string
6069 * object or NULL if the value cannot be found.
6070 * Note: the refcount for objects retrieved from a zipmap is set to 0.
6071 * This is done, so addReply will increment and clean up the object.
6072 * Make sure to clean up the object when it isn't added to a reply. */
6073 static robj
*hashGet(robj
*o
, robj
*key
) {
6075 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6078 key
= getDecodedObject(key
);
6079 if (zipmapGet(o
->ptr
,key
->ptr
,sdslen(key
->ptr
),&v
,&vlen
)) {
6080 value
= createStringObject((char*)v
,vlen
);
6081 value
->refcount
= 0;
6085 dictEntry
*de
= dictFind(o
->ptr
,key
);
6087 value
= dictGetEntryVal(de
);
6093 /* Test if the key exists in the given hash. Returns 1 if the key
6094 * exists and 0 when it doesn't. */
6095 static int hashExists(robj
*o
, robj
*key
) {
6096 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6097 key
= getDecodedObject(key
);
6098 if (zipmapExists(o
->ptr
,key
->ptr
,sdslen(key
->ptr
))) {
6104 if (dictFind(o
->ptr
,key
) != NULL
) {
6111 /* Add an element, discard the old if the key already exists.
6112 * Return 0 on insert and 1 on update. */
6113 static int hashSet(robj
*o
, robj
*key
, robj
*value
) {
6115 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6116 key
= getDecodedObject(key
);
6117 value
= getDecodedObject(value
);
6118 o
->ptr
= zipmapSet(o
->ptr
,
6119 key
->ptr
,sdslen(key
->ptr
),
6120 value
->ptr
,sdslen(value
->ptr
), &update
);
6122 decrRefCount(value
);
6124 /* Check if the zipmap needs to be upgraded to a real hash table */
6125 if (zipmapLen(o
->ptr
) > server
.hash_max_zipmap_entries
)
6126 convertToRealHash(o
);
6128 value
= tryObjectEncoding(value
);
6129 if (dictReplace(o
->ptr
,key
,value
)) {
6136 incrRefCount(value
);
6141 /* Delete an element from a hash.
6142 * Return 1 on deleted and 0 on not found. */
6143 static int hashDelete(robj
*o
, robj
*key
) {
6145 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6146 key
= getDecodedObject(key
);
6147 o
->ptr
= zipmapDel(o
->ptr
,key
->ptr
,sdslen(key
->ptr
), &deleted
);
6150 deleted
= dictDelete((dict
*)o
->ptr
,key
) == DICT_OK
;
6151 /* Always check if the dictionary needs a resize after a delete. */
6152 if (deleted
&& htNeedsResize(o
->ptr
)) dictResize(o
->ptr
);
6157 /* Return the number of elements in a hash. */
6158 static unsigned long hashLength(robj
*o
) {
6159 return (o
->encoding
== REDIS_ENCODING_ZIPMAP
) ?
6160 zipmapLen((unsigned char*)o
->ptr
) : dictSize((dict
*)o
->ptr
);
6163 /* Structure to hold hash iteration abstration. Note that iteration over
6164 * hashes involves both fields and values. Because it is possible that
6165 * not both are required, store pointers in the iterator to avoid
6166 * unnecessary memory allocation for fields/values. */
6170 unsigned char *zk
, *zv
;
6171 unsigned int zklen
, zvlen
;
6177 static void hashInitIterator(robj
*subject
, hashIterator
*hi
) {
6178 hi
->encoding
= subject
->encoding
;
6179 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6180 hi
->zi
= zipmapRewind(subject
->ptr
);
6181 } else if (hi
->encoding
== REDIS_ENCODING_HT
) {
6182 hi
->di
= dictGetIterator(subject
->ptr
);
6188 static void hashReleaseIterator(hashIterator
*hi
) {
6189 if (hi
->encoding
== REDIS_ENCODING_HT
) {
6190 dictReleaseIterator(hi
->di
);
6194 /* Move to the next entry in the hash. Return REDIS_OK when the next entry
6195 * could be found and REDIS_ERR when the iterator reaches the end. */
6196 static int hashNext(hashIterator
*hi
) {
6197 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6198 if ((hi
->zi
= zipmapNext(hi
->zi
, &hi
->zk
, &hi
->zklen
,
6199 &hi
->zv
, &hi
->zvlen
)) == NULL
) return REDIS_ERR
;
6201 if ((hi
->de
= dictNext(hi
->di
)) == NULL
) return REDIS_ERR
;
6206 /* Get key or value object at current iteration position.
6207 * See comments at hashGet for a discussion on the refcount for
6208 * keys and values retrieved from zipmaps. */
6209 static robj
*hashCurrent(hashIterator
*hi
, int what
) {
6211 if (hi
->encoding
== REDIS_ENCODING_ZIPMAP
) {
6212 if (what
& REDIS_HASH_KEY
) {
6213 o
= createStringObject((char*)hi
->zk
,hi
->zklen
);
6215 o
= createStringObject((char*)hi
->zv
,hi
->zvlen
);
6219 if (what
& REDIS_HASH_KEY
) {
6220 o
= dictGetEntryKey(hi
->de
);
6222 o
= dictGetEntryVal(hi
->de
);
6228 static robj
*hashLookupWriteOrCreate(redisClient
*c
, robj
*key
) {
6229 robj
*o
= lookupKeyWrite(c
->db
,key
);
6231 o
= createHashObject();
6232 dictAdd(c
->db
->dict
,key
,o
);
6235 if (o
->type
!= REDIS_HASH
) {
6236 addReply(c
,shared
.wrongtypeerr
);
6243 /* ============================= Hash commands ============================== */
6244 static void hsetCommand(redisClient
*c
) {
6248 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6249 hashTryConversion(o
,c
->argv
,2,3);
6250 update
= hashSet(o
,c
->argv
[2],c
->argv
[3]);
6251 addReply(c
, update
? shared
.czero
: shared
.cone
);
6255 static void hsetnxCommand(redisClient
*c
) {
6257 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6258 hashTryConversion(o
,c
->argv
,2,3);
6260 if (hashExists(o
, c
->argv
[2])) {
6261 addReply(c
, shared
.czero
);
6263 hashSet(o
,c
->argv
[2],c
->argv
[3]);
6264 addReply(c
, shared
.cone
);
6269 static void hmsetCommand(redisClient
*c
) {
6273 if ((c
->argc
% 2) == 1) {
6274 addReplySds(c
,sdsnew("-ERR wrong number of arguments for HMSET\r\n"));
6278 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6279 hashTryConversion(o
,c
->argv
,2,c
->argc
-1);
6280 for (i
= 2; i
< c
->argc
; i
+= 2) {
6281 hashSet(o
,c
->argv
[i
],c
->argv
[i
+1]);
6283 addReply(c
, shared
.ok
);
6286 static void hincrbyCommand(redisClient
*c
) {
6287 long long value
, incr
;
6288 robj
*o
, *current
, *new;
6290 if (getLongLongFromObject(c
,c
->argv
[3],&incr
) != REDIS_OK
) return;
6291 if ((o
= hashLookupWriteOrCreate(c
,c
->argv
[1])) == NULL
) return;
6292 if ((current
= hashGet(o
,c
->argv
[2])) != NULL
) {
6293 if (current
->encoding
== REDIS_ENCODING_RAW
)
6294 value
= strtoll(current
->ptr
,NULL
,10);
6295 else if (current
->encoding
== REDIS_ENCODING_INT
)
6296 value
= (long)current
->ptr
;
6298 redisAssert(1 != 1);
6300 /* clean up object when it was retrieved from a zipmap */
6301 if (current
->refcount
== 0) {
6302 current
->refcount
= 1;
6303 decrRefCount(current
);
6310 new = createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
6311 hashSet(o
,c
->argv
[2],new);
6313 addReplyLongLong(c
,value
);
6317 static void hgetCommand(redisClient
*c
) {
6319 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.nullbulk
)) == NULL
||
6320 checkType(c
,o
,REDIS_HASH
)) return;
6322 if ((value
= hashGet(o
,c
->argv
[2])) != NULL
) {
6323 addReplyBulk(c
,value
);
6325 addReply(c
,shared
.nullbulk
);
6329 static void hmgetCommand(redisClient
*c
) {
6332 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
6333 if (o
!= NULL
&& o
->type
!= REDIS_HASH
) {
6334 addReply(c
,shared
.wrongtypeerr
);
6337 /* Note the check for o != NULL happens inside the loop. This is
6338 * done because objects that cannot be found are considered to be
6339 * an empty hash. The reply should then be a series of NULLs. */
6340 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-2));
6341 for (i
= 2; i
< c
->argc
; i
++) {
6342 if (o
!= NULL
&& (value
= hashGet(o
,c
->argv
[i
])) != NULL
) {
6343 addReplyBulk(c
,value
);
6345 addReply(c
,shared
.nullbulk
);
6350 static void hdelCommand(redisClient
*c
) {
6352 if ((o
= lookupKeyWriteOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6353 checkType(c
,o
,REDIS_HASH
)) return;
6355 if (hashDelete(o
,c
->argv
[2])) {
6356 if (hashLength(o
) == 0) deleteKey(c
->db
,c
->argv
[1]);
6357 addReply(c
,shared
.cone
);
6360 addReply(c
,shared
.czero
);
6364 static void hlenCommand(redisClient
*c
) {
6366 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6367 checkType(c
,o
,REDIS_HASH
)) return;
6369 addReplyUlong(c
,hashLength(o
));
6372 static void genericHgetallCommand(redisClient
*c
, int flags
) {
6373 robj
*o
, *lenobj
, *obj
;
6374 unsigned long count
= 0;
6377 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.emptymultibulk
)) == NULL
6378 || checkType(c
,o
,REDIS_HASH
)) return;
6380 lenobj
= createObject(REDIS_STRING
,NULL
);
6382 decrRefCount(lenobj
);
6384 hashInitIterator(o
, &hi
);
6385 while (hashNext(&hi
) != REDIS_ERR
) {
6386 if (flags
& REDIS_HASH_KEY
) {
6387 obj
= hashCurrent(&hi
,REDIS_HASH_KEY
);
6388 addReplyBulk(c
,obj
);
6391 if (flags
& REDIS_HASH_VALUE
) {
6392 obj
= hashCurrent(&hi
,REDIS_HASH_VALUE
);
6393 addReplyBulk(c
,obj
);
6397 hashReleaseIterator(&hi
);
6399 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",count
);
6402 static void hkeysCommand(redisClient
*c
) {
6403 genericHgetallCommand(c
,REDIS_HASH_KEY
);
6406 static void hvalsCommand(redisClient
*c
) {
6407 genericHgetallCommand(c
,REDIS_HASH_VALUE
);
6410 static void hgetallCommand(redisClient
*c
) {
6411 genericHgetallCommand(c
,REDIS_HASH_KEY
|REDIS_HASH_VALUE
);
6414 static void hexistsCommand(redisClient
*c
) {
6416 if ((o
= lookupKeyReadOrReply(c
,c
->argv
[1],shared
.czero
)) == NULL
||
6417 checkType(c
,o
,REDIS_HASH
)) return;
6419 addReply(c
, hashExists(o
,c
->argv
[2]) ? shared
.cone
: shared
.czero
);
6422 static void convertToRealHash(robj
*o
) {
6423 unsigned char *key
, *val
, *p
, *zm
= o
->ptr
;
6424 unsigned int klen
, vlen
;
6425 dict
*dict
= dictCreate(&hashDictType
,NULL
);
6427 assert(o
->type
== REDIS_HASH
&& o
->encoding
!= REDIS_ENCODING_HT
);
6428 p
= zipmapRewind(zm
);
6429 while((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) != NULL
) {
6430 robj
*keyobj
, *valobj
;
6432 keyobj
= createStringObject((char*)key
,klen
);
6433 valobj
= createStringObject((char*)val
,vlen
);
6434 keyobj
= tryObjectEncoding(keyobj
);
6435 valobj
= tryObjectEncoding(valobj
);
6436 dictAdd(dict
,keyobj
,valobj
);
6438 o
->encoding
= REDIS_ENCODING_HT
;
6443 /* ========================= Non type-specific commands ==================== */
6445 static void flushdbCommand(redisClient
*c
) {
6446 server
.dirty
+= dictSize(c
->db
->dict
);
6447 dictEmpty(c
->db
->dict
);
6448 dictEmpty(c
->db
->expires
);
6449 addReply(c
,shared
.ok
);
6452 static void flushallCommand(redisClient
*c
) {
6453 server
.dirty
+= emptyDb();
6454 addReply(c
,shared
.ok
);
6455 if (server
.bgsavechildpid
!= -1) {
6456 kill(server
.bgsavechildpid
,SIGKILL
);
6457 rdbRemoveTempFile(server
.bgsavechildpid
);
6459 rdbSave(server
.dbfilename
);
6463 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
6464 redisSortOperation
*so
= zmalloc(sizeof(*so
));
6466 so
->pattern
= pattern
;
6470 /* Return the value associated to the key with a name obtained
6471 * substituting the first occurence of '*' in 'pattern' with 'subst' */
6472 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
6475 robj keyobj
, fieldobj
, *o
;
6476 int prefixlen
, sublen
, postfixlen
, fieldlen
;
6477 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
6481 char buf
[REDIS_SORTKEY_MAX
+1];
6482 } keyname
, fieldname
;
6484 /* If the pattern is "#" return the substitution object itself in order
6485 * to implement the "SORT ... GET #" feature. */
6486 spat
= pattern
->ptr
;
6487 if (spat
[0] == '#' && spat
[1] == '\0') {
6491 /* The substitution object may be specially encoded. If so we create
6492 * a decoded object on the fly. Otherwise getDecodedObject will just
6493 * increment the ref count, that we'll decrement later. */
6494 subst
= getDecodedObject(subst
);
6497 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
6498 p
= strchr(spat
,'*');
6500 decrRefCount(subst
);
6504 /* Find out if we're dealing with a hash dereference. */
6505 if ((f
= strstr(p
+1, "->")) != NULL
) {
6506 fieldlen
= sdslen(spat
)-(f
-spat
);
6507 /* this also copies \0 character */
6508 memcpy(fieldname
.buf
,f
+2,fieldlen
-1);
6509 fieldname
.len
= fieldlen
-2;
6515 sublen
= sdslen(ssub
);
6516 postfixlen
= sdslen(spat
)-(prefixlen
+1)-fieldlen
;
6517 memcpy(keyname
.buf
,spat
,prefixlen
);
6518 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
6519 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
6520 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
6521 keyname
.len
= prefixlen
+sublen
+postfixlen
;
6522 decrRefCount(subst
);
6524 /* Lookup substituted key */
6525 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2));
6526 o
= lookupKeyRead(db
,&keyobj
);
6528 /* Retrieve value from hash by the field name */
6529 if (o
!= NULL
&& fieldlen
> 0) {
6530 if (o
->type
!= REDIS_HASH
|| fieldname
.len
< 1) {
6533 initStaticStringObject(fieldobj
,((char*)&fieldname
)+(sizeof(long)*2));
6534 o
= hashGet(o
, &fieldobj
);
6540 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
6541 * the additional parameter is not standard but a BSD-specific we have to
6542 * pass sorting parameters via the global 'server' structure */
6543 static int sortCompare(const void *s1
, const void *s2
) {
6544 const redisSortObject
*so1
= s1
, *so2
= s2
;
6547 if (!server
.sort_alpha
) {
6548 /* Numeric sorting. Here it's trivial as we precomputed scores */
6549 if (so1
->u
.score
> so2
->u
.score
) {
6551 } else if (so1
->u
.score
< so2
->u
.score
) {
6557 /* Alphanumeric sorting */
6558 if (server
.sort_bypattern
) {
6559 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
6560 /* At least one compare object is NULL */
6561 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
6563 else if (so1
->u
.cmpobj
== NULL
)
6568 /* We have both the objects, use strcoll */
6569 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
6572 /* Compare elements directly. Note that these objects already
6573 * need to be non-encoded (see sortCommand). */
6574 cmp
= strcoll(so1
->obj
->ptr
,so2
->obj
->ptr
);
6577 return server
.sort_desc
? -cmp
: cmp
;
6580 /* The SORT command is the most complex command in Redis. Warning: this code
6581 * is optimized for speed and a bit less for readability */
6582 static void sortCommand(redisClient
*c
) {
6585 int desc
= 0, alpha
= 0;
6586 int limit_start
= 0, limit_count
= -1, start
, end
;
6587 int j
, dontsort
= 0, vectorlen
;
6588 int getop
= 0; /* GET operation counter */
6589 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
6590 redisSortObject
*vector
; /* Resulting vector to sort */
6592 /* Lookup the key to sort. It must be of the right types */
6593 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
6594 if (sortval
== NULL
) {
6595 addReply(c
,shared
.emptymultibulk
);
6598 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
6599 sortval
->type
!= REDIS_ZSET
)
6601 addReply(c
,shared
.wrongtypeerr
);
6605 /* Create a list of operations to perform for every sorted element.
6606 * Operations can be GET/DEL/INCR/DECR */
6607 operations
= listCreate();
6608 listSetFreeMethod(operations
,zfree
);
6611 /* Now we need to protect sortval incrementing its count, in the future
6612 * SORT may have options able to overwrite/delete keys during the sorting
6613 * and the sorted key itself may get destroied */
6614 incrRefCount(sortval
);
6616 /* The SORT command has an SQL-alike syntax, parse it */
6617 while(j
< c
->argc
) {
6618 int leftargs
= c
->argc
-j
-1;
6619 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
6621 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
6623 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
6625 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
6626 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
6627 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
6629 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
6630 storekey
= c
->argv
[j
+1];
6632 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
6633 sortby
= c
->argv
[j
+1];
6634 /* If the BY pattern does not contain '*', i.e. it is constant,
6635 * we don't need to sort nor to lookup the weight keys. */
6636 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
6638 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
6639 listAddNodeTail(operations
,createSortOperation(
6640 REDIS_SORT_GET
,c
->argv
[j
+1]));
6644 decrRefCount(sortval
);
6645 listRelease(operations
);
6646 addReply(c
,shared
.syntaxerr
);
6652 /* Load the sorting vector with all the objects to sort */
6653 switch(sortval
->type
) {
6654 case REDIS_LIST
: vectorlen
= listLength((list
*)sortval
->ptr
); break;
6655 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
6656 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
6657 default: vectorlen
= 0; redisAssert(0); /* Avoid GCC warning */
6659 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
6662 if (sortval
->type
== REDIS_LIST
) {
6663 list
*list
= sortval
->ptr
;
6667 listRewind(list
,&li
);
6668 while((ln
= listNext(&li
))) {
6669 robj
*ele
= ln
->value
;
6670 vector
[j
].obj
= ele
;
6671 vector
[j
].u
.score
= 0;
6672 vector
[j
].u
.cmpobj
= NULL
;
6680 if (sortval
->type
== REDIS_SET
) {
6683 zset
*zs
= sortval
->ptr
;
6687 di
= dictGetIterator(set
);
6688 while((setele
= dictNext(di
)) != NULL
) {
6689 vector
[j
].obj
= dictGetEntryKey(setele
);
6690 vector
[j
].u
.score
= 0;
6691 vector
[j
].u
.cmpobj
= NULL
;
6694 dictReleaseIterator(di
);
6696 redisAssert(j
== vectorlen
);
6698 /* Now it's time to load the right scores in the sorting vector */
6699 if (dontsort
== 0) {
6700 for (j
= 0; j
< vectorlen
; j
++) {
6703 /* lookup value to sort by */
6704 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
6705 if (!byval
|| byval
->type
!= REDIS_STRING
) continue;
6707 /* use object itself to sort by */
6708 byval
= vector
[j
].obj
;
6712 /* getDecodedObject increments refcount, so the corresponding
6713 * decrRefCount will clean up values coming from a zipmap. */
6714 vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
6716 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
6717 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
6718 } else if (byval
->encoding
== REDIS_ENCODING_INT
) {
6719 /* Don't need to decode the object if it's
6720 * integer-encoded (the only encoding supported) so
6721 * far. We can just cast it */
6722 vector
[j
].u
.score
= (long)byval
->ptr
;
6724 redisAssert(1 != 1);
6727 /* clean up immediately if this value came from a zipmap */
6728 if (byval
->refcount
== 0) {
6729 byval
->refcount
= 1;
6730 decrRefCount(byval
);
6736 /* We are ready to sort the vector... perform a bit of sanity check
6737 * on the LIMIT option too. We'll use a partial version of quicksort. */
6738 start
= (limit_start
< 0) ? 0 : limit_start
;
6739 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
6740 if (start
>= vectorlen
) {
6741 start
= vectorlen
-1;
6744 if (end
>= vectorlen
) end
= vectorlen
-1;
6746 if (dontsort
== 0) {
6747 server
.sort_desc
= desc
;
6748 server
.sort_alpha
= alpha
;
6749 server
.sort_bypattern
= sortby
? 1 : 0;
6750 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
6751 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
6753 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
6756 /* Send command output to the output buffer, performing the specified
6757 * GET/DEL/INCR/DECR operations if any. */
6758 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
6759 if (storekey
== NULL
) {
6760 /* STORE option not specified, sent the sorting result to client */
6761 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
6762 for (j
= start
; j
<= end
; j
++) {
6766 if (!getop
) addReplyBulk(c
,vector
[j
].obj
);
6767 listRewind(operations
,&li
);
6768 while((ln
= listNext(&li
))) {
6769 redisSortOperation
*sop
= ln
->value
;
6770 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
6773 if (sop
->type
== REDIS_SORT_GET
) {
6774 if (!val
|| val
->type
!= REDIS_STRING
) {
6775 addReply(c
,shared
.nullbulk
);
6777 addReplyBulk(c
,val
);
6780 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
6785 robj
*listObject
= createListObject();
6786 list
*listPtr
= (list
*) listObject
->ptr
;
6788 /* STORE option specified, set the sorting result as a List object */
6789 for (j
= start
; j
<= end
; j
++) {
6794 listAddNodeTail(listPtr
,vector
[j
].obj
);
6795 incrRefCount(vector
[j
].obj
);
6797 listRewind(operations
,&li
);
6798 while((ln
= listNext(&li
))) {
6799 redisSortOperation
*sop
= ln
->value
;
6800 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
6803 if (sop
->type
== REDIS_SORT_GET
) {
6804 if (!val
|| val
->type
!= REDIS_STRING
) {
6805 listAddNodeTail(listPtr
,createStringObject("",0));
6807 listAddNodeTail(listPtr
,val
);
6811 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
6815 if (dictReplace(c
->db
->dict
,storekey
,listObject
)) {
6816 incrRefCount(storekey
);
6818 /* Note: we add 1 because the DB is dirty anyway since even if the
6819 * SORT result is empty a new key is set and maybe the old content
6821 server
.dirty
+= 1+outputlen
;
6822 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
6826 decrRefCount(sortval
);
6827 listRelease(operations
);
6828 for (j
= 0; j
< vectorlen
; j
++) {
6829 if (alpha
&& vector
[j
].u
.cmpobj
)
6830 decrRefCount(vector
[j
].u
.cmpobj
);
6835 /* Convert an amount of bytes into a human readable string in the form
6836 * of 100B, 2G, 100M, 4K, and so forth. */
6837 static void bytesToHuman(char *s
, unsigned long long n
) {
6842 sprintf(s
,"%lluB",n
);
6844 } else if (n
< (1024*1024)) {
6845 d
= (double)n
/(1024);
6846 sprintf(s
,"%.2fK",d
);
6847 } else if (n
< (1024LL*1024*1024)) {
6848 d
= (double)n
/(1024*1024);
6849 sprintf(s
,"%.2fM",d
);
6850 } else if (n
< (1024LL*1024*1024*1024)) {
6851 d
= (double)n
/(1024LL*1024*1024);
6852 sprintf(s
,"%.2fG",d
);
6856 /* Create the string returned by the INFO command. This is decoupled
6857 * by the INFO command itself as we need to report the same information
6858 * on memory corruption problems. */
6859 static sds
genRedisInfoString(void) {
6861 time_t uptime
= time(NULL
)-server
.stat_starttime
;
6865 bytesToHuman(hmem
,zmalloc_used_memory());
6866 info
= sdscatprintf(sdsempty(),
6867 "redis_version:%s\r\n"
6869 "multiplexing_api:%s\r\n"
6870 "process_id:%ld\r\n"
6871 "uptime_in_seconds:%ld\r\n"
6872 "uptime_in_days:%ld\r\n"
6873 "connected_clients:%d\r\n"
6874 "connected_slaves:%d\r\n"
6875 "blocked_clients:%d\r\n"
6876 "used_memory:%zu\r\n"
6877 "used_memory_human:%s\r\n"
6878 "changes_since_last_save:%lld\r\n"
6879 "bgsave_in_progress:%d\r\n"
6880 "last_save_time:%ld\r\n"
6881 "bgrewriteaof_in_progress:%d\r\n"
6882 "total_connections_received:%lld\r\n"
6883 "total_commands_processed:%lld\r\n"
6884 "expired_keys:%lld\r\n"
6885 "hash_max_zipmap_entries:%ld\r\n"
6886 "hash_max_zipmap_value:%ld\r\n"
6887 "pubsub_channels:%ld\r\n"
6888 "pubsub_patterns:%u\r\n"
6892 (sizeof(long) == 8) ? "64" : "32",
6897 listLength(server
.clients
)-listLength(server
.slaves
),
6898 listLength(server
.slaves
),
6899 server
.blpop_blocked_clients
,
6900 zmalloc_used_memory(),
6903 server
.bgsavechildpid
!= -1,
6905 server
.bgrewritechildpid
!= -1,
6906 server
.stat_numconnections
,
6907 server
.stat_numcommands
,
6908 server
.stat_expiredkeys
,
6909 server
.hash_max_zipmap_entries
,
6910 server
.hash_max_zipmap_value
,
6911 dictSize(server
.pubsub_channels
),
6912 listLength(server
.pubsub_patterns
),
6913 server
.vm_enabled
!= 0,
6914 server
.masterhost
== NULL
? "master" : "slave"
6916 if (server
.masterhost
) {
6917 info
= sdscatprintf(info
,
6918 "master_host:%s\r\n"
6919 "master_port:%d\r\n"
6920 "master_link_status:%s\r\n"
6921 "master_last_io_seconds_ago:%d\r\n"
6924 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
6926 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
6929 if (server
.vm_enabled
) {
6931 info
= sdscatprintf(info
,
6932 "vm_conf_max_memory:%llu\r\n"
6933 "vm_conf_page_size:%llu\r\n"
6934 "vm_conf_pages:%llu\r\n"
6935 "vm_stats_used_pages:%llu\r\n"
6936 "vm_stats_swapped_objects:%llu\r\n"
6937 "vm_stats_swappin_count:%llu\r\n"
6938 "vm_stats_swappout_count:%llu\r\n"
6939 "vm_stats_io_newjobs_len:%lu\r\n"
6940 "vm_stats_io_processing_len:%lu\r\n"
6941 "vm_stats_io_processed_len:%lu\r\n"
6942 "vm_stats_io_active_threads:%lu\r\n"
6943 "vm_stats_blocked_clients:%lu\r\n"
6944 ,(unsigned long long) server
.vm_max_memory
,
6945 (unsigned long long) server
.vm_page_size
,
6946 (unsigned long long) server
.vm_pages
,
6947 (unsigned long long) server
.vm_stats_used_pages
,
6948 (unsigned long long) server
.vm_stats_swapped_objects
,
6949 (unsigned long long) server
.vm_stats_swapins
,
6950 (unsigned long long) server
.vm_stats_swapouts
,
6951 (unsigned long) listLength(server
.io_newjobs
),
6952 (unsigned long) listLength(server
.io_processing
),
6953 (unsigned long) listLength(server
.io_processed
),
6954 (unsigned long) server
.io_active_threads
,
6955 (unsigned long) server
.vm_blocked_clients
6959 for (j
= 0; j
< server
.dbnum
; j
++) {
6960 long long keys
, vkeys
;
6962 keys
= dictSize(server
.db
[j
].dict
);
6963 vkeys
= dictSize(server
.db
[j
].expires
);
6964 if (keys
|| vkeys
) {
6965 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
6972 static void infoCommand(redisClient
*c
) {
6973 sds info
= genRedisInfoString();
6974 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
6975 (unsigned long)sdslen(info
)));
6976 addReplySds(c
,info
);
6977 addReply(c
,shared
.crlf
);
6980 static void monitorCommand(redisClient
*c
) {
6981 /* ignore MONITOR if aleady slave or in monitor mode */
6982 if (c
->flags
& REDIS_SLAVE
) return;
6984 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
6986 listAddNodeTail(server
.monitors
,c
);
6987 addReply(c
,shared
.ok
);
6990 /* ================================= Expire ================================= */
6991 static int removeExpire(redisDb
*db
, robj
*key
) {
6992 if (dictDelete(db
->expires
,key
) == DICT_OK
) {
6999 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
7000 if (dictAdd(db
->expires
,key
,(void*)when
) == DICT_ERR
) {
7008 /* Return the expire time of the specified key, or -1 if no expire
7009 * is associated with this key (i.e. the key is non volatile) */
7010 static time_t getExpire(redisDb
*db
, robj
*key
) {
7013 /* No expire? return ASAP */
7014 if (dictSize(db
->expires
) == 0 ||
7015 (de
= dictFind(db
->expires
,key
)) == NULL
) return -1;
7017 return (time_t) dictGetEntryVal(de
);
7020 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
7024 /* No expire? return ASAP */
7025 if (dictSize(db
->expires
) == 0 ||
7026 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
7028 /* Lookup the expire */
7029 when
= (time_t) dictGetEntryVal(de
);
7030 if (time(NULL
) <= when
) return 0;
7032 /* Delete the key */
7033 dictDelete(db
->expires
,key
);
7034 server
.stat_expiredkeys
++;
7035 return dictDelete(db
->dict
,key
) == DICT_OK
;
7038 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
7041 /* No expire? return ASAP */
7042 if (dictSize(db
->expires
) == 0 ||
7043 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
7045 /* Delete the key */
7047 server
.stat_expiredkeys
++;
7048 dictDelete(db
->expires
,key
);
7049 return dictDelete(db
->dict
,key
) == DICT_OK
;
7052 static void expireGenericCommand(redisClient
*c
, robj
*key
, robj
*param
, long offset
) {
7056 if (getLongFromObject(c
, param
, &seconds
) != REDIS_OK
) return;
7060 de
= dictFind(c
->db
->dict
,key
);
7062 addReply(c
,shared
.czero
);
7066 if (deleteKey(c
->db
,key
)) server
.dirty
++;
7067 addReply(c
, shared
.cone
);
7070 time_t when
= time(NULL
)+seconds
;
7071 if (setExpire(c
->db
,key
,when
)) {
7072 addReply(c
,shared
.cone
);
7075 addReply(c
,shared
.czero
);
7081 static void expireCommand(redisClient
*c
) {
7082 expireGenericCommand(c
,c
->argv
[1],c
->argv
[2],0);
7085 static void expireatCommand(redisClient
*c
) {
7086 expireGenericCommand(c
,c
->argv
[1],c
->argv
[2],time(NULL
));
7089 static void ttlCommand(redisClient
*c
) {
7093 expire
= getExpire(c
->db
,c
->argv
[1]);
7095 ttl
= (int) (expire
-time(NULL
));
7096 if (ttl
< 0) ttl
= -1;
7098 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
7101 /* ================================ MULTI/EXEC ============================== */
7103 /* Client state initialization for MULTI/EXEC */
7104 static void initClientMultiState(redisClient
*c
) {
7105 c
->mstate
.commands
= NULL
;
7106 c
->mstate
.count
= 0;
7109 /* Release all the resources associated with MULTI/EXEC state */
7110 static void freeClientMultiState(redisClient
*c
) {
7113 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7115 multiCmd
*mc
= c
->mstate
.commands
+j
;
7117 for (i
= 0; i
< mc
->argc
; i
++)
7118 decrRefCount(mc
->argv
[i
]);
7121 zfree(c
->mstate
.commands
);
7124 /* Add a new command into the MULTI commands queue */
7125 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
7129 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
7130 sizeof(multiCmd
)*(c
->mstate
.count
+1));
7131 mc
= c
->mstate
.commands
+c
->mstate
.count
;
7134 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
7135 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
7136 for (j
= 0; j
< c
->argc
; j
++)
7137 incrRefCount(mc
->argv
[j
]);
7141 static void multiCommand(redisClient
*c
) {
7142 c
->flags
|= REDIS_MULTI
;
7143 addReply(c
,shared
.ok
);
7146 static void discardCommand(redisClient
*c
) {
7147 if (!(c
->flags
& REDIS_MULTI
)) {
7148 addReplySds(c
,sdsnew("-ERR DISCARD without MULTI\r\n"));
7152 freeClientMultiState(c
);
7153 initClientMultiState(c
);
7154 c
->flags
&= (~REDIS_MULTI
);
7155 addReply(c
,shared
.ok
);
7158 static void execCommand(redisClient
*c
) {
7163 if (!(c
->flags
& REDIS_MULTI
)) {
7164 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
7168 orig_argv
= c
->argv
;
7169 orig_argc
= c
->argc
;
7170 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
7171 for (j
= 0; j
< c
->mstate
.count
; j
++) {
7172 c
->argc
= c
->mstate
.commands
[j
].argc
;
7173 c
->argv
= c
->mstate
.commands
[j
].argv
;
7174 call(c
,c
->mstate
.commands
[j
].cmd
);
7176 c
->argv
= orig_argv
;
7177 c
->argc
= orig_argc
;
7178 freeClientMultiState(c
);
7179 initClientMultiState(c
);
7180 c
->flags
&= (~REDIS_MULTI
);
7183 /* =========================== Blocking Operations ========================= */
7185 /* Currently Redis blocking operations support is limited to list POP ops,
7186 * so the current implementation is not fully generic, but it is also not
7187 * completely specific so it will not require a rewrite to support new
7188 * kind of blocking operations in the future.
7190 * Still it's important to note that list blocking operations can be already
7191 * used as a notification mechanism in order to implement other blocking
7192 * operations at application level, so there must be a very strong evidence
7193 * of usefulness and generality before new blocking operations are implemented.
7195 * This is how the current blocking POP works, we use BLPOP as example:
7196 * - If the user calls BLPOP and the key exists and contains a non empty list
7197 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
7198 * if there is not to block.
7199 * - If instead BLPOP is called and the key does not exists or the list is
7200 * empty we need to block. In order to do so we remove the notification for
7201 * new data to read in the client socket (so that we'll not serve new
7202 * requests if the blocking request is not served). Also we put the client
7203 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
7204 * blocking for this keys.
7205 * - If a PUSH operation against a key with blocked clients waiting is
7206 * performed, we serve the first in the list: basically instead to push
7207 * the new element inside the list we return it to the (first / oldest)
7208 * blocking client, unblock the client, and remove it form the list.
7210 * The above comment and the source code should be enough in order to understand
7211 * the implementation and modify / fix it later.
7214 /* Set a client in blocking mode for the specified key, with the specified
7216 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
7221 c
->blockingkeys
= zmalloc(sizeof(robj
*)*numkeys
);
7222 c
->blockingkeysnum
= numkeys
;
7223 c
->blockingto
= timeout
;
7224 for (j
= 0; j
< numkeys
; j
++) {
7225 /* Add the key in the client structure, to map clients -> keys */
7226 c
->blockingkeys
[j
] = keys
[j
];
7227 incrRefCount(keys
[j
]);
7229 /* And in the other "side", to map keys -> clients */
7230 de
= dictFind(c
->db
->blockingkeys
,keys
[j
]);
7234 /* For every key we take a list of clients blocked for it */
7236 retval
= dictAdd(c
->db
->blockingkeys
,keys
[j
],l
);
7237 incrRefCount(keys
[j
]);
7238 assert(retval
== DICT_OK
);
7240 l
= dictGetEntryVal(de
);
7242 listAddNodeTail(l
,c
);
7244 /* Mark the client as a blocked client */
7245 c
->flags
|= REDIS_BLOCKED
;
7246 server
.blpop_blocked_clients
++;
7249 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
7250 static void unblockClientWaitingData(redisClient
*c
) {
7255 assert(c
->blockingkeys
!= NULL
);
7256 /* The client may wait for multiple keys, so unblock it for every key. */
7257 for (j
= 0; j
< c
->blockingkeysnum
; j
++) {
7258 /* Remove this client from the list of clients waiting for this key. */
7259 de
= dictFind(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
7261 l
= dictGetEntryVal(de
);
7262 listDelNode(l
,listSearchKey(l
,c
));
7263 /* If the list is empty we need to remove it to avoid wasting memory */
7264 if (listLength(l
) == 0)
7265 dictDelete(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
7266 decrRefCount(c
->blockingkeys
[j
]);
7268 /* Cleanup the client structure */
7269 zfree(c
->blockingkeys
);
7270 c
->blockingkeys
= NULL
;
7271 c
->flags
&= (~REDIS_BLOCKED
);
7272 server
.blpop_blocked_clients
--;
7273 /* We want to process data if there is some command waiting
7274 * in the input buffer. Note that this is safe even if
7275 * unblockClientWaitingData() gets called from freeClient() because
7276 * freeClient() will be smart enough to call this function
7277 * *after* c->querybuf was set to NULL. */
7278 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
7281 /* This should be called from any function PUSHing into lists.
7282 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
7283 * 'ele' is the element pushed.
7285 * If the function returns 0 there was no client waiting for a list push
7288 * If the function returns 1 there was a client waiting for a list push
7289 * against this key, the element was passed to this client thus it's not
7290 * needed to actually add it to the list and the caller should return asap. */
7291 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
7292 struct dictEntry
*de
;
7293 redisClient
*receiver
;
7297 de
= dictFind(c
->db
->blockingkeys
,key
);
7298 if (de
== NULL
) return 0;
7299 l
= dictGetEntryVal(de
);
7302 receiver
= ln
->value
;
7304 addReplySds(receiver
,sdsnew("*2\r\n"));
7305 addReplyBulk(receiver
,key
);
7306 addReplyBulk(receiver
,ele
);
7307 unblockClientWaitingData(receiver
);
7311 /* Blocking RPOP/LPOP */
7312 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
7317 for (j
= 1; j
< c
->argc
-1; j
++) {
7318 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
7320 if (o
->type
!= REDIS_LIST
) {
7321 addReply(c
,shared
.wrongtypeerr
);
7324 list
*list
= o
->ptr
;
7325 if (listLength(list
) != 0) {
7326 /* If the list contains elements fall back to the usual
7327 * non-blocking POP operation */
7328 robj
*argv
[2], **orig_argv
;
7331 /* We need to alter the command arguments before to call
7332 * popGenericCommand() as the command takes a single key. */
7333 orig_argv
= c
->argv
;
7334 orig_argc
= c
->argc
;
7335 argv
[1] = c
->argv
[j
];
7339 /* Also the return value is different, we need to output
7340 * the multi bulk reply header and the key name. The
7341 * "real" command will add the last element (the value)
7342 * for us. If this souds like an hack to you it's just
7343 * because it is... */
7344 addReplySds(c
,sdsnew("*2\r\n"));
7345 addReplyBulk(c
,argv
[1]);
7346 popGenericCommand(c
,where
);
7348 /* Fix the client structure with the original stuff */
7349 c
->argv
= orig_argv
;
7350 c
->argc
= orig_argc
;
7356 /* If the list is empty or the key does not exists we must block */
7357 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
7358 if (timeout
> 0) timeout
+= time(NULL
);
7359 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
7362 static void blpopCommand(redisClient
*c
) {
7363 blockingPopGenericCommand(c
,REDIS_HEAD
);
7366 static void brpopCommand(redisClient
*c
) {
7367 blockingPopGenericCommand(c
,REDIS_TAIL
);
7370 /* =============================== Replication ============================= */
7372 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7373 ssize_t nwritten
, ret
= size
;
7374 time_t start
= time(NULL
);
7378 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
7379 nwritten
= write(fd
,ptr
,size
);
7380 if (nwritten
== -1) return -1;
7384 if ((time(NULL
)-start
) > timeout
) {
7392 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7393 ssize_t nread
, totread
= 0;
7394 time_t start
= time(NULL
);
7398 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
7399 nread
= read(fd
,ptr
,size
);
7400 if (nread
== -1) return -1;
7405 if ((time(NULL
)-start
) > timeout
) {
7413 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
7420 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
7423 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
7434 static void syncCommand(redisClient
*c
) {
7435 /* ignore SYNC if aleady slave or in monitor mode */
7436 if (c
->flags
& REDIS_SLAVE
) return;
7438 /* SYNC can't be issued when the server has pending data to send to
7439 * the client about already issued commands. We need a fresh reply
7440 * buffer registering the differences between the BGSAVE and the current
7441 * dataset, so that we can copy to other slaves if needed. */
7442 if (listLength(c
->reply
) != 0) {
7443 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
7447 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
7448 /* Here we need to check if there is a background saving operation
7449 * in progress, or if it is required to start one */
7450 if (server
.bgsavechildpid
!= -1) {
7451 /* Ok a background save is in progress. Let's check if it is a good
7452 * one for replication, i.e. if there is another slave that is
7453 * registering differences since the server forked to save */
7458 listRewind(server
.slaves
,&li
);
7459 while((ln
= listNext(&li
))) {
7461 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
7464 /* Perfect, the server is already registering differences for
7465 * another slave. Set the right state, and copy the buffer. */
7466 listRelease(c
->reply
);
7467 c
->reply
= listDup(slave
->reply
);
7468 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7469 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
7471 /* No way, we need to wait for the next BGSAVE in order to
7472 * register differences */
7473 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7474 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
7477 /* Ok we don't have a BGSAVE in progress, let's start one */
7478 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
7479 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7480 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
7481 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
7484 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7487 c
->flags
|= REDIS_SLAVE
;
7489 listAddNodeTail(server
.slaves
,c
);
7493 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
7494 redisClient
*slave
= privdata
;
7496 REDIS_NOTUSED(mask
);
7497 char buf
[REDIS_IOBUF_LEN
];
7498 ssize_t nwritten
, buflen
;
7500 if (slave
->repldboff
== 0) {
7501 /* Write the bulk write count before to transfer the DB. In theory here
7502 * we don't know how much room there is in the output buffer of the
7503 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
7504 * operations) will never be smaller than the few bytes we need. */
7507 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
7509 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
7517 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
7518 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
7520 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
7521 (buflen
== 0) ? "premature EOF" : strerror(errno
));
7525 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
7526 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
7531 slave
->repldboff
+= nwritten
;
7532 if (slave
->repldboff
== slave
->repldbsize
) {
7533 close(slave
->repldbfd
);
7534 slave
->repldbfd
= -1;
7535 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7536 slave
->replstate
= REDIS_REPL_ONLINE
;
7537 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
7538 sendReplyToClient
, slave
) == AE_ERR
) {
7542 addReplySds(slave
,sdsempty());
7543 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
7547 /* This function is called at the end of every backgrond saving.
7548 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
7549 * otherwise REDIS_ERR is passed to the function.
7551 * The goal of this function is to handle slaves waiting for a successful
7552 * background saving in order to perform non-blocking synchronization. */
7553 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
7555 int startbgsave
= 0;
7558 listRewind(server
.slaves
,&li
);
7559 while((ln
= listNext(&li
))) {
7560 redisClient
*slave
= ln
->value
;
7562 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
7564 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
7565 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
7566 struct redis_stat buf
;
7568 if (bgsaveerr
!= REDIS_OK
) {
7570 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
7573 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
7574 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
7576 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
7579 slave
->repldboff
= 0;
7580 slave
->repldbsize
= buf
.st_size
;
7581 slave
->replstate
= REDIS_REPL_SEND_BULK
;
7582 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
7583 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
7590 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
7593 listRewind(server
.slaves
,&li
);
7594 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
7595 while((ln
= listNext(&li
))) {
7596 redisClient
*slave
= ln
->value
;
7598 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
7605 static int syncWithMaster(void) {
7606 char buf
[1024], tmpfile
[256], authcmd
[1024];
7608 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
7609 int dfd
, maxtries
= 5;
7612 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
7617 /* AUTH with the master if required. */
7618 if(server
.masterauth
) {
7619 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
7620 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
7622 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
7626 /* Read the AUTH result. */
7627 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7629 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
7633 if (buf
[0] != '+') {
7635 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
7640 /* Issue the SYNC command */
7641 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
7643 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
7647 /* Read the bulk write count */
7648 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
7650 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
7654 if (buf
[0] != '$') {
7656 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
7659 dumpsize
= strtol(buf
+1,NULL
,10);
7660 redisLog(REDIS_NOTICE
,"Receiving %ld bytes data dump from MASTER",dumpsize
);
7661 /* Read the bulk write data on a temp file */
7663 snprintf(tmpfile
,256,
7664 "temp-%d.%ld.rdb",(int)time(NULL
),(long int)getpid());
7665 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
|O_EXCL
,0644);
7666 if (dfd
!= -1) break;
7671 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
7675 int nread
, nwritten
;
7677 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
7679 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
7685 nwritten
= write(dfd
,buf
,nread
);
7686 if (nwritten
== -1) {
7687 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
7695 if (rename(tmpfile
,server
.dbfilename
) == -1) {
7696 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
7702 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
7703 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
7707 server
.master
= createClient(fd
);
7708 server
.master
->flags
|= REDIS_MASTER
;
7709 server
.master
->authenticated
= 1;
7710 server
.replstate
= REDIS_REPL_CONNECTED
;
7714 static void slaveofCommand(redisClient
*c
) {
7715 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
7716 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
7717 if (server
.masterhost
) {
7718 sdsfree(server
.masterhost
);
7719 server
.masterhost
= NULL
;
7720 if (server
.master
) freeClient(server
.master
);
7721 server
.replstate
= REDIS_REPL_NONE
;
7722 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
7725 sdsfree(server
.masterhost
);
7726 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
7727 server
.masterport
= atoi(c
->argv
[2]->ptr
);
7728 if (server
.master
) freeClient(server
.master
);
7729 server
.replstate
= REDIS_REPL_CONNECT
;
7730 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
7731 server
.masterhost
, server
.masterport
);
7733 addReply(c
,shared
.ok
);
7736 /* ============================ Maxmemory directive ======================== */
7738 /* Try to free one object form the pre-allocated objects free list.
7739 * This is useful under low mem conditions as by default we take 1 million
7740 * free objects allocated. On success REDIS_OK is returned, otherwise
7742 static int tryFreeOneObjectFromFreelist(void) {
7745 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
7746 if (listLength(server
.objfreelist
)) {
7747 listNode
*head
= listFirst(server
.objfreelist
);
7748 o
= listNodeValue(head
);
7749 listDelNode(server
.objfreelist
,head
);
7750 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7754 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
7759 /* This function gets called when 'maxmemory' is set on the config file to limit
7760 * the max memory used by the server, and we are out of memory.
7761 * This function will try to, in order:
7763 * - Free objects from the free list
7764 * - Try to remove keys with an EXPIRE set
7766 * It is not possible to free enough memory to reach used-memory < maxmemory
7767 * the server will start refusing commands that will enlarge even more the
7770 static void freeMemoryIfNeeded(void) {
7771 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
7772 int j
, k
, freed
= 0;
7774 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
7775 for (j
= 0; j
< server
.dbnum
; j
++) {
7777 robj
*minkey
= NULL
;
7778 struct dictEntry
*de
;
7780 if (dictSize(server
.db
[j
].expires
)) {
7782 /* From a sample of three keys drop the one nearest to
7783 * the natural expire */
7784 for (k
= 0; k
< 3; k
++) {
7787 de
= dictGetRandomKey(server
.db
[j
].expires
);
7788 t
= (time_t) dictGetEntryVal(de
);
7789 if (minttl
== -1 || t
< minttl
) {
7790 minkey
= dictGetEntryKey(de
);
7794 deleteKey(server
.db
+j
,minkey
);
7797 if (!freed
) return; /* nothing to free... */
7801 /* ============================== Append Only file ========================== */
7803 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
7804 sds buf
= sdsempty();
7810 /* The DB this command was targetting is not the same as the last command
7811 * we appendend. To issue a SELECT command is needed. */
7812 if (dictid
!= server
.appendseldb
) {
7815 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
7816 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
7817 (unsigned long)strlen(seldb
),seldb
);
7818 server
.appendseldb
= dictid
;
7821 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
7822 * EXPIREs into EXPIREATs calls */
7823 if (cmd
->proc
== expireCommand
) {
7826 tmpargv
[0] = createStringObject("EXPIREAT",8);
7827 tmpargv
[1] = argv
[1];
7828 incrRefCount(argv
[1]);
7829 when
= time(NULL
)+strtol(argv
[2]->ptr
,NULL
,10);
7830 tmpargv
[2] = createObject(REDIS_STRING
,
7831 sdscatprintf(sdsempty(),"%ld",when
));
7835 /* Append the actual command */
7836 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
7837 for (j
= 0; j
< argc
; j
++) {
7840 o
= getDecodedObject(o
);
7841 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
7842 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
7843 buf
= sdscatlen(buf
,"\r\n",2);
7847 /* Free the objects from the modified argv for EXPIREAT */
7848 if (cmd
->proc
== expireCommand
) {
7849 for (j
= 0; j
< 3; j
++)
7850 decrRefCount(argv
[j
]);
7853 /* We want to perform a single write. This should be guaranteed atomic
7854 * at least if the filesystem we are writing is a real physical one.
7855 * While this will save us against the server being killed I don't think
7856 * there is much to do about the whole server stopping for power problems
7858 nwritten
= write(server
.appendfd
,buf
,sdslen(buf
));
7859 if (nwritten
!= (signed)sdslen(buf
)) {
7860 /* Ooops, we are in troubles. The best thing to do for now is
7861 * to simply exit instead to give the illusion that everything is
7862 * working as expected. */
7863 if (nwritten
== -1) {
7864 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
7866 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
7870 /* If a background append only file rewriting is in progress we want to
7871 * accumulate the differences between the child DB and the current one
7872 * in a buffer, so that when the child process will do its work we
7873 * can append the differences to the new append only file. */
7874 if (server
.bgrewritechildpid
!= -1)
7875 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
7879 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
7880 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
7881 now
-server
.lastfsync
> 1))
7883 fsync(server
.appendfd
); /* Let's try to get this data on the disk */
7884 server
.lastfsync
= now
;
7888 /* In Redis commands are always executed in the context of a client, so in
7889 * order to load the append only file we need to create a fake client. */
7890 static struct redisClient
*createFakeClient(void) {
7891 struct redisClient
*c
= zmalloc(sizeof(*c
));
7895 c
->querybuf
= sdsempty();
7899 /* We set the fake client as a slave waiting for the synchronization
7900 * so that Redis will not try to send replies to this client. */
7901 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
7902 c
->reply
= listCreate();
7903 listSetFreeMethod(c
->reply
,decrRefCount
);
7904 listSetDupMethod(c
->reply
,dupClientReplyValue
);
7908 static void freeFakeClient(struct redisClient
*c
) {
7909 sdsfree(c
->querybuf
);
7910 listRelease(c
->reply
);
7914 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
7915 * error (the append only file is zero-length) REDIS_ERR is returned. On
7916 * fatal error an error message is logged and the program exists. */
7917 int loadAppendOnlyFile(char *filename
) {
7918 struct redisClient
*fakeClient
;
7919 FILE *fp
= fopen(filename
,"r");
7920 struct redis_stat sb
;
7921 unsigned long long loadedkeys
= 0;
7923 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
7927 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
7931 fakeClient
= createFakeClient();
7938 struct redisCommand
*cmd
;
7940 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
7946 if (buf
[0] != '*') goto fmterr
;
7948 argv
= zmalloc(sizeof(robj
*)*argc
);
7949 for (j
= 0; j
< argc
; j
++) {
7950 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
7951 if (buf
[0] != '$') goto fmterr
;
7952 len
= strtol(buf
+1,NULL
,10);
7953 argsds
= sdsnewlen(NULL
,len
);
7954 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
7955 argv
[j
] = createObject(REDIS_STRING
,argsds
);
7956 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
7959 /* Command lookup */
7960 cmd
= lookupCommand(argv
[0]->ptr
);
7962 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
7965 /* Try object encoding */
7966 if (cmd
->flags
& REDIS_CMD_BULK
)
7967 argv
[argc
-1] = tryObjectEncoding(argv
[argc
-1]);
7968 /* Run the command in the context of a fake client */
7969 fakeClient
->argc
= argc
;
7970 fakeClient
->argv
= argv
;
7971 cmd
->proc(fakeClient
);
7972 /* Discard the reply objects list from the fake client */
7973 while(listLength(fakeClient
->reply
))
7974 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
7975 /* Clean up, ready for the next command */
7976 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
7978 /* Handle swapping while loading big datasets when VM is on */
7980 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
7981 while (zmalloc_used_memory() > server
.vm_max_memory
) {
7982 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
7987 freeFakeClient(fakeClient
);
7992 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
7994 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
7998 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
8002 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
8003 static int fwriteBulkObject(FILE *fp
, robj
*obj
) {
8007 /* Avoid the incr/decr ref count business if possible to help
8008 * copy-on-write (we are often in a child process when this function
8010 * Also makes sure that key objects don't get incrRefCount-ed when VM
8012 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
8013 obj
= getDecodedObject(obj
);
8016 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
8017 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
8018 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
8020 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
8021 if (decrrc
) decrRefCount(obj
);
8024 if (decrrc
) decrRefCount(obj
);
8028 /* Write binary-safe string into a file in the bulkformat
8029 * $<count>\r\n<payload>\r\n */
8030 static int fwriteBulkString(FILE *fp
, char *s
, unsigned long len
) {
8033 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(unsigned long)len
);
8034 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8035 if (len
&& fwrite(s
,len
,1,fp
) == 0) return 0;
8036 if (fwrite("\r\n",2,1,fp
) == 0) return 0;
8040 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
8041 static int fwriteBulkDouble(FILE *fp
, double d
) {
8042 char buf
[128], dbuf
[128];
8044 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
8045 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
8046 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8047 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
8051 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
8052 static int fwriteBulkLong(FILE *fp
, long l
) {
8053 char buf
[128], lbuf
[128];
8055 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
8056 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
8057 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
8058 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
8062 /* Write a sequence of commands able to fully rebuild the dataset into
8063 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
8064 static int rewriteAppendOnlyFile(char *filename
) {
8065 dictIterator
*di
= NULL
;
8070 time_t now
= time(NULL
);
8072 /* Note that we have to use a different temp name here compared to the
8073 * one used by rewriteAppendOnlyFileBackground() function. */
8074 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
8075 fp
= fopen(tmpfile
,"w");
8077 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
8080 for (j
= 0; j
< server
.dbnum
; j
++) {
8081 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
8082 redisDb
*db
= server
.db
+j
;
8084 if (dictSize(d
) == 0) continue;
8085 di
= dictGetIterator(d
);
8091 /* SELECT the new DB */
8092 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
8093 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
8095 /* Iterate this DB writing every entry */
8096 while((de
= dictNext(di
)) != NULL
) {
8101 key
= dictGetEntryKey(de
);
8102 /* If the value for this key is swapped, load a preview in memory.
8103 * We use a "swapped" flag to remember if we need to free the
8104 * value object instead to just increment the ref count anyway
8105 * in order to avoid copy-on-write of pages if we are forked() */
8106 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
8107 key
->storage
== REDIS_VM_SWAPPING
) {
8108 o
= dictGetEntryVal(de
);
8111 o
= vmPreviewObject(key
);
8114 expiretime
= getExpire(db
,key
);
8116 /* Save the key and associated value */
8117 if (o
->type
== REDIS_STRING
) {
8118 /* Emit a SET command */
8119 char cmd
[]="*3\r\n$3\r\nSET\r\n";
8120 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8122 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8123 if (fwriteBulkObject(fp
,o
) == 0) goto werr
;
8124 } else if (o
->type
== REDIS_LIST
) {
8125 /* Emit the RPUSHes needed to rebuild the list */
8126 list
*list
= o
->ptr
;
8130 listRewind(list
,&li
);
8131 while((ln
= listNext(&li
))) {
8132 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
8133 robj
*eleobj
= listNodeValue(ln
);
8135 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8136 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8137 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8139 } else if (o
->type
== REDIS_SET
) {
8140 /* Emit the SADDs needed to rebuild the set */
8142 dictIterator
*di
= dictGetIterator(set
);
8145 while((de
= dictNext(di
)) != NULL
) {
8146 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
8147 robj
*eleobj
= dictGetEntryKey(de
);
8149 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8150 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8151 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8153 dictReleaseIterator(di
);
8154 } else if (o
->type
== REDIS_ZSET
) {
8155 /* Emit the ZADDs needed to rebuild the sorted set */
8157 dictIterator
*di
= dictGetIterator(zs
->dict
);
8160 while((de
= dictNext(di
)) != NULL
) {
8161 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
8162 robj
*eleobj
= dictGetEntryKey(de
);
8163 double *score
= dictGetEntryVal(de
);
8165 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8166 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8167 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
8168 if (fwriteBulkObject(fp
,eleobj
) == 0) goto werr
;
8170 dictReleaseIterator(di
);
8171 } else if (o
->type
== REDIS_HASH
) {
8172 char cmd
[]="*4\r\n$4\r\nHSET\r\n";
8174 /* Emit the HSETs needed to rebuild the hash */
8175 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
8176 unsigned char *p
= zipmapRewind(o
->ptr
);
8177 unsigned char *field
, *val
;
8178 unsigned int flen
, vlen
;
8180 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
8181 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8182 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8183 if (fwriteBulkString(fp
,(char*)field
,flen
) == -1)
8185 if (fwriteBulkString(fp
,(char*)val
,vlen
) == -1)
8189 dictIterator
*di
= dictGetIterator(o
->ptr
);
8192 while((de
= dictNext(di
)) != NULL
) {
8193 robj
*field
= dictGetEntryKey(de
);
8194 robj
*val
= dictGetEntryVal(de
);
8196 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8197 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8198 if (fwriteBulkObject(fp
,field
) == -1) return -1;
8199 if (fwriteBulkObject(fp
,val
) == -1) return -1;
8201 dictReleaseIterator(di
);
8206 /* Save the expire time */
8207 if (expiretime
!= -1) {
8208 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
8209 /* If this key is already expired skip it */
8210 if (expiretime
< now
) continue;
8211 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
8212 if (fwriteBulkObject(fp
,key
) == 0) goto werr
;
8213 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
8215 if (swapped
) decrRefCount(o
);
8217 dictReleaseIterator(di
);
8220 /* Make sure data will not remain on the OS's output buffers */
8225 /* Use RENAME to make sure the DB file is changed atomically only
8226 * if the generate DB file is ok. */
8227 if (rename(tmpfile
,filename
) == -1) {
8228 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
8232 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
8238 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
8239 if (di
) dictReleaseIterator(di
);
8243 /* This is how rewriting of the append only file in background works:
8245 * 1) The user calls BGREWRITEAOF
8246 * 2) Redis calls this function, that forks():
8247 * 2a) the child rewrite the append only file in a temp file.
8248 * 2b) the parent accumulates differences in server.bgrewritebuf.
8249 * 3) When the child finished '2a' exists.
8250 * 4) The parent will trap the exit code, if it's OK, will append the
8251 * data accumulated into server.bgrewritebuf into the temp file, and
8252 * finally will rename(2) the temp file in the actual file name.
8253 * The the new file is reopened as the new append only file. Profit!
8255 static int rewriteAppendOnlyFileBackground(void) {
8258 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
8259 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
8260 if ((childpid
= fork()) == 0) {
8264 if (server
.vm_enabled
) vmReopenSwapFile();
8266 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
8267 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
8274 if (childpid
== -1) {
8275 redisLog(REDIS_WARNING
,
8276 "Can't rewrite append only file in background: fork: %s",
8280 redisLog(REDIS_NOTICE
,
8281 "Background append only file rewriting started by pid %d",childpid
);
8282 server
.bgrewritechildpid
= childpid
;
8283 updateDictResizePolicy();
8284 /* We set appendseldb to -1 in order to force the next call to the
8285 * feedAppendOnlyFile() to issue a SELECT command, so the differences
8286 * accumulated by the parent into server.bgrewritebuf will start
8287 * with a SELECT statement and it will be safe to merge. */
8288 server
.appendseldb
= -1;
8291 return REDIS_OK
; /* unreached */
8294 static void bgrewriteaofCommand(redisClient
*c
) {
8295 if (server
.bgrewritechildpid
!= -1) {
8296 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
8299 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
8300 char *status
= "+Background append only file rewriting started\r\n";
8301 addReplySds(c
,sdsnew(status
));
8303 addReply(c
,shared
.err
);
8307 static void aofRemoveTempFile(pid_t childpid
) {
8310 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
8314 /* Virtual Memory is composed mainly of two subsystems:
8315 * - Blocking Virutal Memory
8316 * - Threaded Virtual Memory I/O
8317 * The two parts are not fully decoupled, but functions are split among two
8318 * different sections of the source code (delimited by comments) in order to
8319 * make more clear what functionality is about the blocking VM and what about
8320 * the threaded (not blocking) VM.
8324 * Redis VM is a blocking VM (one that blocks reading swapped values from
8325 * disk into memory when a value swapped out is needed in memory) that is made
8326 * unblocking by trying to examine the command argument vector in order to
8327 * load in background values that will likely be needed in order to exec
8328 * the command. The command is executed only once all the relevant keys
8329 * are loaded into memory.
8331 * This basically is almost as simple of a blocking VM, but almost as parallel
8332 * as a fully non-blocking VM.
8335 /* =================== Virtual Memory - Blocking Side ====================== */
8337 /* substitute the first occurrence of '%p' with the process pid in the
8338 * swap file name. */
8339 static void expandVmSwapFilename(void) {
8340 char *p
= strstr(server
.vm_swap_file
,"%p");
8346 new = sdscat(new,server
.vm_swap_file
);
8347 new = sdscatprintf(new,"%ld",(long) getpid());
8348 new = sdscat(new,p
+2);
8349 zfree(server
.vm_swap_file
);
8350 server
.vm_swap_file
= new;
8353 static void vmInit(void) {
8358 if (server
.vm_max_threads
!= 0)
8359 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
8361 expandVmSwapFilename();
8362 redisLog(REDIS_NOTICE
,"Using '%s' as swap file",server
.vm_swap_file
);
8363 if ((server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b")) == NULL
) {
8364 server
.vm_fp
= fopen(server
.vm_swap_file
,"w+b");
8366 if (server
.vm_fp
== NULL
) {
8367 redisLog(REDIS_WARNING
,
8368 "Impossible to open the swap file: %s. Exiting.",
8372 server
.vm_fd
= fileno(server
.vm_fp
);
8373 server
.vm_next_page
= 0;
8374 server
.vm_near_pages
= 0;
8375 server
.vm_stats_used_pages
= 0;
8376 server
.vm_stats_swapped_objects
= 0;
8377 server
.vm_stats_swapouts
= 0;
8378 server
.vm_stats_swapins
= 0;
8379 totsize
= server
.vm_pages
*server
.vm_page_size
;
8380 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
8381 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
8382 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
8386 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
8388 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
8389 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
8390 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
8391 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
8393 /* Initialize threaded I/O (used by Virtual Memory) */
8394 server
.io_newjobs
= listCreate();
8395 server
.io_processing
= listCreate();
8396 server
.io_processed
= listCreate();
8397 server
.io_ready_clients
= listCreate();
8398 pthread_mutex_init(&server
.io_mutex
,NULL
);
8399 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
8400 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
8401 server
.io_active_threads
= 0;
8402 if (pipe(pipefds
) == -1) {
8403 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
8407 server
.io_ready_pipe_read
= pipefds
[0];
8408 server
.io_ready_pipe_write
= pipefds
[1];
8409 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
8410 /* LZF requires a lot of stack */
8411 pthread_attr_init(&server
.io_threads_attr
);
8412 pthread_attr_getstacksize(&server
.io_threads_attr
, &stacksize
);
8413 while (stacksize
< REDIS_THREAD_STACK_SIZE
) stacksize
*= 2;
8414 pthread_attr_setstacksize(&server
.io_threads_attr
, stacksize
);
8415 /* Listen for events in the threaded I/O pipe */
8416 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
8417 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
8418 oom("creating file event");
8421 /* Mark the page as used */
8422 static void vmMarkPageUsed(off_t page
) {
8423 off_t byte
= page
/8;
8425 redisAssert(vmFreePage(page
) == 1);
8426 server
.vm_bitmap
[byte
] |= 1<<bit
;
8429 /* Mark N contiguous pages as used, with 'page' being the first. */
8430 static void vmMarkPagesUsed(off_t page
, off_t count
) {
8433 for (j
= 0; j
< count
; j
++)
8434 vmMarkPageUsed(page
+j
);
8435 server
.vm_stats_used_pages
+= count
;
8436 redisLog(REDIS_DEBUG
,"Mark USED pages: %lld pages at %lld\n",
8437 (long long)count
, (long long)page
);
8440 /* Mark the page as free */
8441 static void vmMarkPageFree(off_t page
) {
8442 off_t byte
= page
/8;
8444 redisAssert(vmFreePage(page
) == 0);
8445 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
8448 /* Mark N contiguous pages as free, with 'page' being the first. */
8449 static void vmMarkPagesFree(off_t page
, off_t count
) {
8452 for (j
= 0; j
< count
; j
++)
8453 vmMarkPageFree(page
+j
);
8454 server
.vm_stats_used_pages
-= count
;
8455 redisLog(REDIS_DEBUG
,"Mark FREE pages: %lld pages at %lld\n",
8456 (long long)count
, (long long)page
);
8459 /* Test if the page is free */
8460 static int vmFreePage(off_t page
) {
8461 off_t byte
= page
/8;
8463 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
8466 /* Find N contiguous free pages storing the first page of the cluster in *first.
8467 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
8468 * REDIS_ERR is returned.
8470 * This function uses a simple algorithm: we try to allocate
8471 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
8472 * again from the start of the swap file searching for free spaces.
8474 * If it looks pretty clear that there are no free pages near our offset
8475 * we try to find less populated places doing a forward jump of
8476 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
8477 * without hurry, and then we jump again and so forth...
8479 * This function can be improved using a free list to avoid to guess
8480 * too much, since we could collect data about freed pages.
8482 * note: I implemented this function just after watching an episode of
8483 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
8485 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
8486 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
8488 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
8489 server
.vm_near_pages
= 0;
8490 server
.vm_next_page
= 0;
8492 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
8493 base
= server
.vm_next_page
;
8495 while(offset
< server
.vm_pages
) {
8496 off_t
this = base
+offset
;
8498 /* If we overflow, restart from page zero */
8499 if (this >= server
.vm_pages
) {
8500 this -= server
.vm_pages
;
8502 /* Just overflowed, what we found on tail is no longer
8503 * interesting, as it's no longer contiguous. */
8507 if (vmFreePage(this)) {
8508 /* This is a free page */
8510 /* Already got N free pages? Return to the caller, with success */
8512 *first
= this-(n
-1);
8513 server
.vm_next_page
= this+1;
8514 redisLog(REDIS_DEBUG
, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n
, (long long) *first
);
8518 /* The current one is not a free page */
8522 /* Fast-forward if the current page is not free and we already
8523 * searched enough near this place. */
8525 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
8526 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
8528 /* Note that even if we rewind after the jump, we are don't need
8529 * to make sure numfree is set to zero as we only jump *if* it
8530 * is set to zero. */
8532 /* Otherwise just check the next page */
8539 /* Write the specified object at the specified page of the swap file */
8540 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
8541 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8542 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8543 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8544 redisLog(REDIS_WARNING
,
8545 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
8549 rdbSaveObject(server
.vm_fp
,o
);
8550 fflush(server
.vm_fp
);
8551 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8555 /* Swap the 'val' object relative to 'key' into disk. Store all the information
8556 * needed to later retrieve the object into the key object.
8557 * If we can't find enough contiguous empty pages to swap the object on disk
8558 * REDIS_ERR is returned. */
8559 static int vmSwapObjectBlocking(robj
*key
, robj
*val
) {
8560 off_t pages
= rdbSavedObjectPages(val
,NULL
);
8563 assert(key
->storage
== REDIS_VM_MEMORY
);
8564 assert(key
->refcount
== 1);
8565 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
8566 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return REDIS_ERR
;
8567 key
->vm
.page
= page
;
8568 key
->vm
.usedpages
= pages
;
8569 key
->storage
= REDIS_VM_SWAPPED
;
8570 key
->vtype
= val
->type
;
8571 decrRefCount(val
); /* Deallocate the object from memory. */
8572 vmMarkPagesUsed(page
,pages
);
8573 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
8574 (unsigned char*) key
->ptr
,
8575 (unsigned long long) page
, (unsigned long long) pages
);
8576 server
.vm_stats_swapped_objects
++;
8577 server
.vm_stats_swapouts
++;
8581 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
8584 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
8585 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
8586 redisLog(REDIS_WARNING
,
8587 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
8591 o
= rdbLoadObject(type
,server
.vm_fp
);
8593 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno
));
8596 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
8600 /* Load the value object relative to the 'key' object from swap to memory.
8601 * The newly allocated object is returned.
8603 * If preview is true the unserialized object is returned to the caller but
8604 * no changes are made to the key object, nor the pages are marked as freed */
8605 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
8608 redisAssert(key
->storage
== REDIS_VM_SWAPPED
|| key
->storage
== REDIS_VM_LOADING
);
8609 val
= vmReadObjectFromSwap(key
->vm
.page
,key
->vtype
);
8611 key
->storage
= REDIS_VM_MEMORY
;
8612 key
->vm
.atime
= server
.unixtime
;
8613 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8614 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
8615 (unsigned char*) key
->ptr
);
8616 server
.vm_stats_swapped_objects
--;
8618 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
8619 (unsigned char*) key
->ptr
);
8621 server
.vm_stats_swapins
++;
8625 /* Plain object loading, from swap to memory */
8626 static robj
*vmLoadObject(robj
*key
) {
8627 /* If we are loading the object in background, stop it, we
8628 * need to load this object synchronously ASAP. */
8629 if (key
->storage
== REDIS_VM_LOADING
)
8630 vmCancelThreadedIOJob(key
);
8631 return vmGenericLoadObject(key
,0);
8634 /* Just load the value on disk, without to modify the key.
8635 * This is useful when we want to perform some operation on the value
8636 * without to really bring it from swap to memory, like while saving the
8637 * dataset or rewriting the append only log. */
8638 static robj
*vmPreviewObject(robj
*key
) {
8639 return vmGenericLoadObject(key
,1);
8642 /* How a good candidate is this object for swapping?
8643 * The better candidate it is, the greater the returned value.
8645 * Currently we try to perform a fast estimation of the object size in
8646 * memory, and combine it with aging informations.
8648 * Basically swappability = idle-time * log(estimated size)
8650 * Bigger objects are preferred over smaller objects, but not
8651 * proportionally, this is why we use the logarithm. This algorithm is
8652 * just a first try and will probably be tuned later. */
8653 static double computeObjectSwappability(robj
*o
) {
8654 time_t age
= server
.unixtime
- o
->vm
.atime
;
8658 struct dictEntry
*de
;
8661 if (age
<= 0) return 0;
8664 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
8667 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
8672 listNode
*ln
= listFirst(l
);
8674 asize
= sizeof(list
);
8676 robj
*ele
= ln
->value
;
8679 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8680 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8682 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
8687 z
= (o
->type
== REDIS_ZSET
);
8688 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
8690 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
8691 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
8696 de
= dictGetRandomKey(d
);
8697 ele
= dictGetEntryKey(de
);
8698 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8699 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8701 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
8702 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
8706 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
8707 unsigned char *p
= zipmapRewind((unsigned char*)o
->ptr
);
8708 unsigned int len
= zipmapLen((unsigned char*)o
->ptr
);
8709 unsigned int klen
, vlen
;
8710 unsigned char *key
, *val
;
8712 if ((p
= zipmapNext(p
,&key
,&klen
,&val
,&vlen
)) == NULL
) {
8716 asize
= len
*(klen
+vlen
+3);
8717 } else if (o
->encoding
== REDIS_ENCODING_HT
) {
8719 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
8724 de
= dictGetRandomKey(d
);
8725 ele
= dictGetEntryKey(de
);
8726 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8727 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8729 ele
= dictGetEntryVal(de
);
8730 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
8731 (sizeof(*o
)+sdslen(ele
->ptr
)) :
8733 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
8738 return (double)age
*log(1+asize
);
8741 /* Try to swap an object that's a good candidate for swapping.
8742 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
8743 * to swap any object at all.
8745 * If 'usethreaded' is true, Redis will try to swap the object in background
8746 * using I/O threads. */
8747 static int vmSwapOneObject(int usethreads
) {
8749 struct dictEntry
*best
= NULL
;
8750 double best_swappability
= 0;
8751 redisDb
*best_db
= NULL
;
8754 for (j
= 0; j
< server
.dbnum
; j
++) {
8755 redisDb
*db
= server
.db
+j
;
8756 /* Why maxtries is set to 100?
8757 * Because this way (usually) we'll find 1 object even if just 1% - 2%
8758 * are swappable objects */
8761 if (dictSize(db
->dict
) == 0) continue;
8762 for (i
= 0; i
< 5; i
++) {
8764 double swappability
;
8766 if (maxtries
) maxtries
--;
8767 de
= dictGetRandomKey(db
->dict
);
8768 key
= dictGetEntryKey(de
);
8769 val
= dictGetEntryVal(de
);
8770 /* Only swap objects that are currently in memory.
8772 * Also don't swap shared objects if threaded VM is on, as we
8773 * try to ensure that the main thread does not touch the
8774 * object while the I/O thread is using it, but we can't
8775 * control other keys without adding additional mutex. */
8776 if (key
->storage
!= REDIS_VM_MEMORY
||
8777 (server
.vm_max_threads
!= 0 && val
->refcount
!= 1)) {
8778 if (maxtries
) i
--; /* don't count this try */
8781 swappability
= computeObjectSwappability(val
);
8782 if (!best
|| swappability
> best_swappability
) {
8784 best_swappability
= swappability
;
8789 if (best
== NULL
) return REDIS_ERR
;
8790 key
= dictGetEntryKey(best
);
8791 val
= dictGetEntryVal(best
);
8793 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
8794 key
->ptr
, best_swappability
);
8796 /* Unshare the key if needed */
8797 if (key
->refcount
> 1) {
8798 robj
*newkey
= dupStringObject(key
);
8800 key
= dictGetEntryKey(best
) = newkey
;
8804 vmSwapObjectThreaded(key
,val
,best_db
);
8807 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
8808 dictGetEntryVal(best
) = NULL
;
8816 static int vmSwapOneObjectBlocking() {
8817 return vmSwapOneObject(0);
8820 static int vmSwapOneObjectThreaded() {
8821 return vmSwapOneObject(1);
8824 /* Return true if it's safe to swap out objects in a given moment.
8825 * Basically we don't want to swap objects out while there is a BGSAVE
8826 * or a BGAEOREWRITE running in backgroud. */
8827 static int vmCanSwapOut(void) {
8828 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
8831 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
8832 * and was deleted. Otherwise 0 is returned. */
8833 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
8837 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
8838 foundkey
= dictGetEntryKey(de
);
8839 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
8844 /* =================== Virtual Memory - Threaded I/O ======================= */
8846 static void freeIOJob(iojob
*j
) {
8847 if ((j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
8848 j
->type
== REDIS_IOJOB_DO_SWAP
||
8849 j
->type
== REDIS_IOJOB_LOAD
) && j
->val
!= NULL
)
8850 decrRefCount(j
->val
);
8851 /* We don't decrRefCount the j->key field as we did't incremented
8852 * the count creating IO Jobs. This is because the key field here is
8853 * just used as an indentifier and if a key is removed the Job should
8854 * never be touched again. */
8858 /* Every time a thread finished a Job, it writes a byte into the write side
8859 * of an unix pipe in order to "awake" the main thread, and this function
8861 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
8865 int retval
, processed
= 0, toprocess
= -1, trytoswap
= 1;
8867 REDIS_NOTUSED(mask
);
8868 REDIS_NOTUSED(privdata
);
8870 /* For every byte we read in the read side of the pipe, there is one
8871 * I/O job completed to process. */
8872 while((retval
= read(fd
,buf
,1)) == 1) {
8876 struct dictEntry
*de
;
8878 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
8880 /* Get the processed element (the oldest one) */
8882 assert(listLength(server
.io_processed
) != 0);
8883 if (toprocess
== -1) {
8884 toprocess
= (listLength(server
.io_processed
)*REDIS_MAX_COMPLETED_JOBS_PROCESSED
)/100;
8885 if (toprocess
<= 0) toprocess
= 1;
8887 ln
= listFirst(server
.io_processed
);
8889 listDelNode(server
.io_processed
,ln
);
8891 /* If this job is marked as canceled, just ignore it */
8896 /* Post process it in the main thread, as there are things we
8897 * can do just here to avoid race conditions and/or invasive locks */
8898 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
);
8899 de
= dictFind(j
->db
->dict
,j
->key
);
8901 key
= dictGetEntryKey(de
);
8902 if (j
->type
== REDIS_IOJOB_LOAD
) {
8905 /* Key loaded, bring it at home */
8906 key
->storage
= REDIS_VM_MEMORY
;
8907 key
->vm
.atime
= server
.unixtime
;
8908 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
8909 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
8910 (unsigned char*) key
->ptr
);
8911 server
.vm_stats_swapped_objects
--;
8912 server
.vm_stats_swapins
++;
8913 dictGetEntryVal(de
) = j
->val
;
8914 incrRefCount(j
->val
);
8917 /* Handle clients waiting for this key to be loaded. */
8918 handleClientsBlockedOnSwappedKey(db
,key
);
8919 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
8920 /* Now we know the amount of pages required to swap this object.
8921 * Let's find some space for it, and queue this task again
8922 * rebranded as REDIS_IOJOB_DO_SWAP. */
8923 if (!vmCanSwapOut() ||
8924 vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
)
8926 /* Ooops... no space or we can't swap as there is
8927 * a fork()ed Redis trying to save stuff on disk. */
8929 key
->storage
= REDIS_VM_MEMORY
; /* undo operation */
8931 /* Note that we need to mark this pages as used now,
8932 * if the job will be canceled, we'll mark them as freed
8934 vmMarkPagesUsed(j
->page
,j
->pages
);
8935 j
->type
= REDIS_IOJOB_DO_SWAP
;
8940 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
8943 /* Key swapped. We can finally free some memory. */
8944 if (key
->storage
!= REDIS_VM_SWAPPING
) {
8945 printf("key->storage: %d\n",key
->storage
);
8946 printf("key->name: %s\n",(char*)key
->ptr
);
8947 printf("key->refcount: %d\n",key
->refcount
);
8948 printf("val: %p\n",(void*)j
->val
);
8949 printf("val->type: %d\n",j
->val
->type
);
8950 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
8952 redisAssert(key
->storage
== REDIS_VM_SWAPPING
);
8953 val
= dictGetEntryVal(de
);
8954 key
->vm
.page
= j
->page
;
8955 key
->vm
.usedpages
= j
->pages
;
8956 key
->storage
= REDIS_VM_SWAPPED
;
8957 key
->vtype
= j
->val
->type
;
8958 decrRefCount(val
); /* Deallocate the object from memory. */
8959 dictGetEntryVal(de
) = NULL
;
8960 redisLog(REDIS_DEBUG
,
8961 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
8962 (unsigned char*) key
->ptr
,
8963 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
8964 server
.vm_stats_swapped_objects
++;
8965 server
.vm_stats_swapouts
++;
8967 /* Put a few more swap requests in queue if we are still
8969 if (trytoswap
&& vmCanSwapOut() &&
8970 zmalloc_used_memory() > server
.vm_max_memory
)
8975 more
= listLength(server
.io_newjobs
) <
8976 (unsigned) server
.vm_max_threads
;
8978 /* Don't waste CPU time if swappable objects are rare. */
8979 if (vmSwapOneObjectThreaded() == REDIS_ERR
) {
8987 if (processed
== toprocess
) return;
8989 if (retval
< 0 && errno
!= EAGAIN
) {
8990 redisLog(REDIS_WARNING
,
8991 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
8996 static void lockThreadedIO(void) {
8997 pthread_mutex_lock(&server
.io_mutex
);
9000 static void unlockThreadedIO(void) {
9001 pthread_mutex_unlock(&server
.io_mutex
);
9004 /* Remove the specified object from the threaded I/O queue if still not
9005 * processed, otherwise make sure to flag it as canceled. */
9006 static void vmCancelThreadedIOJob(robj
*o
) {
9008 server
.io_newjobs
, /* 0 */
9009 server
.io_processing
, /* 1 */
9010 server
.io_processed
/* 2 */
9014 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
9017 /* Search for a matching key in one of the queues */
9018 for (i
= 0; i
< 3; i
++) {
9022 listRewind(lists
[i
],&li
);
9023 while ((ln
= listNext(&li
)) != NULL
) {
9024 iojob
*job
= ln
->value
;
9026 if (job
->canceled
) continue; /* Skip this, already canceled. */
9027 if (job
->key
== o
) {
9028 redisLog(REDIS_DEBUG
,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
9029 (void*)job
, (char*)o
->ptr
, job
->type
, i
);
9030 /* Mark the pages as free since the swap didn't happened
9031 * or happened but is now discarded. */
9032 if (i
!= 1 && job
->type
== REDIS_IOJOB_DO_SWAP
)
9033 vmMarkPagesFree(job
->page
,job
->pages
);
9034 /* Cancel the job. It depends on the list the job is
9037 case 0: /* io_newjobs */
9038 /* If the job was yet not processed the best thing to do
9039 * is to remove it from the queue at all */
9041 listDelNode(lists
[i
],ln
);
9043 case 1: /* io_processing */
9044 /* Oh Shi- the thread is messing with the Job:
9046 * Probably it's accessing the object if this is a
9047 * PREPARE_SWAP or DO_SWAP job.
9048 * If it's a LOAD job it may be reading from disk and
9049 * if we don't wait for the job to terminate before to
9050 * cancel it, maybe in a few microseconds data can be
9051 * corrupted in this pages. So the short story is:
9053 * Better to wait for the job to move into the
9054 * next queue (processed)... */
9056 /* We try again and again until the job is completed. */
9058 /* But let's wait some time for the I/O thread
9059 * to finish with this job. After all this condition
9060 * should be very rare. */
9063 case 2: /* io_processed */
9064 /* The job was already processed, that's easy...
9065 * just mark it as canceled so that we'll ignore it
9066 * when processing completed jobs. */
9070 /* Finally we have to adjust the storage type of the object
9071 * in order to "UNDO" the operaiton. */
9072 if (o
->storage
== REDIS_VM_LOADING
)
9073 o
->storage
= REDIS_VM_SWAPPED
;
9074 else if (o
->storage
== REDIS_VM_SWAPPING
)
9075 o
->storage
= REDIS_VM_MEMORY
;
9082 assert(1 != 1); /* We should never reach this */
9085 static void *IOThreadEntryPoint(void *arg
) {
9090 pthread_detach(pthread_self());
9092 /* Get a new job to process */
9094 if (listLength(server
.io_newjobs
) == 0) {
9095 /* No new jobs in queue, exit. */
9096 redisLog(REDIS_DEBUG
,"Thread %ld exiting, nothing to do",
9097 (long) pthread_self());
9098 server
.io_active_threads
--;
9102 ln
= listFirst(server
.io_newjobs
);
9104 listDelNode(server
.io_newjobs
,ln
);
9105 /* Add the job in the processing queue */
9106 j
->thread
= pthread_self();
9107 listAddNodeTail(server
.io_processing
,j
);
9108 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
9110 redisLog(REDIS_DEBUG
,"Thread %ld got a new job (type %d): %p about key '%s'",
9111 (long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
9113 /* Process the Job */
9114 if (j
->type
== REDIS_IOJOB_LOAD
) {
9115 j
->val
= vmReadObjectFromSwap(j
->page
,j
->key
->vtype
);
9116 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
9117 FILE *fp
= fopen("/dev/null","w+");
9118 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
9120 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
9121 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
9125 /* Done: insert the job into the processed queue */
9126 redisLog(REDIS_DEBUG
,"Thread %ld completed the job: %p (key %s)",
9127 (long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
9129 listDelNode(server
.io_processing
,ln
);
9130 listAddNodeTail(server
.io_processed
,j
);
9133 /* Signal the main thread there is new stuff to process */
9134 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
9136 return NULL
; /* never reached */
9139 static void spawnIOThread(void) {
9141 sigset_t mask
, omask
;
9145 sigaddset(&mask
,SIGCHLD
);
9146 sigaddset(&mask
,SIGHUP
);
9147 sigaddset(&mask
,SIGPIPE
);
9148 pthread_sigmask(SIG_SETMASK
, &mask
, &omask
);
9149 while ((err
= pthread_create(&thread
,&server
.io_threads_attr
,IOThreadEntryPoint
,NULL
)) != 0) {
9150 redisLog(REDIS_WARNING
,"Unable to spawn an I/O thread: %s",
9154 pthread_sigmask(SIG_SETMASK
, &omask
, NULL
);
9155 server
.io_active_threads
++;
9158 /* We need to wait for the last thread to exit before we are able to
9159 * fork() in order to BGSAVE or BGREWRITEAOF. */
9160 static void waitEmptyIOJobsQueue(void) {
9162 int io_processed_len
;
9165 if (listLength(server
.io_newjobs
) == 0 &&
9166 listLength(server
.io_processing
) == 0 &&
9167 server
.io_active_threads
== 0)
9172 /* While waiting for empty jobs queue condition we post-process some
9173 * finshed job, as I/O threads may be hanging trying to write against
9174 * the io_ready_pipe_write FD but there are so much pending jobs that
9176 io_processed_len
= listLength(server
.io_processed
);
9178 if (io_processed_len
) {
9179 vmThreadedIOCompletedJob(NULL
,server
.io_ready_pipe_read
,NULL
,0);
9180 usleep(1000); /* 1 millisecond */
9182 usleep(10000); /* 10 milliseconds */
9187 static void vmReopenSwapFile(void) {
9188 /* Note: we don't close the old one as we are in the child process
9189 * and don't want to mess at all with the original file object. */
9190 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
9191 if (server
.vm_fp
== NULL
) {
9192 redisLog(REDIS_WARNING
,"Can't re-open the VM swap file: %s. Exiting.",
9193 server
.vm_swap_file
);
9196 server
.vm_fd
= fileno(server
.vm_fp
);
9199 /* This function must be called while with threaded IO locked */
9200 static void queueIOJob(iojob
*j
) {
9201 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
9202 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
9203 listAddNodeTail(server
.io_newjobs
,j
);
9204 if (server
.io_active_threads
< server
.vm_max_threads
)
9208 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
9211 assert(key
->storage
== REDIS_VM_MEMORY
);
9212 assert(key
->refcount
== 1);
9214 j
= zmalloc(sizeof(*j
));
9215 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
9221 j
->thread
= (pthread_t
) -1;
9222 key
->storage
= REDIS_VM_SWAPPING
;
9230 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
9232 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
9233 * If there is not already a job loading the key, it is craeted.
9234 * The key is added to the io_keys list in the client structure, and also
9235 * in the hash table mapping swapped keys to waiting clients, that is,
9236 * server.io_waited_keys. */
9237 static int waitForSwappedKey(redisClient
*c
, robj
*key
) {
9238 struct dictEntry
*de
;
9242 /* If the key does not exist or is already in RAM we don't need to
9243 * block the client at all. */
9244 de
= dictFind(c
->db
->dict
,key
);
9245 if (de
== NULL
) return 0;
9246 o
= dictGetEntryKey(de
);
9247 if (o
->storage
== REDIS_VM_MEMORY
) {
9249 } else if (o
->storage
== REDIS_VM_SWAPPING
) {
9250 /* We were swapping the key, undo it! */
9251 vmCancelThreadedIOJob(o
);
9255 /* OK: the key is either swapped, or being loaded just now. */
9257 /* Add the key to the list of keys this client is waiting for.
9258 * This maps clients to keys they are waiting for. */
9259 listAddNodeTail(c
->io_keys
,key
);
9262 /* Add the client to the swapped keys => clients waiting map. */
9263 de
= dictFind(c
->db
->io_keys
,key
);
9267 /* For every key we take a list of clients blocked for it */
9269 retval
= dictAdd(c
->db
->io_keys
,key
,l
);
9271 assert(retval
== DICT_OK
);
9273 l
= dictGetEntryVal(de
);
9275 listAddNodeTail(l
,c
);
9277 /* Are we already loading the key from disk? If not create a job */
9278 if (o
->storage
== REDIS_VM_SWAPPED
) {
9281 o
->storage
= REDIS_VM_LOADING
;
9282 j
= zmalloc(sizeof(*j
));
9283 j
->type
= REDIS_IOJOB_LOAD
;
9286 j
->key
->vtype
= o
->vtype
;
9287 j
->page
= o
->vm
.page
;
9290 j
->thread
= (pthread_t
) -1;
9298 /* Preload keys needed for the ZUNION and ZINTER commands. */
9299 static void zunionInterBlockClientOnSwappedKeys(redisClient
*c
) {
9301 num
= atoi(c
->argv
[2]->ptr
);
9302 for (i
= 0; i
< num
; i
++) {
9303 waitForSwappedKey(c
,c
->argv
[3+i
]);
9307 /* Is this client attempting to run a command against swapped keys?
9308 * If so, block it ASAP, load the keys in background, then resume it.
9310 * The important idea about this function is that it can fail! If keys will
9311 * still be swapped when the client is resumed, this key lookups will
9312 * just block loading keys from disk. In practical terms this should only
9313 * happen with SORT BY command or if there is a bug in this function.
9315 * Return 1 if the client is marked as blocked, 0 if the client can
9316 * continue as the keys it is going to access appear to be in memory. */
9317 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
) {
9320 if (cmd
->vm_preload_proc
!= NULL
) {
9321 cmd
->vm_preload_proc(c
);
9323 if (cmd
->vm_firstkey
== 0) return 0;
9324 last
= cmd
->vm_lastkey
;
9325 if (last
< 0) last
= c
->argc
+last
;
9326 for (j
= cmd
->vm_firstkey
; j
<= last
; j
+= cmd
->vm_keystep
)
9327 waitForSwappedKey(c
,c
->argv
[j
]);
9330 /* If the client was blocked for at least one key, mark it as blocked. */
9331 if (listLength(c
->io_keys
)) {
9332 c
->flags
|= REDIS_IO_WAIT
;
9333 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
9334 server
.vm_blocked_clients
++;
9341 /* Remove the 'key' from the list of blocked keys for a given client.
9343 * The function returns 1 when there are no longer blocking keys after
9344 * the current one was removed (and the client can be unblocked). */
9345 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
) {
9349 struct dictEntry
*de
;
9351 /* Remove the key from the list of keys this client is waiting for. */
9352 listRewind(c
->io_keys
,&li
);
9353 while ((ln
= listNext(&li
)) != NULL
) {
9354 if (compareStringObjects(ln
->value
,key
) == 0) {
9355 listDelNode(c
->io_keys
,ln
);
9361 /* Remove the client form the key => waiting clients map. */
9362 de
= dictFind(c
->db
->io_keys
,key
);
9364 l
= dictGetEntryVal(de
);
9365 ln
= listSearchKey(l
,c
);
9368 if (listLength(l
) == 0)
9369 dictDelete(c
->db
->io_keys
,key
);
9371 return listLength(c
->io_keys
) == 0;
9374 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
) {
9375 struct dictEntry
*de
;
9380 de
= dictFind(db
->io_keys
,key
);
9383 l
= dictGetEntryVal(de
);
9384 len
= listLength(l
);
9385 /* Note: we can't use something like while(listLength(l)) as the list
9386 * can be freed by the calling function when we remove the last element. */
9389 redisClient
*c
= ln
->value
;
9391 if (dontWaitForSwappedKey(c
,key
)) {
9392 /* Put the client in the list of clients ready to go as we
9393 * loaded all the keys about it. */
9394 listAddNodeTail(server
.io_ready_clients
,c
);
9399 /* =========================== Remote Configuration ========================= */
9401 static void configSetCommand(redisClient
*c
) {
9402 robj
*o
= getDecodedObject(c
->argv
[3]);
9403 if (!strcasecmp(c
->argv
[2]->ptr
,"dbfilename")) {
9404 zfree(server
.dbfilename
);
9405 server
.dbfilename
= zstrdup(o
->ptr
);
9406 } else if (!strcasecmp(c
->argv
[2]->ptr
,"requirepass")) {
9407 zfree(server
.requirepass
);
9408 server
.requirepass
= zstrdup(o
->ptr
);
9409 } else if (!strcasecmp(c
->argv
[2]->ptr
,"masterauth")) {
9410 zfree(server
.masterauth
);
9411 server
.masterauth
= zstrdup(o
->ptr
);
9412 } else if (!strcasecmp(c
->argv
[2]->ptr
,"maxmemory")) {
9413 server
.maxmemory
= strtoll(o
->ptr
, NULL
, 10);
9415 addReplySds(c
,sdscatprintf(sdsempty(),
9416 "-ERR not supported CONFIG parameter %s\r\n",
9417 (char*)c
->argv
[2]->ptr
));
9422 addReply(c
,shared
.ok
);
9425 static void configGetCommand(redisClient
*c
) {
9426 robj
*o
= getDecodedObject(c
->argv
[2]);
9427 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
9428 char *pattern
= o
->ptr
;
9432 decrRefCount(lenobj
);
9434 if (stringmatch(pattern
,"dbfilename",0)) {
9435 addReplyBulkCString(c
,"dbfilename");
9436 addReplyBulkCString(c
,server
.dbfilename
);
9439 if (stringmatch(pattern
,"requirepass",0)) {
9440 addReplyBulkCString(c
,"requirepass");
9441 addReplyBulkCString(c
,server
.requirepass
);
9444 if (stringmatch(pattern
,"masterauth",0)) {
9445 addReplyBulkCString(c
,"masterauth");
9446 addReplyBulkCString(c
,server
.masterauth
);
9449 if (stringmatch(pattern
,"maxmemory",0)) {
9452 snprintf(buf
,128,"%llu\n",server
.maxmemory
);
9453 addReplyBulkCString(c
,"maxmemory");
9454 addReplyBulkCString(c
,buf
);
9458 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%d\r\n",matches
*2);
9461 static void configCommand(redisClient
*c
) {
9462 if (!strcasecmp(c
->argv
[1]->ptr
,"set")) {
9463 if (c
->argc
!= 4) goto badarity
;
9464 configSetCommand(c
);
9465 } else if (!strcasecmp(c
->argv
[1]->ptr
,"get")) {
9466 if (c
->argc
!= 3) goto badarity
;
9467 configGetCommand(c
);
9468 } else if (!strcasecmp(c
->argv
[1]->ptr
,"resetstat")) {
9469 if (c
->argc
!= 2) goto badarity
;
9470 server
.stat_numcommands
= 0;
9471 server
.stat_numconnections
= 0;
9472 server
.stat_expiredkeys
= 0;
9473 server
.stat_starttime
= time(NULL
);
9474 addReply(c
,shared
.ok
);
9476 addReplySds(c
,sdscatprintf(sdsempty(),
9477 "-ERR CONFIG subcommand must be one of GET, SET, RESETSTAT\r\n"));
9482 addReplySds(c
,sdscatprintf(sdsempty(),
9483 "-ERR Wrong number of arguments for CONFIG %s\r\n",
9484 (char*) c
->argv
[1]->ptr
));
9487 /* =========================== Pubsub implementation ======================== */
9489 static void freePubsubPattern(void *p
) {
9490 pubsubPattern
*pat
= p
;
9492 decrRefCount(pat
->pattern
);
9496 static int listMatchPubsubPattern(void *a
, void *b
) {
9497 pubsubPattern
*pa
= a
, *pb
= b
;
9499 return (pa
->client
== pb
->client
) &&
9500 (compareStringObjects(pa
->pattern
,pb
->pattern
) == 0);
9503 /* Subscribe a client to a channel. Returns 1 if the operation succeeded, or
9504 * 0 if the client was already subscribed to that channel. */
9505 static int pubsubSubscribeChannel(redisClient
*c
, robj
*channel
) {
9506 struct dictEntry
*de
;
9507 list
*clients
= NULL
;
9510 /* Add the channel to the client -> channels hash table */
9511 if (dictAdd(c
->pubsub_channels
,channel
,NULL
) == DICT_OK
) {
9513 incrRefCount(channel
);
9514 /* Add the client to the channel -> list of clients hash table */
9515 de
= dictFind(server
.pubsub_channels
,channel
);
9517 clients
= listCreate();
9518 dictAdd(server
.pubsub_channels
,channel
,clients
);
9519 incrRefCount(channel
);
9521 clients
= dictGetEntryVal(de
);
9523 listAddNodeTail(clients
,c
);
9525 /* Notify the client */
9526 addReply(c
,shared
.mbulk3
);
9527 addReply(c
,shared
.subscribebulk
);
9528 addReplyBulk(c
,channel
);
9529 addReplyLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
9533 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9534 * 0 if the client was not subscribed to the specified channel. */
9535 static int pubsubUnsubscribeChannel(redisClient
*c
, robj
*channel
, int notify
) {
9536 struct dictEntry
*de
;
9541 /* Remove the channel from the client -> channels hash table */
9542 incrRefCount(channel
); /* channel may be just a pointer to the same object
9543 we have in the hash tables. Protect it... */
9544 if (dictDelete(c
->pubsub_channels
,channel
) == DICT_OK
) {
9546 /* Remove the client from the channel -> clients list hash table */
9547 de
= dictFind(server
.pubsub_channels
,channel
);
9549 clients
= dictGetEntryVal(de
);
9550 ln
= listSearchKey(clients
,c
);
9552 listDelNode(clients
,ln
);
9553 if (listLength(clients
) == 0) {
9554 /* Free the list and associated hash entry at all if this was
9555 * the latest client, so that it will be possible to abuse
9556 * Redis PUBSUB creating millions of channels. */
9557 dictDelete(server
.pubsub_channels
,channel
);
9560 /* Notify the client */
9562 addReply(c
,shared
.mbulk3
);
9563 addReply(c
,shared
.unsubscribebulk
);
9564 addReplyBulk(c
,channel
);
9565 addReplyLong(c
,dictSize(c
->pubsub_channels
)+
9566 listLength(c
->pubsub_patterns
));
9569 decrRefCount(channel
); /* it is finally safe to release it */
9573 /* Subscribe a client to a pattern. Returns 1 if the operation succeeded, or 0 if the clinet was already subscribed to that pattern. */
9574 static int pubsubSubscribePattern(redisClient
*c
, robj
*pattern
) {
9577 if (listSearchKey(c
->pubsub_patterns
,pattern
) == NULL
) {
9580 listAddNodeTail(c
->pubsub_patterns
,pattern
);
9581 incrRefCount(pattern
);
9582 pat
= zmalloc(sizeof(*pat
));
9583 pat
->pattern
= getDecodedObject(pattern
);
9585 listAddNodeTail(server
.pubsub_patterns
,pat
);
9587 /* Notify the client */
9588 addReply(c
,shared
.mbulk3
);
9589 addReply(c
,shared
.psubscribebulk
);
9590 addReplyBulk(c
,pattern
);
9591 addReplyLong(c
,dictSize(c
->pubsub_channels
)+listLength(c
->pubsub_patterns
));
9595 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9596 * 0 if the client was not subscribed to the specified channel. */
9597 static int pubsubUnsubscribePattern(redisClient
*c
, robj
*pattern
, int notify
) {
9602 incrRefCount(pattern
); /* Protect the object. May be the same we remove */
9603 if ((ln
= listSearchKey(c
->pubsub_patterns
,pattern
)) != NULL
) {
9605 listDelNode(c
->pubsub_patterns
,ln
);
9607 pat
.pattern
= pattern
;
9608 ln
= listSearchKey(server
.pubsub_patterns
,&pat
);
9609 listDelNode(server
.pubsub_patterns
,ln
);
9611 /* Notify the client */
9613 addReply(c
,shared
.mbulk3
);
9614 addReply(c
,shared
.punsubscribebulk
);
9615 addReplyBulk(c
,pattern
);
9616 addReplyLong(c
,dictSize(c
->pubsub_channels
)+
9617 listLength(c
->pubsub_patterns
));
9619 decrRefCount(pattern
);
9623 /* Unsubscribe from all the channels. Return the number of channels the
9624 * client was subscribed from. */
9625 static int pubsubUnsubscribeAllChannels(redisClient
*c
, int notify
) {
9626 dictIterator
*di
= dictGetIterator(c
->pubsub_channels
);
9630 while((de
= dictNext(di
)) != NULL
) {
9631 robj
*channel
= dictGetEntryKey(de
);
9633 count
+= pubsubUnsubscribeChannel(c
,channel
,notify
);
9635 dictReleaseIterator(di
);
9639 /* Unsubscribe from all the patterns. Return the number of patterns the
9640 * client was subscribed from. */
9641 static int pubsubUnsubscribeAllPatterns(redisClient
*c
, int notify
) {
9646 listRewind(c
->pubsub_patterns
,&li
);
9647 while ((ln
= listNext(&li
)) != NULL
) {
9648 robj
*pattern
= ln
->value
;
9650 count
+= pubsubUnsubscribePattern(c
,pattern
,notify
);
9655 /* Publish a message */
9656 static int pubsubPublishMessage(robj
*channel
, robj
*message
) {
9658 struct dictEntry
*de
;
9662 /* Send to clients listening for that channel */
9663 de
= dictFind(server
.pubsub_channels
,channel
);
9665 list
*list
= dictGetEntryVal(de
);
9669 listRewind(list
,&li
);
9670 while ((ln
= listNext(&li
)) != NULL
) {
9671 redisClient
*c
= ln
->value
;
9673 addReply(c
,shared
.mbulk3
);
9674 addReply(c
,shared
.messagebulk
);
9675 addReplyBulk(c
,channel
);
9676 addReplyBulk(c
,message
);
9680 /* Send to clients listening to matching channels */
9681 if (listLength(server
.pubsub_patterns
)) {
9682 listRewind(server
.pubsub_patterns
,&li
);
9683 channel
= getDecodedObject(channel
);
9684 while ((ln
= listNext(&li
)) != NULL
) {
9685 pubsubPattern
*pat
= ln
->value
;
9687 if (stringmatchlen((char*)pat
->pattern
->ptr
,
9688 sdslen(pat
->pattern
->ptr
),
9689 (char*)channel
->ptr
,
9690 sdslen(channel
->ptr
),0)) {
9691 addReply(pat
->client
,shared
.mbulk3
);
9692 addReply(pat
->client
,shared
.messagebulk
);
9693 addReplyBulk(pat
->client
,channel
);
9694 addReplyBulk(pat
->client
,message
);
9698 decrRefCount(channel
);
9703 static void subscribeCommand(redisClient
*c
) {
9706 for (j
= 1; j
< c
->argc
; j
++)
9707 pubsubSubscribeChannel(c
,c
->argv
[j
]);
9710 static void unsubscribeCommand(redisClient
*c
) {
9712 pubsubUnsubscribeAllChannels(c
,1);
9717 for (j
= 1; j
< c
->argc
; j
++)
9718 pubsubUnsubscribeChannel(c
,c
->argv
[j
],1);
9722 static void psubscribeCommand(redisClient
*c
) {
9725 for (j
= 1; j
< c
->argc
; j
++)
9726 pubsubSubscribePattern(c
,c
->argv
[j
]);
9729 static void punsubscribeCommand(redisClient
*c
) {
9731 pubsubUnsubscribeAllPatterns(c
,1);
9736 for (j
= 1; j
< c
->argc
; j
++)
9737 pubsubUnsubscribePattern(c
,c
->argv
[j
],1);
9741 static void publishCommand(redisClient
*c
) {
9742 int receivers
= pubsubPublishMessage(c
->argv
[1],c
->argv
[2]);
9743 addReplyLong(c
,receivers
);
9746 /* ================================= Debugging ============================== */
9748 static void debugCommand(redisClient
*c
) {
9749 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
9751 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
9752 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
9753 addReply(c
,shared
.err
);
9757 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
9758 addReply(c
,shared
.err
);
9761 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
9762 addReply(c
,shared
.ok
);
9763 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
9765 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
9766 addReply(c
,shared
.err
);
9769 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
9770 addReply(c
,shared
.ok
);
9771 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
9772 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
9776 addReply(c
,shared
.nokeyerr
);
9779 key
= dictGetEntryKey(de
);
9780 val
= dictGetEntryVal(de
);
9781 if (!server
.vm_enabled
|| (key
->storage
== REDIS_VM_MEMORY
||
9782 key
->storage
== REDIS_VM_SWAPPING
)) {
9786 if (val
->encoding
< (sizeof(strencoding
)/sizeof(char*))) {
9787 strenc
= strencoding
[val
->encoding
];
9789 snprintf(buf
,64,"unknown encoding %d\n", val
->encoding
);
9792 addReplySds(c
,sdscatprintf(sdsempty(),
9793 "+Key at:%p refcount:%d, value at:%p refcount:%d "
9794 "encoding:%s serializedlength:%lld\r\n",
9795 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
9796 strenc
, (long long) rdbSavedObjectLen(val
,NULL
)));
9798 addReplySds(c
,sdscatprintf(sdsempty(),
9799 "+Key at:%p refcount:%d, value swapped at: page %llu "
9800 "using %llu pages\r\n",
9801 (void*)key
, key
->refcount
, (unsigned long long) key
->vm
.page
,
9802 (unsigned long long) key
->vm
.usedpages
));
9804 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapin") && c
->argc
== 3) {
9805 lookupKeyRead(c
->db
,c
->argv
[2]);
9806 addReply(c
,shared
.ok
);
9807 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
9808 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
9811 if (!server
.vm_enabled
) {
9812 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
9816 addReply(c
,shared
.nokeyerr
);
9819 key
= dictGetEntryKey(de
);
9820 val
= dictGetEntryVal(de
);
9821 /* If the key is shared we want to create a copy */
9822 if (key
->refcount
> 1) {
9823 robj
*newkey
= dupStringObject(key
);
9825 key
= dictGetEntryKey(de
) = newkey
;
9828 if (key
->storage
!= REDIS_VM_MEMORY
) {
9829 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
9830 } else if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
9831 dictGetEntryVal(de
) = NULL
;
9832 addReply(c
,shared
.ok
);
9834 addReply(c
,shared
.err
);
9837 addReplySds(c
,sdsnew(
9838 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPIN <key>|SWAPOUT <key>|RELOAD]\r\n"));
9842 static void _redisAssert(char *estr
, char *file
, int line
) {
9843 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
9844 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true\n",file
,line
,estr
);
9845 #ifdef HAVE_BACKTRACE
9846 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
9851 /* =================================== Main! ================================ */
9854 int linuxOvercommitMemoryValue(void) {
9855 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
9859 if (fgets(buf
,64,fp
) == NULL
) {
9868 void linuxOvercommitMemoryWarning(void) {
9869 if (linuxOvercommitMemoryValue() == 0) {
9870 redisLog(REDIS_WARNING
,"WARNING overcommit_memory is set to 0! Background save may fail under low condition memory. To fix this issue add 'vm.overcommit_memory = 1' to /etc/sysctl.conf and then reboot or run the command 'sysctl vm.overcommit_memory=1' for this to take effect.");
9873 #endif /* __linux__ */
9875 static void daemonize(void) {
9879 if (fork() != 0) exit(0); /* parent exits */
9880 setsid(); /* create a new session */
9882 /* Every output goes to /dev/null. If Redis is daemonized but
9883 * the 'logfile' is set to 'stdout' in the configuration file
9884 * it will not log at all. */
9885 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
9886 dup2(fd
, STDIN_FILENO
);
9887 dup2(fd
, STDOUT_FILENO
);
9888 dup2(fd
, STDERR_FILENO
);
9889 if (fd
> STDERR_FILENO
) close(fd
);
9891 /* Try to write the pid file */
9892 fp
= fopen(server
.pidfile
,"w");
9894 fprintf(fp
,"%d\n",getpid());
9899 static void version() {
9900 printf("Redis server version %s\n", REDIS_VERSION
);
9904 static void usage() {
9905 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
9906 fprintf(stderr
," ./redis-server - (read config from stdin)\n");
9910 int main(int argc
, char **argv
) {
9915 if (strcmp(argv
[1], "-v") == 0 ||
9916 strcmp(argv
[1], "--version") == 0) version();
9917 if (strcmp(argv
[1], "--help") == 0) usage();
9918 resetServerSaveParams();
9919 loadServerConfig(argv
[1]);
9920 } else if ((argc
> 2)) {
9923 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'");
9925 if (server
.daemonize
) daemonize();
9927 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
9929 linuxOvercommitMemoryWarning();
9932 if (server
.appendonly
) {
9933 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
9934 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %ld seconds",time(NULL
)-start
);
9936 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
9937 redisLog(REDIS_NOTICE
,"DB loaded from disk: %ld seconds",time(NULL
)-start
);
9939 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
9940 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
9942 aeDeleteEventLoop(server
.el
);
9946 /* ============================= Backtrace support ========================= */
9948 #ifdef HAVE_BACKTRACE
9949 static char *findFuncName(void *pointer
, unsigned long *offset
);
9951 static void *getMcontextEip(ucontext_t
*uc
) {
9952 #if defined(__FreeBSD__)
9953 return (void*) uc
->uc_mcontext
.mc_eip
;
9954 #elif defined(__dietlibc__)
9955 return (void*) uc
->uc_mcontext
.eip
;
9956 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
9958 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
9960 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
9962 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
9963 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
9964 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
9966 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
9968 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
9969 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
9970 #elif defined(__ia64__) /* Linux IA64 */
9971 return (void*) uc
->uc_mcontext
.sc_ip
;
9977 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
9979 char **messages
= NULL
;
9980 int i
, trace_size
= 0;
9981 unsigned long offset
=0;
9982 ucontext_t
*uc
= (ucontext_t
*) secret
;
9984 REDIS_NOTUSED(info
);
9986 redisLog(REDIS_WARNING
,
9987 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
9988 infostring
= genRedisInfoString();
9989 redisLog(REDIS_WARNING
, "%s",infostring
);
9990 /* It's not safe to sdsfree() the returned string under memory
9991 * corruption conditions. Let it leak as we are going to abort */
9993 trace_size
= backtrace(trace
, 100);
9994 /* overwrite sigaction with caller's address */
9995 if (getMcontextEip(uc
) != NULL
) {
9996 trace
[1] = getMcontextEip(uc
);
9998 messages
= backtrace_symbols(trace
, trace_size
);
10000 for (i
=1; i
<trace_size
; ++i
) {
10001 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
10003 p
= strchr(messages
[i
],'+');
10004 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
10005 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
10007 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
10010 /* free(messages); Don't call free() with possibly corrupted memory. */
10014 static void setupSigSegvAction(void) {
10015 struct sigaction act
;
10017 sigemptyset (&act
.sa_mask
);
10018 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
10019 * is used. Otherwise, sa_handler is used */
10020 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
10021 act
.sa_sigaction
= segvHandler
;
10022 sigaction (SIGSEGV
, &act
, NULL
);
10023 sigaction (SIGBUS
, &act
, NULL
);
10024 sigaction (SIGFPE
, &act
, NULL
);
10025 sigaction (SIGILL
, &act
, NULL
);
10026 sigaction (SIGBUS
, &act
, NULL
);
10030 #include "staticsymbols.h"
10031 /* This function try to convert a pointer into a function name. It's used in
10032 * oreder to provide a backtrace under segmentation fault that's able to
10033 * display functions declared as static (otherwise the backtrace is useless). */
10034 static char *findFuncName(void *pointer
, unsigned long *offset
){
10036 unsigned long off
, minoff
= 0;
10038 /* Try to match against the Symbol with the smallest offset */
10039 for (i
=0; symsTable
[i
].pointer
; i
++) {
10040 unsigned long lp
= (unsigned long) pointer
;
10042 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
10043 off
=lp
-symsTable
[i
].pointer
;
10044 if (ret
< 0 || off
< minoff
) {
10050 if (ret
== -1) return NULL
;
10052 return symsTable
[ret
].name
;
10054 #else /* HAVE_BACKTRACE */
10055 static void setupSigSegvAction(void) {
10057 #endif /* HAVE_BACKTRACE */