2 * Copyright (c) 2006-2009, 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.2"
40 #define __USE_POSIX199309
46 #endif /* HAVE_BACKTRACE */
54 #include <arpa/inet.h>
58 #include <sys/resource.h>
64 #include "solarisfixes.h"
68 #include "ae.h" /* Event driven programming library */
69 #include "sds.h" /* Dynamic safe strings */
70 #include "anet.h" /* Networking the easy way */
71 #include "dict.h" /* Hash tables */
72 #include "adlist.h" /* Linked lists */
73 #include "zmalloc.h" /* total memory usage aware version of malloc/free */
74 #include "lzf.h" /* LZF compression library */
75 #include "pqsort.h" /* Partial qsort for SORT+LIMIT */
81 /* Static server configuration */
82 #define REDIS_SERVERPORT 6379 /* TCP port */
83 #define REDIS_MAXIDLETIME (60*5) /* default client timeout */
84 #define REDIS_IOBUF_LEN 1024
85 #define REDIS_LOADBUF_LEN 1024
86 #define REDIS_STATIC_ARGS 4
87 #define REDIS_DEFAULT_DBNUM 16
88 #define REDIS_CONFIGLINE_MAX 1024
89 #define REDIS_OBJFREELIST_MAX 1000000 /* Max number of objects to cache */
90 #define REDIS_MAX_SYNC_TIME 60 /* Slave can't take more to sync */
91 #define REDIS_EXPIRELOOKUPS_PER_CRON 100 /* try to expire 100 keys/second */
92 #define REDIS_MAX_WRITE_PER_EVENT (1024*64)
93 #define REDIS_REQUEST_MAX_SIZE (1024*1024*256) /* max bytes in inline command */
95 /* If more then REDIS_WRITEV_THRESHOLD write packets are pending use writev */
96 #define REDIS_WRITEV_THRESHOLD 3
97 /* Max number of iovecs used for each writev call */
98 #define REDIS_WRITEV_IOVEC_COUNT 256
100 /* Hash table parameters */
101 #define REDIS_HT_MINFILL 10 /* Minimal hash table fill 10% */
104 #define REDIS_CMD_BULK 1 /* Bulk write command */
105 #define REDIS_CMD_INLINE 2 /* Inline command */
106 /* REDIS_CMD_DENYOOM reserves a longer comment: all the commands marked with
107 this flags will return an error when the 'maxmemory' option is set in the
108 config file and the server is using more than maxmemory bytes of memory.
109 In short this commands are denied on low memory conditions. */
110 #define REDIS_CMD_DENYOOM 4
113 #define REDIS_STRING 0
119 /* Objects encoding */
120 #define REDIS_ENCODING_RAW 0 /* Raw representation */
121 #define REDIS_ENCODING_INT 1 /* Encoded as integer */
123 /* Object types only used for dumping to disk */
124 #define REDIS_EXPIRETIME 253
125 #define REDIS_SELECTDB 254
126 #define REDIS_EOF 255
128 /* Defines related to the dump file format. To store 32 bits lengths for short
129 * keys requires a lot of space, so we check the most significant 2 bits of
130 * the first byte to interpreter the length:
132 * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
133 * 01|000000 00000000 => 01, the len is 14 byes, 6 bits + 8 bits of next byte
134 * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
135 * 11|000000 this means: specially encoded object will follow. The six bits
136 * number specify the kind of object that follows.
137 * See the REDIS_RDB_ENC_* defines.
139 * Lenghts up to 63 are stored using a single byte, most DB keys, and may
140 * values, will fit inside. */
141 #define REDIS_RDB_6BITLEN 0
142 #define REDIS_RDB_14BITLEN 1
143 #define REDIS_RDB_32BITLEN 2
144 #define REDIS_RDB_ENCVAL 3
145 #define REDIS_RDB_LENERR UINT_MAX
147 /* When a length of a string object stored on disk has the first two bits
148 * set, the remaining two bits specify a special encoding for the object
149 * accordingly to the following defines: */
150 #define REDIS_RDB_ENC_INT8 0 /* 8 bit signed integer */
151 #define REDIS_RDB_ENC_INT16 1 /* 16 bit signed integer */
152 #define REDIS_RDB_ENC_INT32 2 /* 32 bit signed integer */
153 #define REDIS_RDB_ENC_LZF 3 /* string compressed with FASTLZ */
155 /* Virtual memory object->where field. */
156 #define REDIS_VM_MEMORY 0 /* The object is on memory */
157 #define REDIS_VM_SWAPPED 1 /* The object is on disk */
158 #define REDIS_VM_SWAPPING 2 /* Redis is swapping this object on disk */
159 #define REDIS_VM_LOADING 3 /* Redis is loading this object from disk */
161 /* Virtual memory static configuration stuff.
162 * Check vmFindContiguousPages() to know more about this magic numbers. */
163 #define REDIS_VM_MAX_NEAR_PAGES 65536
164 #define REDIS_VM_MAX_RANDOM_JUMP 4096
167 #define REDIS_CLOSE 1 /* This client connection should be closed ASAP */
168 #define REDIS_SLAVE 2 /* This client is a slave server */
169 #define REDIS_MASTER 4 /* This client is a master server */
170 #define REDIS_MONITOR 8 /* This client is a slave monitor, see MONITOR */
171 #define REDIS_MULTI 16 /* This client is in a MULTI context */
172 #define REDIS_BLOCKED 32 /* The client is waiting in a blocking operation */
174 /* Slave replication state - slave side */
175 #define REDIS_REPL_NONE 0 /* No active replication */
176 #define REDIS_REPL_CONNECT 1 /* Must connect to master */
177 #define REDIS_REPL_CONNECTED 2 /* Connected to master */
179 /* Slave replication state - from the point of view of master
180 * Note that in SEND_BULK and ONLINE state the slave receives new updates
181 * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
182 * to start the next background saving in order to send updates to it. */
183 #define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
184 #define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
185 #define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
186 #define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
188 /* List related stuff */
192 /* Sort operations */
193 #define REDIS_SORT_GET 0
194 #define REDIS_SORT_ASC 1
195 #define REDIS_SORT_DESC 2
196 #define REDIS_SORTKEY_MAX 1024
199 #define REDIS_DEBUG 0
200 #define REDIS_VERBOSE 1
201 #define REDIS_NOTICE 2
202 #define REDIS_WARNING 3
204 /* Anti-warning macro... */
205 #define REDIS_NOTUSED(V) ((void) V)
207 #define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
208 #define ZSKIPLIST_P 0.25 /* Skiplist P = 1/4 */
210 /* Append only defines */
211 #define APPENDFSYNC_NO 0
212 #define APPENDFSYNC_ALWAYS 1
213 #define APPENDFSYNC_EVERYSEC 2
215 /* We can print the stacktrace, so our assert is defined this way: */
216 #define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e),exit(1)))
217 static void _redisAssert(char *estr
);
219 /*================================= Data types ============================== */
221 /* A redis object, that is a type able to hold a string / list / set */
223 /* The VM object structure */
224 struct redisObjectVM
{
225 off_t page
; /* the page at witch the object is stored on disk */
226 off_t usedpages
; /* number of pages used on disk */
227 time_t atime
; /* Last access time */
230 /* The actual Redis Object */
231 typedef struct redisObject
{
234 unsigned char encoding
;
235 unsigned char storage
; /* If this object is a key, where is the value?
236 * REDIS_VM_MEMORY, REDIS_VM_SWAPPED, ... */
237 unsigned char vtype
; /* If this object is a key, and value is swapped out,
238 * this is the type of the swapped out object. */
240 /* VM fields, this are only allocated if VM is active, otherwise the
241 * object allocation function will just allocate
242 * sizeof(redisObjct) minus sizeof(redisObjectVM), so using
243 * Redis without VM active will not have any overhead. */
244 struct redisObjectVM vm
;
247 /* Macro used to initalize a Redis object allocated on the stack.
248 * Note that this macro is taken near the structure definition to make sure
249 * we'll update it when the structure is changed, to avoid bugs like
250 * bug #85 introduced exactly in this way. */
251 #define initStaticStringObject(_var,_ptr) do { \
253 _var.type = REDIS_STRING; \
254 _var.encoding = REDIS_ENCODING_RAW; \
256 if (server.vm_enabled) _var.storage = REDIS_VM_MEMORY; \
259 typedef struct redisDb
{
260 dict
*dict
; /* The keyspace for this DB */
261 dict
*expires
; /* Timeout of keys with a timeout set */
262 dict
*blockingkeys
; /* Keys with clients waiting for data (BLPOP) */
266 /* Client MULTI/EXEC state */
267 typedef struct multiCmd
{
270 struct redisCommand
*cmd
;
273 typedef struct multiState
{
274 multiCmd
*commands
; /* Array of MULTI commands */
275 int count
; /* Total number of MULTI commands */
278 /* With multiplexing we need to take per-clinet state.
279 * Clients are taken in a liked list. */
280 typedef struct redisClient
{
285 robj
**argv
, **mbargv
;
287 int bulklen
; /* bulk read len. -1 if not in bulk read mode */
288 int multibulk
; /* multi bulk command format active */
291 time_t lastinteraction
; /* time of the last interaction, used for timeout */
292 int flags
; /* REDIS_CLOSE | REDIS_SLAVE | REDIS_MONITOR */
294 int slaveseldb
; /* slave selected db, if this client is a slave */
295 int authenticated
; /* when requirepass is non-NULL */
296 int replstate
; /* replication state if this is a slave */
297 int repldbfd
; /* replication DB file descriptor */
298 long repldboff
; /* replication DB file offset */
299 off_t repldbsize
; /* replication DB file size */
300 multiState mstate
; /* MULTI/EXEC state */
301 robj
**blockingkeys
; /* The key we waiting to terminate a blocking
302 * operation such as BLPOP. Otherwise NULL. */
303 int blockingkeysnum
; /* Number of blocking keys */
304 time_t blockingto
; /* Blocking operation timeout. If UNIX current time
305 * is >= blockingto then the operation timed out. */
313 /* Global server state structure */
318 dict
*sharingpool
; /* Poll used for object sharing */
319 unsigned int sharingpoolsize
;
320 long long dirty
; /* changes to DB from the last save */
322 list
*slaves
, *monitors
;
323 char neterr
[ANET_ERR_LEN
];
325 int cronloops
; /* number of times the cron function run */
326 list
*objfreelist
; /* A list of freed objects to avoid malloc() */
327 time_t lastsave
; /* Unix time of last save succeeede */
328 size_t usedmemory
; /* Used memory in megabytes */
329 /* Fields used only for stats */
330 time_t stat_starttime
; /* server start time */
331 long long stat_numcommands
; /* number of processed commands */
332 long long stat_numconnections
; /* number of connections received */
345 pid_t bgsavechildpid
;
346 pid_t bgrewritechildpid
;
347 sds bgrewritebuf
; /* buffer taken by parent during oppend only rewrite */
348 struct saveparam
*saveparams
;
353 char *appendfilename
;
357 /* Replication related */
362 redisClient
*master
; /* client that is master for this slave */
364 unsigned int maxclients
;
365 unsigned long long maxmemory
;
366 unsigned int blockedclients
;
367 /* Sort parameters - qsort_r() is only available under BSD so we
368 * have to take this state global, in order to pass it to sortCompare() */
372 /* Virtual memory configuration */
376 unsigned long long vm_max_memory
;
377 /* Virtual memory state */
380 off_t vm_next_page
; /* Next probably empty page */
381 off_t vm_near_pages
; /* Number of pages allocated sequentially */
382 unsigned char *vm_bitmap
; /* Bitmap of free/used pages */
383 time_t unixtime
; /* Unix time sampled every second. */
384 /* Virtual memory stats */
385 unsigned long long vm_stats_used_pages
;
386 unsigned long long vm_stats_swapped_objects
;
387 unsigned long long vm_stats_swapouts
;
388 unsigned long long vm_stats_swapins
;
391 typedef void redisCommandProc(redisClient
*c
);
392 struct redisCommand
{
394 redisCommandProc
*proc
;
399 struct redisFunctionSym
{
401 unsigned long pointer
;
404 typedef struct _redisSortObject
{
412 typedef struct _redisSortOperation
{
415 } redisSortOperation
;
417 /* ZSETs use a specialized version of Skiplists */
419 typedef struct zskiplistNode
{
420 struct zskiplistNode
**forward
;
421 struct zskiplistNode
*backward
;
426 typedef struct zskiplist
{
427 struct zskiplistNode
*header
, *tail
;
428 unsigned long length
;
432 typedef struct zset
{
437 /* Our shared "common" objects */
439 struct sharedObjectsStruct
{
440 robj
*crlf
, *ok
, *err
, *emptybulk
, *czero
, *cone
, *pong
, *space
,
441 *colon
, *nullbulk
, *nullmultibulk
, *queued
,
442 *emptymultibulk
, *wrongtypeerr
, *nokeyerr
, *syntaxerr
, *sameobjecterr
,
443 *outofrangeerr
, *plus
,
444 *select0
, *select1
, *select2
, *select3
, *select4
,
445 *select5
, *select6
, *select7
, *select8
, *select9
;
448 /* Global vars that are actally used as constants. The following double
449 * values are used for double on-disk serialization, and are initialized
450 * at runtime to avoid strange compiler optimizations. */
452 static double R_Zero
, R_PosInf
, R_NegInf
, R_Nan
;
454 /*================================ Prototypes =============================== */
456 static void freeStringObject(robj
*o
);
457 static void freeListObject(robj
*o
);
458 static void freeSetObject(robj
*o
);
459 static void decrRefCount(void *o
);
460 static robj
*createObject(int type
, void *ptr
);
461 static void freeClient(redisClient
*c
);
462 static int rdbLoad(char *filename
);
463 static void addReply(redisClient
*c
, robj
*obj
);
464 static void addReplySds(redisClient
*c
, sds s
);
465 static void incrRefCount(robj
*o
);
466 static int rdbSaveBackground(char *filename
);
467 static robj
*createStringObject(char *ptr
, size_t len
);
468 static robj
*dupStringObject(robj
*o
);
469 static void replicationFeedSlaves(list
*slaves
, struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
470 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
471 static int syncWithMaster(void);
472 static robj
*tryObjectSharing(robj
*o
);
473 static int tryObjectEncoding(robj
*o
);
474 static robj
*getDecodedObject(robj
*o
);
475 static int removeExpire(redisDb
*db
, robj
*key
);
476 static int expireIfNeeded(redisDb
*db
, robj
*key
);
477 static int deleteIfVolatile(redisDb
*db
, robj
*key
);
478 static int deleteIfSwapped(redisDb
*db
, robj
*key
);
479 static int deleteKey(redisDb
*db
, robj
*key
);
480 static time_t getExpire(redisDb
*db
, robj
*key
);
481 static int setExpire(redisDb
*db
, robj
*key
, time_t when
);
482 static void updateSlavesWaitingBgsave(int bgsaveerr
);
483 static void freeMemoryIfNeeded(void);
484 static int processCommand(redisClient
*c
);
485 static void setupSigSegvAction(void);
486 static void rdbRemoveTempFile(pid_t childpid
);
487 static void aofRemoveTempFile(pid_t childpid
);
488 static size_t stringObjectLen(robj
*o
);
489 static void processInputBuffer(redisClient
*c
);
490 static zskiplist
*zslCreate(void);
491 static void zslFree(zskiplist
*zsl
);
492 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
);
493 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
494 static void initClientMultiState(redisClient
*c
);
495 static void freeClientMultiState(redisClient
*c
);
496 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
);
497 static void unblockClient(redisClient
*c
);
498 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
);
499 static void vmInit(void);
500 static void vmMarkPagesFree(off_t page
, off_t count
);
501 static robj
*vmLoadObject(robj
*key
);
502 static robj
*vmPreviewObject(robj
*key
);
503 static int vmSwapOneObject(void);
504 static int vmCanSwapOut(void);
505 static void freeOneObjectFromFreelist(void);
507 static void authCommand(redisClient
*c
);
508 static void pingCommand(redisClient
*c
);
509 static void echoCommand(redisClient
*c
);
510 static void setCommand(redisClient
*c
);
511 static void setnxCommand(redisClient
*c
);
512 static void getCommand(redisClient
*c
);
513 static void delCommand(redisClient
*c
);
514 static void existsCommand(redisClient
*c
);
515 static void incrCommand(redisClient
*c
);
516 static void decrCommand(redisClient
*c
);
517 static void incrbyCommand(redisClient
*c
);
518 static void decrbyCommand(redisClient
*c
);
519 static void selectCommand(redisClient
*c
);
520 static void randomkeyCommand(redisClient
*c
);
521 static void keysCommand(redisClient
*c
);
522 static void dbsizeCommand(redisClient
*c
);
523 static void lastsaveCommand(redisClient
*c
);
524 static void saveCommand(redisClient
*c
);
525 static void bgsaveCommand(redisClient
*c
);
526 static void bgrewriteaofCommand(redisClient
*c
);
527 static void shutdownCommand(redisClient
*c
);
528 static void moveCommand(redisClient
*c
);
529 static void renameCommand(redisClient
*c
);
530 static void renamenxCommand(redisClient
*c
);
531 static void lpushCommand(redisClient
*c
);
532 static void rpushCommand(redisClient
*c
);
533 static void lpopCommand(redisClient
*c
);
534 static void rpopCommand(redisClient
*c
);
535 static void llenCommand(redisClient
*c
);
536 static void lindexCommand(redisClient
*c
);
537 static void lrangeCommand(redisClient
*c
);
538 static void ltrimCommand(redisClient
*c
);
539 static void typeCommand(redisClient
*c
);
540 static void lsetCommand(redisClient
*c
);
541 static void saddCommand(redisClient
*c
);
542 static void sremCommand(redisClient
*c
);
543 static void smoveCommand(redisClient
*c
);
544 static void sismemberCommand(redisClient
*c
);
545 static void scardCommand(redisClient
*c
);
546 static void spopCommand(redisClient
*c
);
547 static void srandmemberCommand(redisClient
*c
);
548 static void sinterCommand(redisClient
*c
);
549 static void sinterstoreCommand(redisClient
*c
);
550 static void sunionCommand(redisClient
*c
);
551 static void sunionstoreCommand(redisClient
*c
);
552 static void sdiffCommand(redisClient
*c
);
553 static void sdiffstoreCommand(redisClient
*c
);
554 static void syncCommand(redisClient
*c
);
555 static void flushdbCommand(redisClient
*c
);
556 static void flushallCommand(redisClient
*c
);
557 static void sortCommand(redisClient
*c
);
558 static void lremCommand(redisClient
*c
);
559 static void rpoplpushcommand(redisClient
*c
);
560 static void infoCommand(redisClient
*c
);
561 static void mgetCommand(redisClient
*c
);
562 static void monitorCommand(redisClient
*c
);
563 static void expireCommand(redisClient
*c
);
564 static void expireatCommand(redisClient
*c
);
565 static void getsetCommand(redisClient
*c
);
566 static void ttlCommand(redisClient
*c
);
567 static void slaveofCommand(redisClient
*c
);
568 static void debugCommand(redisClient
*c
);
569 static void msetCommand(redisClient
*c
);
570 static void msetnxCommand(redisClient
*c
);
571 static void zaddCommand(redisClient
*c
);
572 static void zincrbyCommand(redisClient
*c
);
573 static void zrangeCommand(redisClient
*c
);
574 static void zrangebyscoreCommand(redisClient
*c
);
575 static void zrevrangeCommand(redisClient
*c
);
576 static void zcardCommand(redisClient
*c
);
577 static void zremCommand(redisClient
*c
);
578 static void zscoreCommand(redisClient
*c
);
579 static void zremrangebyscoreCommand(redisClient
*c
);
580 static void multiCommand(redisClient
*c
);
581 static void execCommand(redisClient
*c
);
582 static void blpopCommand(redisClient
*c
);
583 static void brpopCommand(redisClient
*c
);
585 /*================================= Globals ================================= */
588 static struct redisServer server
; /* server global state */
589 static struct redisCommand cmdTable
[] = {
590 {"get",getCommand
,2,REDIS_CMD_INLINE
},
591 {"set",setCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
592 {"setnx",setnxCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
593 {"del",delCommand
,-2,REDIS_CMD_INLINE
},
594 {"exists",existsCommand
,2,REDIS_CMD_INLINE
},
595 {"incr",incrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
596 {"decr",decrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
597 {"mget",mgetCommand
,-2,REDIS_CMD_INLINE
},
598 {"rpush",rpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
599 {"lpush",lpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
600 {"rpop",rpopCommand
,2,REDIS_CMD_INLINE
},
601 {"lpop",lpopCommand
,2,REDIS_CMD_INLINE
},
602 {"brpop",brpopCommand
,-3,REDIS_CMD_INLINE
},
603 {"blpop",blpopCommand
,-3,REDIS_CMD_INLINE
},
604 {"llen",llenCommand
,2,REDIS_CMD_INLINE
},
605 {"lindex",lindexCommand
,3,REDIS_CMD_INLINE
},
606 {"lset",lsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
607 {"lrange",lrangeCommand
,4,REDIS_CMD_INLINE
},
608 {"ltrim",ltrimCommand
,4,REDIS_CMD_INLINE
},
609 {"lrem",lremCommand
,4,REDIS_CMD_BULK
},
610 {"rpoplpush",rpoplpushcommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
611 {"sadd",saddCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
612 {"srem",sremCommand
,3,REDIS_CMD_BULK
},
613 {"smove",smoveCommand
,4,REDIS_CMD_BULK
},
614 {"sismember",sismemberCommand
,3,REDIS_CMD_BULK
},
615 {"scard",scardCommand
,2,REDIS_CMD_INLINE
},
616 {"spop",spopCommand
,2,REDIS_CMD_INLINE
},
617 {"srandmember",srandmemberCommand
,2,REDIS_CMD_INLINE
},
618 {"sinter",sinterCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
619 {"sinterstore",sinterstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
620 {"sunion",sunionCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
621 {"sunionstore",sunionstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
622 {"sdiff",sdiffCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
623 {"sdiffstore",sdiffstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
624 {"smembers",sinterCommand
,2,REDIS_CMD_INLINE
},
625 {"zadd",zaddCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
626 {"zincrby",zincrbyCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
627 {"zrem",zremCommand
,3,REDIS_CMD_BULK
},
628 {"zremrangebyscore",zremrangebyscoreCommand
,4,REDIS_CMD_INLINE
},
629 {"zrange",zrangeCommand
,-4,REDIS_CMD_INLINE
},
630 {"zrangebyscore",zrangebyscoreCommand
,-4,REDIS_CMD_INLINE
},
631 {"zrevrange",zrevrangeCommand
,-4,REDIS_CMD_INLINE
},
632 {"zcard",zcardCommand
,2,REDIS_CMD_INLINE
},
633 {"zscore",zscoreCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
634 {"incrby",incrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
635 {"decrby",decrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
636 {"getset",getsetCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
637 {"mset",msetCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
638 {"msetnx",msetnxCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
639 {"randomkey",randomkeyCommand
,1,REDIS_CMD_INLINE
},
640 {"select",selectCommand
,2,REDIS_CMD_INLINE
},
641 {"move",moveCommand
,3,REDIS_CMD_INLINE
},
642 {"rename",renameCommand
,3,REDIS_CMD_INLINE
},
643 {"renamenx",renamenxCommand
,3,REDIS_CMD_INLINE
},
644 {"expire",expireCommand
,3,REDIS_CMD_INLINE
},
645 {"expireat",expireatCommand
,3,REDIS_CMD_INLINE
},
646 {"keys",keysCommand
,2,REDIS_CMD_INLINE
},
647 {"dbsize",dbsizeCommand
,1,REDIS_CMD_INLINE
},
648 {"auth",authCommand
,2,REDIS_CMD_INLINE
},
649 {"ping",pingCommand
,1,REDIS_CMD_INLINE
},
650 {"echo",echoCommand
,2,REDIS_CMD_BULK
},
651 {"save",saveCommand
,1,REDIS_CMD_INLINE
},
652 {"bgsave",bgsaveCommand
,1,REDIS_CMD_INLINE
},
653 {"bgrewriteaof",bgrewriteaofCommand
,1,REDIS_CMD_INLINE
},
654 {"shutdown",shutdownCommand
,1,REDIS_CMD_INLINE
},
655 {"lastsave",lastsaveCommand
,1,REDIS_CMD_INLINE
},
656 {"type",typeCommand
,2,REDIS_CMD_INLINE
},
657 {"multi",multiCommand
,1,REDIS_CMD_INLINE
},
658 {"exec",execCommand
,1,REDIS_CMD_INLINE
},
659 {"sync",syncCommand
,1,REDIS_CMD_INLINE
},
660 {"flushdb",flushdbCommand
,1,REDIS_CMD_INLINE
},
661 {"flushall",flushallCommand
,1,REDIS_CMD_INLINE
},
662 {"sort",sortCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
663 {"info",infoCommand
,1,REDIS_CMD_INLINE
},
664 {"monitor",monitorCommand
,1,REDIS_CMD_INLINE
},
665 {"ttl",ttlCommand
,2,REDIS_CMD_INLINE
},
666 {"slaveof",slaveofCommand
,3,REDIS_CMD_INLINE
},
667 {"debug",debugCommand
,-2,REDIS_CMD_INLINE
},
671 /*============================ Utility functions ============================ */
673 /* Glob-style pattern matching. */
674 int stringmatchlen(const char *pattern
, int patternLen
,
675 const char *string
, int stringLen
, int nocase
)
680 while (pattern
[1] == '*') {
685 return 1; /* match */
687 if (stringmatchlen(pattern
+1, patternLen
-1,
688 string
, stringLen
, nocase
))
689 return 1; /* match */
693 return 0; /* no match */
697 return 0; /* no match */
707 not = pattern
[0] == '^';
714 if (pattern
[0] == '\\') {
717 if (pattern
[0] == string
[0])
719 } else if (pattern
[0] == ']') {
721 } else if (patternLen
== 0) {
725 } else if (pattern
[1] == '-' && patternLen
>= 3) {
726 int start
= pattern
[0];
727 int end
= pattern
[2];
735 start
= tolower(start
);
741 if (c
>= start
&& c
<= end
)
745 if (pattern
[0] == string
[0])
748 if (tolower((int)pattern
[0]) == tolower((int)string
[0]))
758 return 0; /* no match */
764 if (patternLen
>= 2) {
771 if (pattern
[0] != string
[0])
772 return 0; /* no match */
774 if (tolower((int)pattern
[0]) != tolower((int)string
[0]))
775 return 0; /* no match */
783 if (stringLen
== 0) {
784 while(*pattern
== '*') {
791 if (patternLen
== 0 && stringLen
== 0)
796 static void redisLog(int level
, const char *fmt
, ...) {
800 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
804 if (level
>= server
.verbosity
) {
810 strftime(buf
,64,"%d %b %H:%M:%S",localtime(&now
));
811 fprintf(fp
,"%s %c ",buf
,c
[level
]);
812 vfprintf(fp
, fmt
, ap
);
818 if (server
.logfile
) fclose(fp
);
821 /*====================== Hash table type implementation ==================== */
823 /* This is an hash table type that uses the SDS dynamic strings libary as
824 * keys and radis objects as values (objects can hold SDS strings,
827 static void dictVanillaFree(void *privdata
, void *val
)
829 DICT_NOTUSED(privdata
);
833 static void dictListDestructor(void *privdata
, void *val
)
835 DICT_NOTUSED(privdata
);
836 listRelease((list
*)val
);
839 static int sdsDictKeyCompare(void *privdata
, const void *key1
,
843 DICT_NOTUSED(privdata
);
845 l1
= sdslen((sds
)key1
);
846 l2
= sdslen((sds
)key2
);
847 if (l1
!= l2
) return 0;
848 return memcmp(key1
, key2
, l1
) == 0;
851 static void dictRedisObjectDestructor(void *privdata
, void *val
)
853 DICT_NOTUSED(privdata
);
855 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
859 static int dictObjKeyCompare(void *privdata
, const void *key1
,
862 const robj
*o1
= key1
, *o2
= key2
;
863 return sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
866 static unsigned int dictObjHash(const void *key
) {
868 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
871 static int dictEncObjKeyCompare(void *privdata
, const void *key1
,
874 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
877 o1
= getDecodedObject(o1
);
878 o2
= getDecodedObject(o2
);
879 cmp
= sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
885 static unsigned int dictEncObjHash(const void *key
) {
886 robj
*o
= (robj
*) key
;
888 o
= getDecodedObject(o
);
889 unsigned int hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
894 static dictType setDictType
= {
895 dictEncObjHash
, /* hash function */
898 dictEncObjKeyCompare
, /* key compare */
899 dictRedisObjectDestructor
, /* key destructor */
900 NULL
/* val destructor */
903 static dictType zsetDictType
= {
904 dictEncObjHash
, /* hash function */
907 dictEncObjKeyCompare
, /* key compare */
908 dictRedisObjectDestructor
, /* key destructor */
909 dictVanillaFree
/* val destructor of malloc(sizeof(double)) */
912 static dictType hashDictType
= {
913 dictObjHash
, /* hash function */
916 dictObjKeyCompare
, /* key compare */
917 dictRedisObjectDestructor
, /* key destructor */
918 dictRedisObjectDestructor
/* val destructor */
921 /* Keylist hash table type has unencoded redis objects as keys and
922 * lists as values. It's used for blocking operations (BLPOP) */
923 static dictType keylistDictType
= {
924 dictObjHash
, /* hash function */
927 dictObjKeyCompare
, /* key compare */
928 dictRedisObjectDestructor
, /* key destructor */
929 dictListDestructor
/* val destructor */
932 /* ========================= Random utility functions ======================= */
934 /* Redis generally does not try to recover from out of memory conditions
935 * when allocating objects or strings, it is not clear if it will be possible
936 * to report this condition to the client since the networking layer itself
937 * is based on heap allocation for send buffers, so we simply abort.
938 * At least the code will be simpler to read... */
939 static void oom(const char *msg
) {
940 redisLog(REDIS_WARNING
, "%s: Out of memory\n",msg
);
945 /* ====================== Redis server networking stuff ===================== */
946 static void closeTimedoutClients(void) {
949 time_t now
= time(NULL
);
951 listRewind(server
.clients
);
952 while ((ln
= listYield(server
.clients
)) != NULL
) {
953 c
= listNodeValue(ln
);
954 if (server
.maxidletime
&&
955 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
956 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
957 (now
- c
->lastinteraction
> server
.maxidletime
))
959 redisLog(REDIS_VERBOSE
,"Closing idle client");
961 } else if (c
->flags
& REDIS_BLOCKED
) {
962 if (c
->blockingto
!= 0 && c
->blockingto
< now
) {
963 addReply(c
,shared
.nullmultibulk
);
970 static int htNeedsResize(dict
*dict
) {
971 long long size
, used
;
973 size
= dictSlots(dict
);
974 used
= dictSize(dict
);
975 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
976 (used
*100/size
< REDIS_HT_MINFILL
));
979 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
980 * we resize the hash table to save memory */
981 static void tryResizeHashTables(void) {
984 for (j
= 0; j
< server
.dbnum
; j
++) {
985 if (htNeedsResize(server
.db
[j
].dict
)) {
986 redisLog(REDIS_VERBOSE
,"The hash table %d is too sparse, resize it...",j
);
987 dictResize(server
.db
[j
].dict
);
988 redisLog(REDIS_VERBOSE
,"Hash table %d resized.",j
);
990 if (htNeedsResize(server
.db
[j
].expires
))
991 dictResize(server
.db
[j
].expires
);
995 /* A background saving child (BGSAVE) terminated its work. Handle this. */
996 void backgroundSaveDoneHandler(int statloc
) {
997 int exitcode
= WEXITSTATUS(statloc
);
998 int bysignal
= WIFSIGNALED(statloc
);
1000 if (!bysignal
&& exitcode
== 0) {
1001 redisLog(REDIS_NOTICE
,
1002 "Background saving terminated with success");
1004 server
.lastsave
= time(NULL
);
1005 } else if (!bysignal
&& exitcode
!= 0) {
1006 redisLog(REDIS_WARNING
, "Background saving error");
1008 redisLog(REDIS_WARNING
,
1009 "Background saving terminated by signal");
1010 rdbRemoveTempFile(server
.bgsavechildpid
);
1012 server
.bgsavechildpid
= -1;
1013 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1014 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1015 updateSlavesWaitingBgsave(exitcode
== 0 ? REDIS_OK
: REDIS_ERR
);
1018 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1020 void backgroundRewriteDoneHandler(int statloc
) {
1021 int exitcode
= WEXITSTATUS(statloc
);
1022 int bysignal
= WIFSIGNALED(statloc
);
1024 if (!bysignal
&& exitcode
== 0) {
1028 redisLog(REDIS_NOTICE
,
1029 "Background append only file rewriting terminated with success");
1030 /* Now it's time to flush the differences accumulated by the parent */
1031 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) server
.bgrewritechildpid
);
1032 fd
= open(tmpfile
,O_WRONLY
|O_APPEND
);
1034 redisLog(REDIS_WARNING
, "Not able to open the temp append only file produced by the child: %s", strerror(errno
));
1037 /* Flush our data... */
1038 if (write(fd
,server
.bgrewritebuf
,sdslen(server
.bgrewritebuf
)) !=
1039 (signed) sdslen(server
.bgrewritebuf
)) {
1040 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
));
1044 redisLog(REDIS_NOTICE
,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server
.bgrewritebuf
));
1045 /* Now our work is to rename the temp file into the stable file. And
1046 * switch the file descriptor used by the server for append only. */
1047 if (rename(tmpfile
,server
.appendfilename
) == -1) {
1048 redisLog(REDIS_WARNING
,"Can't rename the temp append only file into the stable one: %s", strerror(errno
));
1052 /* Mission completed... almost */
1053 redisLog(REDIS_NOTICE
,"Append only file successfully rewritten.");
1054 if (server
.appendfd
!= -1) {
1055 /* If append only is actually enabled... */
1056 close(server
.appendfd
);
1057 server
.appendfd
= fd
;
1059 server
.appendseldb
= -1; /* Make sure it will issue SELECT */
1060 redisLog(REDIS_NOTICE
,"The new append only file was selected for future appends.");
1062 /* If append only is disabled we just generate a dump in this
1063 * format. Why not? */
1066 } else if (!bysignal
&& exitcode
!= 0) {
1067 redisLog(REDIS_WARNING
, "Background append only file rewriting error");
1069 redisLog(REDIS_WARNING
,
1070 "Background append only file rewriting terminated by signal");
1073 sdsfree(server
.bgrewritebuf
);
1074 server
.bgrewritebuf
= sdsempty();
1075 aofRemoveTempFile(server
.bgrewritechildpid
);
1076 server
.bgrewritechildpid
= -1;
1079 static int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
1080 int j
, loops
= server
.cronloops
++;
1081 REDIS_NOTUSED(eventLoop
);
1083 REDIS_NOTUSED(clientData
);
1085 /* We take a cached value of the unix time in the global state because
1086 * with virtual memory and aging there is to store the current time
1087 * in objects at every object access, and accuracy is not needed.
1088 * To access a global var is faster than calling time(NULL) */
1089 server
.unixtime
= time(NULL
);
1091 /* Update the global state with the amount of used memory */
1092 server
.usedmemory
= zmalloc_used_memory();
1094 /* Show some info about non-empty databases */
1095 for (j
= 0; j
< server
.dbnum
; j
++) {
1096 long long size
, used
, vkeys
;
1098 size
= dictSlots(server
.db
[j
].dict
);
1099 used
= dictSize(server
.db
[j
].dict
);
1100 vkeys
= dictSize(server
.db
[j
].expires
);
1101 if (!(loops
% 5) && (used
|| vkeys
)) {
1102 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
1103 /* dictPrintStats(server.dict); */
1107 /* We don't want to resize the hash tables while a bacground saving
1108 * is in progress: the saving child is created using fork() that is
1109 * implemented with a copy-on-write semantic in most modern systems, so
1110 * if we resize the HT while there is the saving child at work actually
1111 * a lot of memory movements in the parent will cause a lot of pages
1113 if (server
.bgsavechildpid
== -1) tryResizeHashTables();
1115 /* Show information about connected clients */
1117 redisLog(REDIS_VERBOSE
,"%d clients connected (%d slaves), %zu bytes in use, %d shared objects",
1118 listLength(server
.clients
)-listLength(server
.slaves
),
1119 listLength(server
.slaves
),
1121 dictSize(server
.sharingpool
));
1124 /* Close connections of timedout clients */
1125 if ((server
.maxidletime
&& !(loops
% 10)) || server
.blockedclients
)
1126 closeTimedoutClients();
1128 /* Check if a background saving or AOF rewrite in progress terminated */
1129 if (server
.bgsavechildpid
!= -1 || server
.bgrewritechildpid
!= -1) {
1133 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
1134 if (pid
== server
.bgsavechildpid
) {
1135 backgroundSaveDoneHandler(statloc
);
1137 backgroundRewriteDoneHandler(statloc
);
1141 /* If there is not a background saving in progress check if
1142 * we have to save now */
1143 time_t now
= time(NULL
);
1144 for (j
= 0; j
< server
.saveparamslen
; j
++) {
1145 struct saveparam
*sp
= server
.saveparams
+j
;
1147 if (server
.dirty
>= sp
->changes
&&
1148 now
-server
.lastsave
> sp
->seconds
) {
1149 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
1150 sp
->changes
, sp
->seconds
);
1151 rdbSaveBackground(server
.dbfilename
);
1157 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1158 * will use few CPU cycles if there are few expiring keys, otherwise
1159 * it will get more aggressive to avoid that too much memory is used by
1160 * keys that can be removed from the keyspace. */
1161 for (j
= 0; j
< server
.dbnum
; j
++) {
1163 redisDb
*db
= server
.db
+j
;
1165 /* Continue to expire if at the end of the cycle more than 25%
1166 * of the keys were expired. */
1168 long num
= dictSize(db
->expires
);
1169 time_t now
= time(NULL
);
1172 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
1173 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
1178 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
1179 t
= (time_t) dictGetEntryVal(de
);
1181 deleteKey(db
,dictGetEntryKey(de
));
1185 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
1188 /* Swap a few keys on disk if we are over the memory limit and VM
1189 * is enbled. Try to free objects from the free list first. */
1190 if (vmCanSwapOut()) {
1191 while (server
.vm_enabled
&& zmalloc_used_memory() >
1192 server
.vm_max_memory
)
1194 if (listLength(server
.objfreelist
)) {
1195 freeOneObjectFromFreelist();
1196 } else if (vmSwapOneObject() == REDIS_ERR
) {
1197 if ((loops
% 30) == 0 && zmalloc_used_memory() >
1198 (server
.vm_max_memory
+server
.vm_max_memory
/10)) {
1199 redisLog(REDIS_WARNING
,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1206 /* Check if we should connect to a MASTER */
1207 if (server
.replstate
== REDIS_REPL_CONNECT
) {
1208 redisLog(REDIS_NOTICE
,"Connecting to MASTER...");
1209 if (syncWithMaster() == REDIS_OK
) {
1210 redisLog(REDIS_NOTICE
,"MASTER <-> SLAVE sync succeeded");
1216 static void createSharedObjects(void) {
1217 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1218 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1219 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1220 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1221 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1222 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1223 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1224 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1225 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1226 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1227 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1228 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1229 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1230 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1231 "-ERR no such key\r\n"));
1232 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1233 "-ERR syntax error\r\n"));
1234 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1235 "-ERR source and destination objects are the same\r\n"));
1236 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1237 "-ERR index out of range\r\n"));
1238 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1239 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1240 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1241 shared
.select0
= createStringObject("select 0\r\n",10);
1242 shared
.select1
= createStringObject("select 1\r\n",10);
1243 shared
.select2
= createStringObject("select 2\r\n",10);
1244 shared
.select3
= createStringObject("select 3\r\n",10);
1245 shared
.select4
= createStringObject("select 4\r\n",10);
1246 shared
.select5
= createStringObject("select 5\r\n",10);
1247 shared
.select6
= createStringObject("select 6\r\n",10);
1248 shared
.select7
= createStringObject("select 7\r\n",10);
1249 shared
.select8
= createStringObject("select 8\r\n",10);
1250 shared
.select9
= createStringObject("select 9\r\n",10);
1253 static void appendServerSaveParams(time_t seconds
, int changes
) {
1254 server
.saveparams
= zrealloc(server
.saveparams
,sizeof(struct saveparam
)*(server
.saveparamslen
+1));
1255 server
.saveparams
[server
.saveparamslen
].seconds
= seconds
;
1256 server
.saveparams
[server
.saveparamslen
].changes
= changes
;
1257 server
.saveparamslen
++;
1260 static void resetServerSaveParams() {
1261 zfree(server
.saveparams
);
1262 server
.saveparams
= NULL
;
1263 server
.saveparamslen
= 0;
1266 static void initServerConfig() {
1267 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1268 server
.port
= REDIS_SERVERPORT
;
1269 server
.verbosity
= REDIS_VERBOSE
;
1270 server
.maxidletime
= REDIS_MAXIDLETIME
;
1271 server
.saveparams
= NULL
;
1272 server
.logfile
= NULL
; /* NULL = log on standard output */
1273 server
.bindaddr
= NULL
;
1274 server
.glueoutputbuf
= 1;
1275 server
.daemonize
= 0;
1276 server
.appendonly
= 0;
1277 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1278 server
.lastfsync
= time(NULL
);
1279 server
.appendfd
= -1;
1280 server
.appendseldb
= -1; /* Make sure the first time will not match */
1281 server
.pidfile
= "/var/run/redis.pid";
1282 server
.dbfilename
= "dump.rdb";
1283 server
.appendfilename
= "appendonly.aof";
1284 server
.requirepass
= NULL
;
1285 server
.shareobjects
= 0;
1286 server
.rdbcompression
= 1;
1287 server
.sharingpoolsize
= 1024;
1288 server
.maxclients
= 0;
1289 server
.blockedclients
= 0;
1290 server
.maxmemory
= 0;
1291 server
.vm_enabled
= 0;
1292 server
.vm_page_size
= 256; /* 256 bytes per page */
1293 server
.vm_pages
= 1024*1024*100; /* 104 millions of pages */
1294 server
.vm_max_memory
= 1024LL*1024*1024*1; /* 1 GB of RAM */
1296 resetServerSaveParams();
1298 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1299 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1300 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1301 /* Replication related */
1303 server
.masterauth
= NULL
;
1304 server
.masterhost
= NULL
;
1305 server
.masterport
= 6379;
1306 server
.master
= NULL
;
1307 server
.replstate
= REDIS_REPL_NONE
;
1309 /* Double constants initialization */
1311 R_PosInf
= 1.0/R_Zero
;
1312 R_NegInf
= -1.0/R_Zero
;
1313 R_Nan
= R_Zero
/R_Zero
;
1316 static void initServer() {
1319 signal(SIGHUP
, SIG_IGN
);
1320 signal(SIGPIPE
, SIG_IGN
);
1321 setupSigSegvAction();
1323 server
.clients
= listCreate();
1324 server
.slaves
= listCreate();
1325 server
.monitors
= listCreate();
1326 server
.objfreelist
= listCreate();
1327 createSharedObjects();
1328 server
.el
= aeCreateEventLoop();
1329 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1330 server
.sharingpool
= dictCreate(&setDictType
,NULL
);
1331 server
.fd
= anetTcpServer(server
.neterr
, server
.port
, server
.bindaddr
);
1332 if (server
.fd
== -1) {
1333 redisLog(REDIS_WARNING
, "Opening TCP port: %s", server
.neterr
);
1336 for (j
= 0; j
< server
.dbnum
; j
++) {
1337 server
.db
[j
].dict
= dictCreate(&hashDictType
,NULL
);
1338 server
.db
[j
].expires
= dictCreate(&setDictType
,NULL
);
1339 server
.db
[j
].blockingkeys
= dictCreate(&keylistDictType
,NULL
);
1340 server
.db
[j
].id
= j
;
1342 server
.cronloops
= 0;
1343 server
.bgsavechildpid
= -1;
1344 server
.bgrewritechildpid
= -1;
1345 server
.bgrewritebuf
= sdsempty();
1346 server
.lastsave
= time(NULL
);
1348 server
.usedmemory
= 0;
1349 server
.stat_numcommands
= 0;
1350 server
.stat_numconnections
= 0;
1351 server
.stat_starttime
= time(NULL
);
1352 server
.unixtime
= time(NULL
);
1353 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1355 if (server
.appendonly
) {
1356 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1357 if (server
.appendfd
== -1) {
1358 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1364 if (server
.vm_enabled
) vmInit();
1367 /* Empty the whole database */
1368 static long long emptyDb() {
1370 long long removed
= 0;
1372 for (j
= 0; j
< server
.dbnum
; j
++) {
1373 removed
+= dictSize(server
.db
[j
].dict
);
1374 dictEmpty(server
.db
[j
].dict
);
1375 dictEmpty(server
.db
[j
].expires
);
1380 static int yesnotoi(char *s
) {
1381 if (!strcasecmp(s
,"yes")) return 1;
1382 else if (!strcasecmp(s
,"no")) return 0;
1386 /* I agree, this is a very rudimental way to load a configuration...
1387 will improve later if the config gets more complex */
1388 static void loadServerConfig(char *filename
) {
1390 char buf
[REDIS_CONFIGLINE_MAX
+1], *err
= NULL
;
1394 if (filename
[0] == '-' && filename
[1] == '\0')
1397 if ((fp
= fopen(filename
,"r")) == NULL
) {
1398 redisLog(REDIS_WARNING
,"Fatal error, can't open config file");
1403 while(fgets(buf
,REDIS_CONFIGLINE_MAX
+1,fp
) != NULL
) {
1409 line
= sdstrim(line
," \t\r\n");
1411 /* Skip comments and blank lines*/
1412 if (line
[0] == '#' || line
[0] == '\0') {
1417 /* Split into arguments */
1418 argv
= sdssplitlen(line
,sdslen(line
)," ",1,&argc
);
1419 sdstolower(argv
[0]);
1421 /* Execute config directives */
1422 if (!strcasecmp(argv
[0],"timeout") && argc
== 2) {
1423 server
.maxidletime
= atoi(argv
[1]);
1424 if (server
.maxidletime
< 0) {
1425 err
= "Invalid timeout value"; goto loaderr
;
1427 } else if (!strcasecmp(argv
[0],"port") && argc
== 2) {
1428 server
.port
= atoi(argv
[1]);
1429 if (server
.port
< 1 || server
.port
> 65535) {
1430 err
= "Invalid port"; goto loaderr
;
1432 } else if (!strcasecmp(argv
[0],"bind") && argc
== 2) {
1433 server
.bindaddr
= zstrdup(argv
[1]);
1434 } else if (!strcasecmp(argv
[0],"save") && argc
== 3) {
1435 int seconds
= atoi(argv
[1]);
1436 int changes
= atoi(argv
[2]);
1437 if (seconds
< 1 || changes
< 0) {
1438 err
= "Invalid save parameters"; goto loaderr
;
1440 appendServerSaveParams(seconds
,changes
);
1441 } else if (!strcasecmp(argv
[0],"dir") && argc
== 2) {
1442 if (chdir(argv
[1]) == -1) {
1443 redisLog(REDIS_WARNING
,"Can't chdir to '%s': %s",
1444 argv
[1], strerror(errno
));
1447 } else if (!strcasecmp(argv
[0],"loglevel") && argc
== 2) {
1448 if (!strcasecmp(argv
[1],"debug")) server
.verbosity
= REDIS_DEBUG
;
1449 else if (!strcasecmp(argv
[1],"verbose")) server
.verbosity
= REDIS_VERBOSE
;
1450 else if (!strcasecmp(argv
[1],"notice")) server
.verbosity
= REDIS_NOTICE
;
1451 else if (!strcasecmp(argv
[1],"warning")) server
.verbosity
= REDIS_WARNING
;
1453 err
= "Invalid log level. Must be one of debug, notice, warning";
1456 } else if (!strcasecmp(argv
[0],"logfile") && argc
== 2) {
1459 server
.logfile
= zstrdup(argv
[1]);
1460 if (!strcasecmp(server
.logfile
,"stdout")) {
1461 zfree(server
.logfile
);
1462 server
.logfile
= NULL
;
1464 if (server
.logfile
) {
1465 /* Test if we are able to open the file. The server will not
1466 * be able to abort just for this problem later... */
1467 logfp
= fopen(server
.logfile
,"a");
1468 if (logfp
== NULL
) {
1469 err
= sdscatprintf(sdsempty(),
1470 "Can't open the log file: %s", strerror(errno
));
1475 } else if (!strcasecmp(argv
[0],"databases") && argc
== 2) {
1476 server
.dbnum
= atoi(argv
[1]);
1477 if (server
.dbnum
< 1) {
1478 err
= "Invalid number of databases"; goto loaderr
;
1480 } else if (!strcasecmp(argv
[0],"maxclients") && argc
== 2) {
1481 server
.maxclients
= atoi(argv
[1]);
1482 } else if (!strcasecmp(argv
[0],"maxmemory") && argc
== 2) {
1483 server
.maxmemory
= strtoll(argv
[1], NULL
, 10);
1484 } else if (!strcasecmp(argv
[0],"slaveof") && argc
== 3) {
1485 server
.masterhost
= sdsnew(argv
[1]);
1486 server
.masterport
= atoi(argv
[2]);
1487 server
.replstate
= REDIS_REPL_CONNECT
;
1488 } else if (!strcasecmp(argv
[0],"masterauth") && argc
== 2) {
1489 server
.masterauth
= zstrdup(argv
[1]);
1490 } else if (!strcasecmp(argv
[0],"glueoutputbuf") && argc
== 2) {
1491 if ((server
.glueoutputbuf
= yesnotoi(argv
[1])) == -1) {
1492 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1494 } else if (!strcasecmp(argv
[0],"shareobjects") && argc
== 2) {
1495 if ((server
.shareobjects
= yesnotoi(argv
[1])) == -1) {
1496 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1498 } else if (!strcasecmp(argv
[0],"rdbcompression") && argc
== 2) {
1499 if ((server
.rdbcompression
= yesnotoi(argv
[1])) == -1) {
1500 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1502 } else if (!strcasecmp(argv
[0],"shareobjectspoolsize") && argc
== 2) {
1503 server
.sharingpoolsize
= atoi(argv
[1]);
1504 if (server
.sharingpoolsize
< 1) {
1505 err
= "invalid object sharing pool size"; goto loaderr
;
1507 } else if (!strcasecmp(argv
[0],"daemonize") && argc
== 2) {
1508 if ((server
.daemonize
= yesnotoi(argv
[1])) == -1) {
1509 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1511 } else if (!strcasecmp(argv
[0],"appendonly") && argc
== 2) {
1512 if ((server
.appendonly
= yesnotoi(argv
[1])) == -1) {
1513 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1515 } else if (!strcasecmp(argv
[0],"appendfsync") && argc
== 2) {
1516 if (!strcasecmp(argv
[1],"no")) {
1517 server
.appendfsync
= APPENDFSYNC_NO
;
1518 } else if (!strcasecmp(argv
[1],"always")) {
1519 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1520 } else if (!strcasecmp(argv
[1],"everysec")) {
1521 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1523 err
= "argument must be 'no', 'always' or 'everysec'";
1526 } else if (!strcasecmp(argv
[0],"requirepass") && argc
== 2) {
1527 server
.requirepass
= zstrdup(argv
[1]);
1528 } else if (!strcasecmp(argv
[0],"pidfile") && argc
== 2) {
1529 server
.pidfile
= zstrdup(argv
[1]);
1530 } else if (!strcasecmp(argv
[0],"dbfilename") && argc
== 2) {
1531 server
.dbfilename
= zstrdup(argv
[1]);
1532 } else if (!strcasecmp(argv
[0],"vm-enabled") && argc
== 2) {
1533 if ((server
.vm_enabled
= yesnotoi(argv
[1])) == -1) {
1534 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1536 } else if (!strcasecmp(argv
[0],"vm-max-memory") && argc
== 2) {
1537 server
.vm_max_memory
= strtoll(argv
[1], NULL
, 10);
1538 } else if (!strcasecmp(argv
[0],"vm-page-size") && argc
== 2) {
1539 server
.vm_page_size
= strtoll(argv
[1], NULL
, 10);
1540 } else if (!strcasecmp(argv
[0],"vm-pages") && argc
== 2) {
1541 server
.vm_pages
= strtoll(argv
[1], NULL
, 10);
1543 err
= "Bad directive or wrong number of arguments"; goto loaderr
;
1545 for (j
= 0; j
< argc
; j
++)
1550 if (fp
!= stdin
) fclose(fp
);
1554 fprintf(stderr
, "\n*** FATAL CONFIG FILE ERROR ***\n");
1555 fprintf(stderr
, "Reading the configuration file, at line %d\n", linenum
);
1556 fprintf(stderr
, ">>> '%s'\n", line
);
1557 fprintf(stderr
, "%s\n", err
);
1561 static void freeClientArgv(redisClient
*c
) {
1564 for (j
= 0; j
< c
->argc
; j
++)
1565 decrRefCount(c
->argv
[j
]);
1566 for (j
= 0; j
< c
->mbargc
; j
++)
1567 decrRefCount(c
->mbargv
[j
]);
1572 static void freeClient(redisClient
*c
) {
1575 /* Note that if the client we are freeing is blocked into a blocking
1576 * call, we have to set querybuf to NULL *before* to call unblockClient()
1577 * to avoid processInputBuffer() will get called. Also it is important
1578 * to remove the file events after this, because this call adds
1579 * the READABLE event. */
1580 sdsfree(c
->querybuf
);
1582 if (c
->flags
& REDIS_BLOCKED
)
1585 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
1586 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1587 listRelease(c
->reply
);
1590 ln
= listSearchKey(server
.clients
,c
);
1591 redisAssert(ln
!= NULL
);
1592 listDelNode(server
.clients
,ln
);
1593 if (c
->flags
& REDIS_SLAVE
) {
1594 if (c
->replstate
== REDIS_REPL_SEND_BULK
&& c
->repldbfd
!= -1)
1596 list
*l
= (c
->flags
& REDIS_MONITOR
) ? server
.monitors
: server
.slaves
;
1597 ln
= listSearchKey(l
,c
);
1598 redisAssert(ln
!= NULL
);
1601 if (c
->flags
& REDIS_MASTER
) {
1602 server
.master
= NULL
;
1603 server
.replstate
= REDIS_REPL_CONNECT
;
1607 freeClientMultiState(c
);
1611 #define GLUEREPLY_UP_TO (1024)
1612 static void glueReplyBuffersIfNeeded(redisClient
*c
) {
1614 char buf
[GLUEREPLY_UP_TO
];
1618 listRewind(c
->reply
);
1619 while((ln
= listYield(c
->reply
))) {
1623 objlen
= sdslen(o
->ptr
);
1624 if (copylen
+ objlen
<= GLUEREPLY_UP_TO
) {
1625 memcpy(buf
+copylen
,o
->ptr
,objlen
);
1627 listDelNode(c
->reply
,ln
);
1629 if (copylen
== 0) return;
1633 /* Now the output buffer is empty, add the new single element */
1634 o
= createObject(REDIS_STRING
,sdsnewlen(buf
,copylen
));
1635 listAddNodeHead(c
->reply
,o
);
1638 static void sendReplyToClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
1639 redisClient
*c
= privdata
;
1640 int nwritten
= 0, totwritten
= 0, objlen
;
1643 REDIS_NOTUSED(mask
);
1645 /* Use writev() if we have enough buffers to send */
1646 if (!server
.glueoutputbuf
&&
1647 listLength(c
->reply
) > REDIS_WRITEV_THRESHOLD
&&
1648 !(c
->flags
& REDIS_MASTER
))
1650 sendReplyToClientWritev(el
, fd
, privdata
, mask
);
1654 while(listLength(c
->reply
)) {
1655 if (server
.glueoutputbuf
&& listLength(c
->reply
) > 1)
1656 glueReplyBuffersIfNeeded(c
);
1658 o
= listNodeValue(listFirst(c
->reply
));
1659 objlen
= sdslen(o
->ptr
);
1662 listDelNode(c
->reply
,listFirst(c
->reply
));
1666 if (c
->flags
& REDIS_MASTER
) {
1667 /* Don't reply to a master */
1668 nwritten
= objlen
- c
->sentlen
;
1670 nwritten
= write(fd
, ((char*)o
->ptr
)+c
->sentlen
, objlen
- c
->sentlen
);
1671 if (nwritten
<= 0) break;
1673 c
->sentlen
+= nwritten
;
1674 totwritten
+= nwritten
;
1675 /* If we fully sent the object on head go to the next one */
1676 if (c
->sentlen
== objlen
) {
1677 listDelNode(c
->reply
,listFirst(c
->reply
));
1680 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
1681 * bytes, in a single threaded server it's a good idea to serve
1682 * other clients as well, even if a very large request comes from
1683 * super fast link that is always able to accept data (in real world
1684 * scenario think about 'KEYS *' against the loopback interfae) */
1685 if (totwritten
> REDIS_MAX_WRITE_PER_EVENT
) break;
1687 if (nwritten
== -1) {
1688 if (errno
== EAGAIN
) {
1691 redisLog(REDIS_VERBOSE
,
1692 "Error writing to client: %s", strerror(errno
));
1697 if (totwritten
> 0) c
->lastinteraction
= time(NULL
);
1698 if (listLength(c
->reply
) == 0) {
1700 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1704 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
)
1706 redisClient
*c
= privdata
;
1707 int nwritten
= 0, totwritten
= 0, objlen
, willwrite
;
1709 struct iovec iov
[REDIS_WRITEV_IOVEC_COUNT
];
1710 int offset
, ion
= 0;
1712 REDIS_NOTUSED(mask
);
1715 while (listLength(c
->reply
)) {
1716 offset
= c
->sentlen
;
1720 /* fill-in the iov[] array */
1721 for(node
= listFirst(c
->reply
); node
; node
= listNextNode(node
)) {
1722 o
= listNodeValue(node
);
1723 objlen
= sdslen(o
->ptr
);
1725 if (totwritten
+ objlen
- offset
> REDIS_MAX_WRITE_PER_EVENT
)
1728 if(ion
== REDIS_WRITEV_IOVEC_COUNT
)
1729 break; /* no more iovecs */
1731 iov
[ion
].iov_base
= ((char*)o
->ptr
) + offset
;
1732 iov
[ion
].iov_len
= objlen
- offset
;
1733 willwrite
+= objlen
- offset
;
1734 offset
= 0; /* just for the first item */
1741 /* write all collected blocks at once */
1742 if((nwritten
= writev(fd
, iov
, ion
)) < 0) {
1743 if (errno
!= EAGAIN
) {
1744 redisLog(REDIS_VERBOSE
,
1745 "Error writing to client: %s", strerror(errno
));
1752 totwritten
+= nwritten
;
1753 offset
= c
->sentlen
;
1755 /* remove written robjs from c->reply */
1756 while (nwritten
&& listLength(c
->reply
)) {
1757 o
= listNodeValue(listFirst(c
->reply
));
1758 objlen
= sdslen(o
->ptr
);
1760 if(nwritten
>= objlen
- offset
) {
1761 listDelNode(c
->reply
, listFirst(c
->reply
));
1762 nwritten
-= objlen
- offset
;
1766 c
->sentlen
+= nwritten
;
1774 c
->lastinteraction
= time(NULL
);
1776 if (listLength(c
->reply
) == 0) {
1778 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1782 static struct redisCommand
*lookupCommand(char *name
) {
1784 while(cmdTable
[j
].name
!= NULL
) {
1785 if (!strcasecmp(name
,cmdTable
[j
].name
)) return &cmdTable
[j
];
1791 /* resetClient prepare the client to process the next command */
1792 static void resetClient(redisClient
*c
) {
1798 /* Call() is the core of Redis execution of a command */
1799 static void call(redisClient
*c
, struct redisCommand
*cmd
) {
1802 dirty
= server
.dirty
;
1804 if (server
.appendonly
&& server
.dirty
-dirty
)
1805 feedAppendOnlyFile(cmd
,c
->db
->id
,c
->argv
,c
->argc
);
1806 if (server
.dirty
-dirty
&& listLength(server
.slaves
))
1807 replicationFeedSlaves(server
.slaves
,cmd
,c
->db
->id
,c
->argv
,c
->argc
);
1808 if (listLength(server
.monitors
))
1809 replicationFeedSlaves(server
.monitors
,cmd
,c
->db
->id
,c
->argv
,c
->argc
);
1810 server
.stat_numcommands
++;
1813 /* If this function gets called we already read a whole
1814 * command, argments are in the client argv/argc fields.
1815 * processCommand() execute the command or prepare the
1816 * server for a bulk read from the client.
1818 * If 1 is returned the client is still alive and valid and
1819 * and other operations can be performed by the caller. Otherwise
1820 * if 0 is returned the client was destroied (i.e. after QUIT). */
1821 static int processCommand(redisClient
*c
) {
1822 struct redisCommand
*cmd
;
1824 /* Free some memory if needed (maxmemory setting) */
1825 if (server
.maxmemory
) freeMemoryIfNeeded();
1827 /* Handle the multi bulk command type. This is an alternative protocol
1828 * supported by Redis in order to receive commands that are composed of
1829 * multiple binary-safe "bulk" arguments. The latency of processing is
1830 * a bit higher but this allows things like multi-sets, so if this
1831 * protocol is used only for MSET and similar commands this is a big win. */
1832 if (c
->multibulk
== 0 && c
->argc
== 1 && ((char*)(c
->argv
[0]->ptr
))[0] == '*') {
1833 c
->multibulk
= atoi(((char*)c
->argv
[0]->ptr
)+1);
1834 if (c
->multibulk
<= 0) {
1838 decrRefCount(c
->argv
[c
->argc
-1]);
1842 } else if (c
->multibulk
) {
1843 if (c
->bulklen
== -1) {
1844 if (((char*)c
->argv
[0]->ptr
)[0] != '$') {
1845 addReplySds(c
,sdsnew("-ERR multi bulk protocol error\r\n"));
1849 int bulklen
= atoi(((char*)c
->argv
[0]->ptr
)+1);
1850 decrRefCount(c
->argv
[0]);
1851 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
1853 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
1858 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
1862 c
->mbargv
= zrealloc(c
->mbargv
,(sizeof(robj
*))*(c
->mbargc
+1));
1863 c
->mbargv
[c
->mbargc
] = c
->argv
[0];
1867 if (c
->multibulk
== 0) {
1871 /* Here we need to swap the multi-bulk argc/argv with the
1872 * normal argc/argv of the client structure. */
1874 c
->argv
= c
->mbargv
;
1875 c
->mbargv
= auxargv
;
1878 c
->argc
= c
->mbargc
;
1879 c
->mbargc
= auxargc
;
1881 /* We need to set bulklen to something different than -1
1882 * in order for the code below to process the command without
1883 * to try to read the last argument of a bulk command as
1884 * a special argument. */
1886 /* continue below and process the command */
1893 /* -- end of multi bulk commands processing -- */
1895 /* The QUIT command is handled as a special case. Normal command
1896 * procs are unable to close the client connection safely */
1897 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
1901 cmd
= lookupCommand(c
->argv
[0]->ptr
);
1904 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
1905 (char*)c
->argv
[0]->ptr
));
1908 } else if ((cmd
->arity
> 0 && cmd
->arity
!= c
->argc
) ||
1909 (c
->argc
< -cmd
->arity
)) {
1911 sdscatprintf(sdsempty(),
1912 "-ERR wrong number of arguments for '%s' command\r\n",
1916 } else if (server
.maxmemory
&& cmd
->flags
& REDIS_CMD_DENYOOM
&& zmalloc_used_memory() > server
.maxmemory
) {
1917 addReplySds(c
,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
1920 } else if (cmd
->flags
& REDIS_CMD_BULK
&& c
->bulklen
== -1) {
1921 int bulklen
= atoi(c
->argv
[c
->argc
-1]->ptr
);
1923 decrRefCount(c
->argv
[c
->argc
-1]);
1924 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
1926 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
1931 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
1932 /* It is possible that the bulk read is already in the
1933 * buffer. Check this condition and handle it accordingly.
1934 * This is just a fast path, alternative to call processInputBuffer().
1935 * It's a good idea since the code is small and this condition
1936 * happens most of the times. */
1937 if ((signed)sdslen(c
->querybuf
) >= c
->bulklen
) {
1938 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
1940 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
1945 /* Let's try to share objects on the command arguments vector */
1946 if (server
.shareobjects
) {
1948 for(j
= 1; j
< c
->argc
; j
++)
1949 c
->argv
[j
] = tryObjectSharing(c
->argv
[j
]);
1951 /* Let's try to encode the bulk object to save space. */
1952 if (cmd
->flags
& REDIS_CMD_BULK
)
1953 tryObjectEncoding(c
->argv
[c
->argc
-1]);
1955 /* Check if the user is authenticated */
1956 if (server
.requirepass
&& !c
->authenticated
&& cmd
->proc
!= authCommand
) {
1957 addReplySds(c
,sdsnew("-ERR operation not permitted\r\n"));
1962 /* Exec the command */
1963 if (c
->flags
& REDIS_MULTI
&& cmd
->proc
!= execCommand
) {
1964 queueMultiCommand(c
,cmd
);
1965 addReply(c
,shared
.queued
);
1970 /* Prepare the client for the next command */
1971 if (c
->flags
& REDIS_CLOSE
) {
1979 static void replicationFeedSlaves(list
*slaves
, struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
1983 /* (args*2)+1 is enough room for args, spaces, newlines */
1984 robj
*static_outv
[REDIS_STATIC_ARGS
*2+1];
1986 if (argc
<= REDIS_STATIC_ARGS
) {
1989 outv
= zmalloc(sizeof(robj
*)*(argc
*2+1));
1992 for (j
= 0; j
< argc
; j
++) {
1993 if (j
!= 0) outv
[outc
++] = shared
.space
;
1994 if ((cmd
->flags
& REDIS_CMD_BULK
) && j
== argc
-1) {
1997 lenobj
= createObject(REDIS_STRING
,
1998 sdscatprintf(sdsempty(),"%lu\r\n",
1999 (unsigned long) stringObjectLen(argv
[j
])));
2000 lenobj
->refcount
= 0;
2001 outv
[outc
++] = lenobj
;
2003 outv
[outc
++] = argv
[j
];
2005 outv
[outc
++] = shared
.crlf
;
2007 /* Increment all the refcounts at start and decrement at end in order to
2008 * be sure to free objects if there is no slave in a replication state
2009 * able to be feed with commands */
2010 for (j
= 0; j
< outc
; j
++) incrRefCount(outv
[j
]);
2012 while((ln
= listYield(slaves
))) {
2013 redisClient
*slave
= ln
->value
;
2015 /* Don't feed slaves that are still waiting for BGSAVE to start */
2016 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) continue;
2018 /* Feed all the other slaves, MONITORs and so on */
2019 if (slave
->slaveseldb
!= dictid
) {
2023 case 0: selectcmd
= shared
.select0
; break;
2024 case 1: selectcmd
= shared
.select1
; break;
2025 case 2: selectcmd
= shared
.select2
; break;
2026 case 3: selectcmd
= shared
.select3
; break;
2027 case 4: selectcmd
= shared
.select4
; break;
2028 case 5: selectcmd
= shared
.select5
; break;
2029 case 6: selectcmd
= shared
.select6
; break;
2030 case 7: selectcmd
= shared
.select7
; break;
2031 case 8: selectcmd
= shared
.select8
; break;
2032 case 9: selectcmd
= shared
.select9
; break;
2034 selectcmd
= createObject(REDIS_STRING
,
2035 sdscatprintf(sdsempty(),"select %d\r\n",dictid
));
2036 selectcmd
->refcount
= 0;
2039 addReply(slave
,selectcmd
);
2040 slave
->slaveseldb
= dictid
;
2042 for (j
= 0; j
< outc
; j
++) addReply(slave
,outv
[j
]);
2044 for (j
= 0; j
< outc
; j
++) decrRefCount(outv
[j
]);
2045 if (outv
!= static_outv
) zfree(outv
);
2048 static void processInputBuffer(redisClient
*c
) {
2050 /* Before to process the input buffer, make sure the client is not
2051 * waitig for a blocking operation such as BLPOP. Note that the first
2052 * iteration the client is never blocked, otherwise the processInputBuffer
2053 * would not be called at all, but after the execution of the first commands
2054 * in the input buffer the client may be blocked, and the "goto again"
2055 * will try to reiterate. The following line will make it return asap. */
2056 if (c
->flags
& REDIS_BLOCKED
) return;
2057 if (c
->bulklen
== -1) {
2058 /* Read the first line of the query */
2059 char *p
= strchr(c
->querybuf
,'\n');
2066 query
= c
->querybuf
;
2067 c
->querybuf
= sdsempty();
2068 querylen
= 1+(p
-(query
));
2069 if (sdslen(query
) > querylen
) {
2070 /* leave data after the first line of the query in the buffer */
2071 c
->querybuf
= sdscatlen(c
->querybuf
,query
+querylen
,sdslen(query
)-querylen
);
2073 *p
= '\0'; /* remove "\n" */
2074 if (*(p
-1) == '\r') *(p
-1) = '\0'; /* and "\r" if any */
2075 sdsupdatelen(query
);
2077 /* Now we can split the query in arguments */
2078 argv
= sdssplitlen(query
,sdslen(query
)," ",1,&argc
);
2081 if (c
->argv
) zfree(c
->argv
);
2082 c
->argv
= zmalloc(sizeof(robj
*)*argc
);
2084 for (j
= 0; j
< argc
; j
++) {
2085 if (sdslen(argv
[j
])) {
2086 c
->argv
[c
->argc
] = createObject(REDIS_STRING
,argv
[j
]);
2094 /* Execute the command. If the client is still valid
2095 * after processCommand() return and there is something
2096 * on the query buffer try to process the next command. */
2097 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2099 /* Nothing to process, argc == 0. Just process the query
2100 * buffer if it's not empty or return to the caller */
2101 if (sdslen(c
->querybuf
)) goto again
;
2104 } else if (sdslen(c
->querybuf
) >= REDIS_REQUEST_MAX_SIZE
) {
2105 redisLog(REDIS_VERBOSE
, "Client protocol error");
2110 /* Bulk read handling. Note that if we are at this point
2111 the client already sent a command terminated with a newline,
2112 we are reading the bulk data that is actually the last
2113 argument of the command. */
2114 int qbl
= sdslen(c
->querybuf
);
2116 if (c
->bulklen
<= qbl
) {
2117 /* Copy everything but the final CRLF as final argument */
2118 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2120 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2121 /* Process the command. If the client is still valid after
2122 * the processing and there is more data in the buffer
2123 * try to parse it. */
2124 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2130 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2131 redisClient
*c
= (redisClient
*) privdata
;
2132 char buf
[REDIS_IOBUF_LEN
];
2135 REDIS_NOTUSED(mask
);
2137 nread
= read(fd
, buf
, REDIS_IOBUF_LEN
);
2139 if (errno
== EAGAIN
) {
2142 redisLog(REDIS_VERBOSE
, "Reading from client: %s",strerror(errno
));
2146 } else if (nread
== 0) {
2147 redisLog(REDIS_VERBOSE
, "Client closed connection");
2152 c
->querybuf
= sdscatlen(c
->querybuf
, buf
, nread
);
2153 c
->lastinteraction
= time(NULL
);
2157 processInputBuffer(c
);
2160 static int selectDb(redisClient
*c
, int id
) {
2161 if (id
< 0 || id
>= server
.dbnum
)
2163 c
->db
= &server
.db
[id
];
2167 static void *dupClientReplyValue(void *o
) {
2168 incrRefCount((robj
*)o
);
2172 static redisClient
*createClient(int fd
) {
2173 redisClient
*c
= zmalloc(sizeof(*c
));
2175 anetNonBlock(NULL
,fd
);
2176 anetTcpNoDelay(NULL
,fd
);
2177 if (!c
) return NULL
;
2180 c
->querybuf
= sdsempty();
2189 c
->lastinteraction
= time(NULL
);
2190 c
->authenticated
= 0;
2191 c
->replstate
= REDIS_REPL_NONE
;
2192 c
->reply
= listCreate();
2193 c
->blockingkeys
= NULL
;
2194 c
->blockingkeysnum
= 0;
2195 listSetFreeMethod(c
->reply
,decrRefCount
);
2196 listSetDupMethod(c
->reply
,dupClientReplyValue
);
2197 if (aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
2198 readQueryFromClient
, c
) == AE_ERR
) {
2202 listAddNodeTail(server
.clients
,c
);
2203 initClientMultiState(c
);
2207 static void addReply(redisClient
*c
, robj
*obj
) {
2208 if (listLength(c
->reply
) == 0 &&
2209 (c
->replstate
== REDIS_REPL_NONE
||
2210 c
->replstate
== REDIS_REPL_ONLINE
) &&
2211 aeCreateFileEvent(server
.el
, c
->fd
, AE_WRITABLE
,
2212 sendReplyToClient
, c
) == AE_ERR
) return;
2214 if (server
.vm_enabled
&& obj
->storage
!= REDIS_VM_MEMORY
) {
2215 obj
= dupStringObject(obj
);
2216 obj
->refcount
= 0; /* getDecodedObject() will increment the refcount */
2218 listAddNodeTail(c
->reply
,getDecodedObject(obj
));
2221 static void addReplySds(redisClient
*c
, sds s
) {
2222 robj
*o
= createObject(REDIS_STRING
,s
);
2227 static void addReplyDouble(redisClient
*c
, double d
) {
2230 snprintf(buf
,sizeof(buf
),"%.17g",d
);
2231 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2232 (unsigned long) strlen(buf
),buf
));
2235 static void addReplyBulkLen(redisClient
*c
, robj
*obj
) {
2238 if (obj
->encoding
== REDIS_ENCODING_RAW
) {
2239 len
= sdslen(obj
->ptr
);
2241 long n
= (long)obj
->ptr
;
2243 /* Compute how many bytes will take this integer as a radix 10 string */
2249 while((n
= n
/10) != 0) {
2253 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",(unsigned long)len
));
2256 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2261 REDIS_NOTUSED(mask
);
2262 REDIS_NOTUSED(privdata
);
2264 cfd
= anetAccept(server
.neterr
, fd
, cip
, &cport
);
2265 if (cfd
== AE_ERR
) {
2266 redisLog(REDIS_VERBOSE
,"Accepting client connection: %s", server
.neterr
);
2269 redisLog(REDIS_VERBOSE
,"Accepted %s:%d", cip
, cport
);
2270 if ((c
= createClient(cfd
)) == NULL
) {
2271 redisLog(REDIS_WARNING
,"Error allocating resoures for the client");
2272 close(cfd
); /* May be already closed, just ingore errors */
2275 /* If maxclient directive is set and this is one client more... close the
2276 * connection. Note that we create the client instead to check before
2277 * for this condition, since now the socket is already set in nonblocking
2278 * mode and we can send an error for free using the Kernel I/O */
2279 if (server
.maxclients
&& listLength(server
.clients
) > server
.maxclients
) {
2280 char *err
= "-ERR max number of clients reached\r\n";
2282 /* That's a best effort error message, don't check write errors */
2283 if (write(c
->fd
,err
,strlen(err
)) == -1) {
2284 /* Nothing to do, Just to avoid the warning... */
2289 server
.stat_numconnections
++;
2292 /* ======================= Redis objects implementation ===================== */
2294 static robj
*createObject(int type
, void *ptr
) {
2297 if (listLength(server
.objfreelist
)) {
2298 listNode
*head
= listFirst(server
.objfreelist
);
2299 o
= listNodeValue(head
);
2300 listDelNode(server
.objfreelist
,head
);
2302 if (server
.vm_enabled
) {
2303 o
= zmalloc(sizeof(*o
));
2305 o
= zmalloc(sizeof(*o
)-sizeof(struct redisObjectVM
));
2309 o
->encoding
= REDIS_ENCODING_RAW
;
2312 if (server
.vm_enabled
) {
2313 o
->vm
.atime
= server
.unixtime
;
2314 o
->storage
= REDIS_VM_MEMORY
;
2319 static robj
*createStringObject(char *ptr
, size_t len
) {
2320 return createObject(REDIS_STRING
,sdsnewlen(ptr
,len
));
2323 static robj
*dupStringObject(robj
*o
) {
2324 return createStringObject(o
->ptr
,sdslen(o
->ptr
));
2327 static robj
*createListObject(void) {
2328 list
*l
= listCreate();
2330 listSetFreeMethod(l
,decrRefCount
);
2331 return createObject(REDIS_LIST
,l
);
2334 static robj
*createSetObject(void) {
2335 dict
*d
= dictCreate(&setDictType
,NULL
);
2336 return createObject(REDIS_SET
,d
);
2339 static robj
*createZsetObject(void) {
2340 zset
*zs
= zmalloc(sizeof(*zs
));
2342 zs
->dict
= dictCreate(&zsetDictType
,NULL
);
2343 zs
->zsl
= zslCreate();
2344 return createObject(REDIS_ZSET
,zs
);
2347 static void freeStringObject(robj
*o
) {
2348 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2353 static void freeListObject(robj
*o
) {
2354 listRelease((list
*) o
->ptr
);
2357 static void freeSetObject(robj
*o
) {
2358 dictRelease((dict
*) o
->ptr
);
2361 static void freeZsetObject(robj
*o
) {
2364 dictRelease(zs
->dict
);
2369 static void freeHashObject(robj
*o
) {
2370 dictRelease((dict
*) o
->ptr
);
2373 static void incrRefCount(robj
*o
) {
2374 redisAssert(!server
.vm_enabled
|| o
->storage
== REDIS_VM_MEMORY
);
2378 static void decrRefCount(void *obj
) {
2381 /* REDIS_VM_SWAPPED */
2382 if (server
.vm_enabled
&& o
->storage
== REDIS_VM_SWAPPED
) {
2383 redisAssert(o
->refcount
== 1);
2384 redisAssert(o
->type
== REDIS_STRING
);
2385 freeStringObject(o
);
2386 vmMarkPagesFree(o
->vm
.page
,o
->vm
.usedpages
);
2387 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2388 !listAddNodeHead(server
.objfreelist
,o
))
2390 server
.vm_stats_swapped_objects
--;
2393 /* REDIS_VM_MEMORY */
2394 if (--(o
->refcount
) == 0) {
2396 case REDIS_STRING
: freeStringObject(o
); break;
2397 case REDIS_LIST
: freeListObject(o
); break;
2398 case REDIS_SET
: freeSetObject(o
); break;
2399 case REDIS_ZSET
: freeZsetObject(o
); break;
2400 case REDIS_HASH
: freeHashObject(o
); break;
2401 default: redisAssert(0 != 0); break;
2403 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2404 !listAddNodeHead(server
.objfreelist
,o
))
2409 static robj
*lookupKey(redisDb
*db
, robj
*key
) {
2410 dictEntry
*de
= dictFind(db
->dict
,key
);
2412 robj
*key
= dictGetEntryKey(de
);
2413 robj
*val
= dictGetEntryVal(de
);
2415 if (server
.vm_enabled
) {
2416 if (key
->storage
== REDIS_VM_MEMORY
) {
2417 /* Update the access time of the key for the aging algorithm. */
2418 key
->vm
.atime
= server
.unixtime
;
2420 /* Our value was swapped on disk. Bring it at home. */
2421 redisAssert(val
== NULL
);
2422 val
= vmLoadObject(key
);
2423 dictGetEntryVal(de
) = val
;
2432 static robj
*lookupKeyRead(redisDb
*db
, robj
*key
) {
2433 expireIfNeeded(db
,key
);
2434 return lookupKey(db
,key
);
2437 static robj
*lookupKeyWrite(redisDb
*db
, robj
*key
) {
2438 deleteIfVolatile(db
,key
);
2439 return lookupKey(db
,key
);
2442 static int deleteKey(redisDb
*db
, robj
*key
) {
2445 /* We need to protect key from destruction: after the first dictDelete()
2446 * it may happen that 'key' is no longer valid if we don't increment
2447 * it's count. This may happen when we get the object reference directly
2448 * from the hash table with dictRandomKey() or dict iterators */
2450 if (dictSize(db
->expires
)) dictDelete(db
->expires
,key
);
2451 retval
= dictDelete(db
->dict
,key
);
2454 return retval
== DICT_OK
;
2457 /* Try to share an object against the shared objects pool */
2458 static robj
*tryObjectSharing(robj
*o
) {
2459 struct dictEntry
*de
;
2462 if (o
== NULL
|| server
.shareobjects
== 0) return o
;
2464 redisAssert(o
->type
== REDIS_STRING
);
2465 de
= dictFind(server
.sharingpool
,o
);
2467 robj
*shared
= dictGetEntryKey(de
);
2469 c
= ((unsigned long) dictGetEntryVal(de
))+1;
2470 dictGetEntryVal(de
) = (void*) c
;
2471 incrRefCount(shared
);
2475 /* Here we are using a stream algorihtm: Every time an object is
2476 * shared we increment its count, everytime there is a miss we
2477 * recrement the counter of a random object. If this object reaches
2478 * zero we remove the object and put the current object instead. */
2479 if (dictSize(server
.sharingpool
) >=
2480 server
.sharingpoolsize
) {
2481 de
= dictGetRandomKey(server
.sharingpool
);
2482 redisAssert(de
!= NULL
);
2483 c
= ((unsigned long) dictGetEntryVal(de
))-1;
2484 dictGetEntryVal(de
) = (void*) c
;
2486 dictDelete(server
.sharingpool
,de
->key
);
2489 c
= 0; /* If the pool is empty we want to add this object */
2494 retval
= dictAdd(server
.sharingpool
,o
,(void*)1);
2495 redisAssert(retval
== DICT_OK
);
2502 /* Check if the nul-terminated string 's' can be represented by a long
2503 * (that is, is a number that fits into long without any other space or
2504 * character before or after the digits).
2506 * If so, the function returns REDIS_OK and *longval is set to the value
2507 * of the number. Otherwise REDIS_ERR is returned */
2508 static int isStringRepresentableAsLong(sds s
, long *longval
) {
2509 char buf
[32], *endptr
;
2513 value
= strtol(s
, &endptr
, 10);
2514 if (endptr
[0] != '\0') return REDIS_ERR
;
2515 slen
= snprintf(buf
,32,"%ld",value
);
2517 /* If the number converted back into a string is not identical
2518 * then it's not possible to encode the string as integer */
2519 if (sdslen(s
) != (unsigned)slen
|| memcmp(buf
,s
,slen
)) return REDIS_ERR
;
2520 if (longval
) *longval
= value
;
2524 /* Try to encode a string object in order to save space */
2525 static int tryObjectEncoding(robj
*o
) {
2529 if (o
->encoding
!= REDIS_ENCODING_RAW
)
2530 return REDIS_ERR
; /* Already encoded */
2532 /* It's not save to encode shared objects: shared objects can be shared
2533 * everywhere in the "object space" of Redis. Encoded objects can only
2534 * appear as "values" (and not, for instance, as keys) */
2535 if (o
->refcount
> 1) return REDIS_ERR
;
2537 /* Currently we try to encode only strings */
2538 redisAssert(o
->type
== REDIS_STRING
);
2540 /* Check if we can represent this string as a long integer */
2541 if (isStringRepresentableAsLong(s
,&value
) == REDIS_ERR
) return REDIS_ERR
;
2543 /* Ok, this object can be encoded */
2544 o
->encoding
= REDIS_ENCODING_INT
;
2546 o
->ptr
= (void*) value
;
2550 /* Get a decoded version of an encoded object (returned as a new object).
2551 * If the object is already raw-encoded just increment the ref count. */
2552 static robj
*getDecodedObject(robj
*o
) {
2555 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2559 if (o
->type
== REDIS_STRING
&& o
->encoding
== REDIS_ENCODING_INT
) {
2562 snprintf(buf
,32,"%ld",(long)o
->ptr
);
2563 dec
= createStringObject(buf
,strlen(buf
));
2566 redisAssert(1 != 1);
2570 /* Compare two string objects via strcmp() or alike.
2571 * Note that the objects may be integer-encoded. In such a case we
2572 * use snprintf() to get a string representation of the numbers on the stack
2573 * and compare the strings, it's much faster than calling getDecodedObject().
2575 * Important note: if objects are not integer encoded, but binary-safe strings,
2576 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
2578 static int compareStringObjects(robj
*a
, robj
*b
) {
2579 redisAssert(a
->type
== REDIS_STRING
&& b
->type
== REDIS_STRING
);
2580 char bufa
[128], bufb
[128], *astr
, *bstr
;
2583 if (a
== b
) return 0;
2584 if (a
->encoding
!= REDIS_ENCODING_RAW
) {
2585 snprintf(bufa
,sizeof(bufa
),"%ld",(long) a
->ptr
);
2591 if (b
->encoding
!= REDIS_ENCODING_RAW
) {
2592 snprintf(bufb
,sizeof(bufb
),"%ld",(long) b
->ptr
);
2598 return bothsds
? sdscmp(astr
,bstr
) : strcmp(astr
,bstr
);
2601 static size_t stringObjectLen(robj
*o
) {
2602 redisAssert(o
->type
== REDIS_STRING
);
2603 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2604 return sdslen(o
->ptr
);
2608 return snprintf(buf
,32,"%ld",(long)o
->ptr
);
2612 /*============================ RDB saving/loading =========================== */
2614 static int rdbSaveType(FILE *fp
, unsigned char type
) {
2615 if (fwrite(&type
,1,1,fp
) == 0) return -1;
2619 static int rdbSaveTime(FILE *fp
, time_t t
) {
2620 int32_t t32
= (int32_t) t
;
2621 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
2625 /* check rdbLoadLen() comments for more info */
2626 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
2627 unsigned char buf
[2];
2630 /* Save a 6 bit len */
2631 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
2632 if (fwrite(buf
,1,1,fp
) == 0) return -1;
2633 } else if (len
< (1<<14)) {
2634 /* Save a 14 bit len */
2635 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
2637 if (fwrite(buf
,2,1,fp
) == 0) return -1;
2639 /* Save a 32 bit len */
2640 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
2641 if (fwrite(buf
,1,1,fp
) == 0) return -1;
2643 if (fwrite(&len
,4,1,fp
) == 0) return -1;
2648 /* String objects in the form "2391" "-100" without any space and with a
2649 * range of values that can fit in an 8, 16 or 32 bit signed value can be
2650 * encoded as integers to save space */
2651 static int rdbTryIntegerEncoding(sds s
, unsigned char *enc
) {
2653 char *endptr
, buf
[32];
2655 /* Check if it's possible to encode this value as a number */
2656 value
= strtoll(s
, &endptr
, 10);
2657 if (endptr
[0] != '\0') return 0;
2658 snprintf(buf
,32,"%lld",value
);
2660 /* If the number converted back into a string is not identical
2661 * then it's not possible to encode the string as integer */
2662 if (strlen(buf
) != sdslen(s
) || memcmp(buf
,s
,sdslen(s
))) return 0;
2664 /* Finally check if it fits in our ranges */
2665 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
2666 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
2667 enc
[1] = value
&0xFF;
2669 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
2670 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
2671 enc
[1] = value
&0xFF;
2672 enc
[2] = (value
>>8)&0xFF;
2674 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
2675 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
2676 enc
[1] = value
&0xFF;
2677 enc
[2] = (value
>>8)&0xFF;
2678 enc
[3] = (value
>>16)&0xFF;
2679 enc
[4] = (value
>>24)&0xFF;
2686 static int rdbSaveLzfStringObject(FILE *fp
, robj
*obj
) {
2687 unsigned int comprlen
, outlen
;
2691 /* We require at least four bytes compression for this to be worth it */
2692 outlen
= sdslen(obj
->ptr
)-4;
2693 if (outlen
<= 0) return 0;
2694 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
2695 comprlen
= lzf_compress(obj
->ptr
, sdslen(obj
->ptr
), out
, outlen
);
2696 if (comprlen
== 0) {
2700 /* Data compressed! Let's save it on disk */
2701 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
2702 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
2703 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
2704 if (rdbSaveLen(fp
,sdslen(obj
->ptr
)) == -1) goto writeerr
;
2705 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
2714 /* Save a string objet as [len][data] on disk. If the object is a string
2715 * representation of an integer value we try to safe it in a special form */
2716 static int rdbSaveStringObjectRaw(FILE *fp
, robj
*obj
) {
2720 len
= sdslen(obj
->ptr
);
2722 /* Try integer encoding */
2724 unsigned char buf
[5];
2725 if ((enclen
= rdbTryIntegerEncoding(obj
->ptr
,buf
)) > 0) {
2726 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
2731 /* Try LZF compression - under 20 bytes it's unable to compress even
2732 * aaaaaaaaaaaaaaaaaa so skip it */
2733 if (server
.rdbcompression
&& len
> 20) {
2736 retval
= rdbSaveLzfStringObject(fp
,obj
);
2737 if (retval
== -1) return -1;
2738 if (retval
> 0) return 0;
2739 /* retval == 0 means data can't be compressed, save the old way */
2742 /* Store verbatim */
2743 if (rdbSaveLen(fp
,len
) == -1) return -1;
2744 if (len
&& fwrite(obj
->ptr
,len
,1,fp
) == 0) return -1;
2748 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
2749 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
2752 obj
= getDecodedObject(obj
);
2753 retval
= rdbSaveStringObjectRaw(fp
,obj
);
2758 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
2759 * 8 bit integer specifing the length of the representation.
2760 * This 8 bit integer has special values in order to specify the following
2766 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
2767 unsigned char buf
[128];
2773 } else if (!isfinite(val
)) {
2775 buf
[0] = (val
< 0) ? 255 : 254;
2777 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
2778 buf
[0] = strlen((char*)buf
+1);
2781 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
2785 /* Save a Redis object. */
2786 static int rdbSaveObject(FILE *fp
, robj
*o
) {
2787 if (o
->type
== REDIS_STRING
) {
2788 /* Save a string value */
2789 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
2790 } else if (o
->type
== REDIS_LIST
) {
2791 /* Save a list value */
2792 list
*list
= o
->ptr
;
2796 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
2797 while((ln
= listYield(list
))) {
2798 robj
*eleobj
= listNodeValue(ln
);
2800 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
2802 } else if (o
->type
== REDIS_SET
) {
2803 /* Save a set value */
2805 dictIterator
*di
= dictGetIterator(set
);
2808 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
2809 while((de
= dictNext(di
)) != NULL
) {
2810 robj
*eleobj
= dictGetEntryKey(de
);
2812 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
2814 dictReleaseIterator(di
);
2815 } else if (o
->type
== REDIS_ZSET
) {
2816 /* Save a set value */
2818 dictIterator
*di
= dictGetIterator(zs
->dict
);
2821 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
2822 while((de
= dictNext(di
)) != NULL
) {
2823 robj
*eleobj
= dictGetEntryKey(de
);
2824 double *score
= dictGetEntryVal(de
);
2826 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
2827 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
2829 dictReleaseIterator(di
);
2831 redisAssert(0 != 0);
2836 /* Return the length the object will have on disk if saved with
2837 * the rdbSaveObject() function. Currently we use a trick to get
2838 * this length with very little changes to the code. In the future
2839 * we could switch to a faster solution. */
2840 static off_t
rdbSavedObjectLen(robj
*o
) {
2841 static FILE *fp
= NULL
;
2843 if (fp
== NULL
) fp
= fopen("/dev/null","w");
2847 assert(rdbSaveObject(fp
,o
) != 1);
2851 /* Return the number of pages required to save this object in the swap file */
2852 static off_t
rdbSavedObjectPages(robj
*o
) {
2853 off_t bytes
= rdbSavedObjectLen(o
);
2855 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
2858 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
2859 static int rdbSave(char *filename
) {
2860 dictIterator
*di
= NULL
;
2865 time_t now
= time(NULL
);
2867 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
2868 fp
= fopen(tmpfile
,"w");
2870 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
2873 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
2874 for (j
= 0; j
< server
.dbnum
; j
++) {
2875 redisDb
*db
= server
.db
+j
;
2877 if (dictSize(d
) == 0) continue;
2878 di
= dictGetIterator(d
);
2884 /* Write the SELECT DB opcode */
2885 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
2886 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
2888 /* Iterate this DB writing every entry */
2889 while((de
= dictNext(di
)) != NULL
) {
2890 robj
*key
= dictGetEntryKey(de
);
2891 robj
*o
= dictGetEntryVal(de
);
2892 time_t expiretime
= getExpire(db
,key
);
2894 /* Save the expire time */
2895 if (expiretime
!= -1) {
2896 /* If this key is already expired skip it */
2897 if (expiretime
< now
) continue;
2898 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
2899 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
2901 /* Save the key and associated value. This requires special
2902 * handling if the value is swapped out. */
2903 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
) {
2904 /* Save type, key, value */
2905 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
2906 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
2907 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
2910 /* Get a preview of the object in memory */
2911 po
= vmPreviewObject(key
);
2912 /* Also duplicate the key object, to pass around a standard
2914 newkey
= dupStringObject(key
);
2915 /* Save type, key, value */
2916 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
2917 if (rdbSaveStringObject(fp
,newkey
) == -1) goto werr
;
2918 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
2919 /* Remove the loaded object from memory */
2921 decrRefCount(newkey
);
2924 dictReleaseIterator(di
);
2927 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
2929 /* Make sure data will not remain on the OS's output buffers */
2934 /* Use RENAME to make sure the DB file is changed atomically only
2935 * if the generate DB file is ok. */
2936 if (rename(tmpfile
,filename
) == -1) {
2937 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
2941 redisLog(REDIS_NOTICE
,"DB saved on disk");
2943 server
.lastsave
= time(NULL
);
2949 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
2950 if (di
) dictReleaseIterator(di
);
2954 static int rdbSaveBackground(char *filename
) {
2957 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
2958 if ((childpid
= fork()) == 0) {
2961 if (rdbSave(filename
) == REDIS_OK
) {
2968 if (childpid
== -1) {
2969 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
2973 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
2974 server
.bgsavechildpid
= childpid
;
2977 return REDIS_OK
; /* unreached */
2980 static void rdbRemoveTempFile(pid_t childpid
) {
2983 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
2987 static int rdbLoadType(FILE *fp
) {
2989 if (fread(&type
,1,1,fp
) == 0) return -1;
2993 static time_t rdbLoadTime(FILE *fp
) {
2995 if (fread(&t32
,4,1,fp
) == 0) return -1;
2996 return (time_t) t32
;
2999 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3000 * of this file for a description of how this are stored on disk.
3002 * isencoded is set to 1 if the readed length is not actually a length but
3003 * an "encoding type", check the above comments for more info */
3004 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3005 unsigned char buf
[2];
3009 if (isencoded
) *isencoded
= 0;
3010 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3011 type
= (buf
[0]&0xC0)>>6;
3012 if (type
== REDIS_RDB_6BITLEN
) {
3013 /* Read a 6 bit len */
3015 } else if (type
== REDIS_RDB_ENCVAL
) {
3016 /* Read a 6 bit len encoding type */
3017 if (isencoded
) *isencoded
= 1;
3019 } else if (type
== REDIS_RDB_14BITLEN
) {
3020 /* Read a 14 bit len */
3021 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3022 return ((buf
[0]&0x3F)<<8)|buf
[1];
3024 /* Read a 32 bit len */
3025 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3030 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
) {
3031 unsigned char enc
[4];
3034 if (enctype
== REDIS_RDB_ENC_INT8
) {
3035 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3036 val
= (signed char)enc
[0];
3037 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3039 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3040 v
= enc
[0]|(enc
[1]<<8);
3042 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3044 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3045 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3048 val
= 0; /* anti-warning */
3051 return createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",val
));
3054 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3055 unsigned int len
, clen
;
3056 unsigned char *c
= NULL
;
3059 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3060 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3061 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3062 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3063 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3064 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3066 return createObject(REDIS_STRING
,val
);
3073 static robj
*rdbLoadStringObject(FILE*fp
) {
3078 len
= rdbLoadLen(fp
,&isencoded
);
3081 case REDIS_RDB_ENC_INT8
:
3082 case REDIS_RDB_ENC_INT16
:
3083 case REDIS_RDB_ENC_INT32
:
3084 return tryObjectSharing(rdbLoadIntegerObject(fp
,len
));
3085 case REDIS_RDB_ENC_LZF
:
3086 return tryObjectSharing(rdbLoadLzfStringObject(fp
));
3092 if (len
== REDIS_RDB_LENERR
) return NULL
;
3093 val
= sdsnewlen(NULL
,len
);
3094 if (len
&& fread(val
,len
,1,fp
) == 0) {
3098 return tryObjectSharing(createObject(REDIS_STRING
,val
));
3101 /* For information about double serialization check rdbSaveDoubleValue() */
3102 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
3106 if (fread(&len
,1,1,fp
) == 0) return -1;
3108 case 255: *val
= R_NegInf
; return 0;
3109 case 254: *val
= R_PosInf
; return 0;
3110 case 253: *val
= R_Nan
; return 0;
3112 if (fread(buf
,len
,1,fp
) == 0) return -1;
3114 sscanf(buf
, "%lg", val
);
3119 /* Load a Redis object of the specified type from the specified file.
3120 * On success a newly allocated object is returned, otherwise NULL. */
3121 static robj
*rdbLoadObject(int type
, FILE *fp
) {
3124 if (type
== REDIS_STRING
) {
3125 /* Read string value */
3126 if ((o
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3127 tryObjectEncoding(o
);
3128 } else if (type
== REDIS_LIST
|| type
== REDIS_SET
) {
3129 /* Read list/set value */
3132 if ((listlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3133 o
= (type
== REDIS_LIST
) ? createListObject() : createSetObject();
3134 /* Load every single element of the list/set */
3138 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3139 tryObjectEncoding(ele
);
3140 if (type
== REDIS_LIST
) {
3141 listAddNodeTail((list
*)o
->ptr
,ele
);
3143 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
3146 } else if (type
== REDIS_ZSET
) {
3147 /* Read list/set value */
3151 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3152 o
= createZsetObject();
3154 /* Load every single element of the list/set */
3157 double *score
= zmalloc(sizeof(double));
3159 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3160 tryObjectEncoding(ele
);
3161 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
3162 dictAdd(zs
->dict
,ele
,score
);
3163 zslInsert(zs
->zsl
,*score
,ele
);
3164 incrRefCount(ele
); /* added to skiplist */
3167 redisAssert(0 != 0);
3172 static int rdbLoad(char *filename
) {
3174 robj
*keyobj
= NULL
;
3176 int type
, retval
, rdbver
;
3177 dict
*d
= server
.db
[0].dict
;
3178 redisDb
*db
= server
.db
+0;
3180 time_t expiretime
= -1, now
= time(NULL
);
3182 fp
= fopen(filename
,"r");
3183 if (!fp
) return REDIS_ERR
;
3184 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
3186 if (memcmp(buf
,"REDIS",5) != 0) {
3188 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
3191 rdbver
= atoi(buf
+5);
3194 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
3201 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3202 if (type
== REDIS_EXPIRETIME
) {
3203 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
3204 /* We read the time so we need to read the object type again */
3205 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3207 if (type
== REDIS_EOF
) break;
3208 /* Handle SELECT DB opcode as a special case */
3209 if (type
== REDIS_SELECTDB
) {
3210 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
3212 if (dbid
>= (unsigned)server
.dbnum
) {
3213 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
3216 db
= server
.db
+dbid
;
3221 if ((keyobj
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
3223 if ((o
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
3224 /* Add the new object in the hash table */
3225 retval
= dictAdd(d
,keyobj
,o
);
3226 if (retval
== DICT_ERR
) {
3227 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", keyobj
->ptr
);
3230 /* Set the expire time if needed */
3231 if (expiretime
!= -1) {
3232 setExpire(db
,keyobj
,expiretime
);
3233 /* Delete this key if already expired */
3234 if (expiretime
< now
) deleteKey(db
,keyobj
);
3242 eoferr
: /* unexpected end of file is handled here with a fatal exit */
3243 if (keyobj
) decrRefCount(keyobj
);
3244 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
3246 return REDIS_ERR
; /* Just to avoid warning */
3249 /*================================== Commands =============================== */
3251 static void authCommand(redisClient
*c
) {
3252 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
3253 c
->authenticated
= 1;
3254 addReply(c
,shared
.ok
);
3256 c
->authenticated
= 0;
3257 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
3261 static void pingCommand(redisClient
*c
) {
3262 addReply(c
,shared
.pong
);
3265 static void echoCommand(redisClient
*c
) {
3266 addReplyBulkLen(c
,c
->argv
[1]);
3267 addReply(c
,c
->argv
[1]);
3268 addReply(c
,shared
.crlf
);
3271 /*=================================== Strings =============================== */
3273 static void setGenericCommand(redisClient
*c
, int nx
) {
3276 if (nx
) deleteIfVolatile(c
->db
,c
->argv
[1]);
3277 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3278 if (retval
== DICT_ERR
) {
3280 /* If the key is about a swapped value, we want a new key object
3281 * to overwrite the old. So we delete the old key in the database.
3282 * This will also make sure that swap pages about the old object
3283 * will be marked as free. */
3284 if (deleteIfSwapped(c
->db
,c
->argv
[1]))
3285 incrRefCount(c
->argv
[1]);
3286 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3287 incrRefCount(c
->argv
[2]);
3289 addReply(c
,shared
.czero
);
3293 incrRefCount(c
->argv
[1]);
3294 incrRefCount(c
->argv
[2]);
3297 removeExpire(c
->db
,c
->argv
[1]);
3298 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3301 static void setCommand(redisClient
*c
) {
3302 setGenericCommand(c
,0);
3305 static void setnxCommand(redisClient
*c
) {
3306 setGenericCommand(c
,1);
3309 static int getGenericCommand(redisClient
*c
) {
3310 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[1]);
3313 addReply(c
,shared
.nullbulk
);
3316 if (o
->type
!= REDIS_STRING
) {
3317 addReply(c
,shared
.wrongtypeerr
);
3320 addReplyBulkLen(c
,o
);
3322 addReply(c
,shared
.crlf
);
3328 static void getCommand(redisClient
*c
) {
3329 getGenericCommand(c
);
3332 static void getsetCommand(redisClient
*c
) {
3333 if (getGenericCommand(c
) == REDIS_ERR
) return;
3334 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
3335 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3337 incrRefCount(c
->argv
[1]);
3339 incrRefCount(c
->argv
[2]);
3341 removeExpire(c
->db
,c
->argv
[1]);
3344 static void mgetCommand(redisClient
*c
) {
3347 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
3348 for (j
= 1; j
< c
->argc
; j
++) {
3349 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
3351 addReply(c
,shared
.nullbulk
);
3353 if (o
->type
!= REDIS_STRING
) {
3354 addReply(c
,shared
.nullbulk
);
3356 addReplyBulkLen(c
,o
);
3358 addReply(c
,shared
.crlf
);
3364 static void msetGenericCommand(redisClient
*c
, int nx
) {
3365 int j
, busykeys
= 0;
3367 if ((c
->argc
% 2) == 0) {
3368 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
3371 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
3372 * set nothing at all if at least one already key exists. */
3374 for (j
= 1; j
< c
->argc
; j
+= 2) {
3375 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
3381 addReply(c
, shared
.czero
);
3385 for (j
= 1; j
< c
->argc
; j
+= 2) {
3388 tryObjectEncoding(c
->argv
[j
+1]);
3389 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3390 if (retval
== DICT_ERR
) {
3391 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3392 incrRefCount(c
->argv
[j
+1]);
3394 incrRefCount(c
->argv
[j
]);
3395 incrRefCount(c
->argv
[j
+1]);
3397 removeExpire(c
->db
,c
->argv
[j
]);
3399 server
.dirty
+= (c
->argc
-1)/2;
3400 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3403 static void msetCommand(redisClient
*c
) {
3404 msetGenericCommand(c
,0);
3407 static void msetnxCommand(redisClient
*c
) {
3408 msetGenericCommand(c
,1);
3411 static void incrDecrCommand(redisClient
*c
, long long incr
) {
3416 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3420 if (o
->type
!= REDIS_STRING
) {
3425 if (o
->encoding
== REDIS_ENCODING_RAW
)
3426 value
= strtoll(o
->ptr
, &eptr
, 10);
3427 else if (o
->encoding
== REDIS_ENCODING_INT
)
3428 value
= (long)o
->ptr
;
3430 redisAssert(1 != 1);
3435 o
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
3436 tryObjectEncoding(o
);
3437 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
3438 if (retval
== DICT_ERR
) {
3439 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
3440 removeExpire(c
->db
,c
->argv
[1]);
3442 incrRefCount(c
->argv
[1]);
3445 addReply(c
,shared
.colon
);
3447 addReply(c
,shared
.crlf
);
3450 static void incrCommand(redisClient
*c
) {
3451 incrDecrCommand(c
,1);
3454 static void decrCommand(redisClient
*c
) {
3455 incrDecrCommand(c
,-1);
3458 static void incrbyCommand(redisClient
*c
) {
3459 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
3460 incrDecrCommand(c
,incr
);
3463 static void decrbyCommand(redisClient
*c
) {
3464 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
3465 incrDecrCommand(c
,-incr
);
3468 /* ========================= Type agnostic commands ========================= */
3470 static void delCommand(redisClient
*c
) {
3473 for (j
= 1; j
< c
->argc
; j
++) {
3474 if (deleteKey(c
->db
,c
->argv
[j
])) {
3481 addReply(c
,shared
.czero
);
3484 addReply(c
,shared
.cone
);
3487 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",deleted
));
3492 static void existsCommand(redisClient
*c
) {
3493 addReply(c
,lookupKeyRead(c
->db
,c
->argv
[1]) ? shared
.cone
: shared
.czero
);
3496 static void selectCommand(redisClient
*c
) {
3497 int id
= atoi(c
->argv
[1]->ptr
);
3499 if (selectDb(c
,id
) == REDIS_ERR
) {
3500 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
3502 addReply(c
,shared
.ok
);
3506 static void randomkeyCommand(redisClient
*c
) {
3510 de
= dictGetRandomKey(c
->db
->dict
);
3511 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
3514 addReply(c
,shared
.plus
);
3515 addReply(c
,shared
.crlf
);
3517 addReply(c
,shared
.plus
);
3518 addReply(c
,dictGetEntryKey(de
));
3519 addReply(c
,shared
.crlf
);
3523 static void keysCommand(redisClient
*c
) {
3526 sds pattern
= c
->argv
[1]->ptr
;
3527 int plen
= sdslen(pattern
);
3528 unsigned long numkeys
= 0, keyslen
= 0;
3529 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
3531 di
= dictGetIterator(c
->db
->dict
);
3533 decrRefCount(lenobj
);
3534 while((de
= dictNext(di
)) != NULL
) {
3535 robj
*keyobj
= dictGetEntryKey(de
);
3537 sds key
= keyobj
->ptr
;
3538 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
3539 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
3540 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
3542 addReply(c
,shared
.space
);
3545 keyslen
+= sdslen(key
);
3549 dictReleaseIterator(di
);
3550 lenobj
->ptr
= sdscatprintf(sdsempty(),"$%lu\r\n",keyslen
+(numkeys
? (numkeys
-1) : 0));
3551 addReply(c
,shared
.crlf
);
3554 static void dbsizeCommand(redisClient
*c
) {
3556 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
3559 static void lastsaveCommand(redisClient
*c
) {
3561 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
3564 static void typeCommand(redisClient
*c
) {
3568 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
3573 case REDIS_STRING
: type
= "+string"; break;
3574 case REDIS_LIST
: type
= "+list"; break;
3575 case REDIS_SET
: type
= "+set"; break;
3576 case REDIS_ZSET
: type
= "+zset"; break;
3577 default: type
= "unknown"; break;
3580 addReplySds(c
,sdsnew(type
));
3581 addReply(c
,shared
.crlf
);
3584 static void saveCommand(redisClient
*c
) {
3585 if (server
.bgsavechildpid
!= -1) {
3586 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
3589 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
3590 addReply(c
,shared
.ok
);
3592 addReply(c
,shared
.err
);
3596 static void bgsaveCommand(redisClient
*c
) {
3597 if (server
.bgsavechildpid
!= -1) {
3598 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
3601 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
3602 char *status
= "+Background saving started\r\n";
3603 addReplySds(c
,sdsnew(status
));
3605 addReply(c
,shared
.err
);
3609 static void shutdownCommand(redisClient
*c
) {
3610 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
3611 /* Kill the saving child if there is a background saving in progress.
3612 We want to avoid race conditions, for instance our saving child may
3613 overwrite the synchronous saving did by SHUTDOWN. */
3614 if (server
.bgsavechildpid
!= -1) {
3615 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
3616 kill(server
.bgsavechildpid
,SIGKILL
);
3617 rdbRemoveTempFile(server
.bgsavechildpid
);
3619 if (server
.appendonly
) {
3620 /* Append only file: fsync() the AOF and exit */
3621 fsync(server
.appendfd
);
3624 /* Snapshotting. Perform a SYNC SAVE and exit */
3625 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
3626 if (server
.daemonize
)
3627 unlink(server
.pidfile
);
3628 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
3629 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
3632 /* Ooops.. error saving! The best we can do is to continue operating.
3633 * Note that if there was a background saving process, in the next
3634 * cron() Redis will be notified that the background saving aborted,
3635 * handling special stuff like slaves pending for synchronization... */
3636 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
3637 addReplySds(c
,sdsnew("-ERR can't quit, problems saving the DB\r\n"));
3642 static void renameGenericCommand(redisClient
*c
, int nx
) {
3645 /* To use the same key as src and dst is probably an error */
3646 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
3647 addReply(c
,shared
.sameobjecterr
);
3651 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3653 addReply(c
,shared
.nokeyerr
);
3657 deleteIfVolatile(c
->db
,c
->argv
[2]);
3658 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
3661 addReply(c
,shared
.czero
);
3664 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
3666 incrRefCount(c
->argv
[2]);
3668 deleteKey(c
->db
,c
->argv
[1]);
3670 addReply(c
,nx
? shared
.cone
: shared
.ok
);
3673 static void renameCommand(redisClient
*c
) {
3674 renameGenericCommand(c
,0);
3677 static void renamenxCommand(redisClient
*c
) {
3678 renameGenericCommand(c
,1);
3681 static void moveCommand(redisClient
*c
) {
3686 /* Obtain source and target DB pointers */
3689 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
3690 addReply(c
,shared
.outofrangeerr
);
3694 selectDb(c
,srcid
); /* Back to the source DB */
3696 /* If the user is moving using as target the same
3697 * DB as the source DB it is probably an error. */
3699 addReply(c
,shared
.sameobjecterr
);
3703 /* Check if the element exists and get a reference */
3704 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3706 addReply(c
,shared
.czero
);
3710 /* Try to add the element to the target DB */
3711 deleteIfVolatile(dst
,c
->argv
[1]);
3712 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
3713 addReply(c
,shared
.czero
);
3716 incrRefCount(c
->argv
[1]);
3719 /* OK! key moved, free the entry in the source DB */
3720 deleteKey(src
,c
->argv
[1]);
3722 addReply(c
,shared
.cone
);
3725 /* =================================== Lists ================================ */
3726 static void pushGenericCommand(redisClient
*c
, int where
) {
3730 lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3732 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
3733 addReply(c
,shared
.ok
);
3736 lobj
= createListObject();
3738 if (where
== REDIS_HEAD
) {
3739 listAddNodeHead(list
,c
->argv
[2]);
3741 listAddNodeTail(list
,c
->argv
[2]);
3743 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
3744 incrRefCount(c
->argv
[1]);
3745 incrRefCount(c
->argv
[2]);
3747 if (lobj
->type
!= REDIS_LIST
) {
3748 addReply(c
,shared
.wrongtypeerr
);
3751 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
3752 addReply(c
,shared
.ok
);
3756 if (where
== REDIS_HEAD
) {
3757 listAddNodeHead(list
,c
->argv
[2]);
3759 listAddNodeTail(list
,c
->argv
[2]);
3761 incrRefCount(c
->argv
[2]);
3764 addReply(c
,shared
.ok
);
3767 static void lpushCommand(redisClient
*c
) {
3768 pushGenericCommand(c
,REDIS_HEAD
);
3771 static void rpushCommand(redisClient
*c
) {
3772 pushGenericCommand(c
,REDIS_TAIL
);
3775 static void llenCommand(redisClient
*c
) {
3779 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
3781 addReply(c
,shared
.czero
);
3784 if (o
->type
!= REDIS_LIST
) {
3785 addReply(c
,shared
.wrongtypeerr
);
3788 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",listLength(l
)));
3793 static void lindexCommand(redisClient
*c
) {
3795 int index
= atoi(c
->argv
[2]->ptr
);
3797 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
3799 addReply(c
,shared
.nullbulk
);
3801 if (o
->type
!= REDIS_LIST
) {
3802 addReply(c
,shared
.wrongtypeerr
);
3804 list
*list
= o
->ptr
;
3807 ln
= listIndex(list
, index
);
3809 addReply(c
,shared
.nullbulk
);
3811 robj
*ele
= listNodeValue(ln
);
3812 addReplyBulkLen(c
,ele
);
3814 addReply(c
,shared
.crlf
);
3820 static void lsetCommand(redisClient
*c
) {
3822 int index
= atoi(c
->argv
[2]->ptr
);
3824 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3826 addReply(c
,shared
.nokeyerr
);
3828 if (o
->type
!= REDIS_LIST
) {
3829 addReply(c
,shared
.wrongtypeerr
);
3831 list
*list
= o
->ptr
;
3834 ln
= listIndex(list
, index
);
3836 addReply(c
,shared
.outofrangeerr
);
3838 robj
*ele
= listNodeValue(ln
);
3841 listNodeValue(ln
) = c
->argv
[3];
3842 incrRefCount(c
->argv
[3]);
3843 addReply(c
,shared
.ok
);
3850 static void popGenericCommand(redisClient
*c
, int where
) {
3853 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3855 addReply(c
,shared
.nullbulk
);
3857 if (o
->type
!= REDIS_LIST
) {
3858 addReply(c
,shared
.wrongtypeerr
);
3860 list
*list
= o
->ptr
;
3863 if (where
== REDIS_HEAD
)
3864 ln
= listFirst(list
);
3866 ln
= listLast(list
);
3869 addReply(c
,shared
.nullbulk
);
3871 robj
*ele
= listNodeValue(ln
);
3872 addReplyBulkLen(c
,ele
);
3874 addReply(c
,shared
.crlf
);
3875 listDelNode(list
,ln
);
3882 static void lpopCommand(redisClient
*c
) {
3883 popGenericCommand(c
,REDIS_HEAD
);
3886 static void rpopCommand(redisClient
*c
) {
3887 popGenericCommand(c
,REDIS_TAIL
);
3890 static void lrangeCommand(redisClient
*c
) {
3892 int start
= atoi(c
->argv
[2]->ptr
);
3893 int end
= atoi(c
->argv
[3]->ptr
);
3895 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
3897 addReply(c
,shared
.nullmultibulk
);
3899 if (o
->type
!= REDIS_LIST
) {
3900 addReply(c
,shared
.wrongtypeerr
);
3902 list
*list
= o
->ptr
;
3904 int llen
= listLength(list
);
3908 /* convert negative indexes */
3909 if (start
< 0) start
= llen
+start
;
3910 if (end
< 0) end
= llen
+end
;
3911 if (start
< 0) start
= 0;
3912 if (end
< 0) end
= 0;
3914 /* indexes sanity checks */
3915 if (start
> end
|| start
>= llen
) {
3916 /* Out of range start or start > end result in empty list */
3917 addReply(c
,shared
.emptymultibulk
);
3920 if (end
>= llen
) end
= llen
-1;
3921 rangelen
= (end
-start
)+1;
3923 /* Return the result in form of a multi-bulk reply */
3924 ln
= listIndex(list
, start
);
3925 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
3926 for (j
= 0; j
< rangelen
; j
++) {
3927 ele
= listNodeValue(ln
);
3928 addReplyBulkLen(c
,ele
);
3930 addReply(c
,shared
.crlf
);
3937 static void ltrimCommand(redisClient
*c
) {
3939 int start
= atoi(c
->argv
[2]->ptr
);
3940 int end
= atoi(c
->argv
[3]->ptr
);
3942 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3944 addReply(c
,shared
.ok
);
3946 if (o
->type
!= REDIS_LIST
) {
3947 addReply(c
,shared
.wrongtypeerr
);
3949 list
*list
= o
->ptr
;
3951 int llen
= listLength(list
);
3952 int j
, ltrim
, rtrim
;
3954 /* convert negative indexes */
3955 if (start
< 0) start
= llen
+start
;
3956 if (end
< 0) end
= llen
+end
;
3957 if (start
< 0) start
= 0;
3958 if (end
< 0) end
= 0;
3960 /* indexes sanity checks */
3961 if (start
> end
|| start
>= llen
) {
3962 /* Out of range start or start > end result in empty list */
3966 if (end
>= llen
) end
= llen
-1;
3971 /* Remove list elements to perform the trim */
3972 for (j
= 0; j
< ltrim
; j
++) {
3973 ln
= listFirst(list
);
3974 listDelNode(list
,ln
);
3976 for (j
= 0; j
< rtrim
; j
++) {
3977 ln
= listLast(list
);
3978 listDelNode(list
,ln
);
3981 addReply(c
,shared
.ok
);
3986 static void lremCommand(redisClient
*c
) {
3989 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3991 addReply(c
,shared
.czero
);
3993 if (o
->type
!= REDIS_LIST
) {
3994 addReply(c
,shared
.wrongtypeerr
);
3996 list
*list
= o
->ptr
;
3997 listNode
*ln
, *next
;
3998 int toremove
= atoi(c
->argv
[2]->ptr
);
4003 toremove
= -toremove
;
4006 ln
= fromtail
? list
->tail
: list
->head
;
4008 robj
*ele
= listNodeValue(ln
);
4010 next
= fromtail
? ln
->prev
: ln
->next
;
4011 if (compareStringObjects(ele
,c
->argv
[3]) == 0) {
4012 listDelNode(list
,ln
);
4015 if (toremove
&& removed
== toremove
) break;
4019 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
4024 /* This is the semantic of this command:
4025 * RPOPLPUSH srclist dstlist:
4026 * IF LLEN(srclist) > 0
4027 * element = RPOP srclist
4028 * LPUSH dstlist element
4035 * The idea is to be able to get an element from a list in a reliable way
4036 * since the element is not just returned but pushed against another list
4037 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4039 static void rpoplpushcommand(redisClient
*c
) {
4042 sobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4044 addReply(c
,shared
.nullbulk
);
4046 if (sobj
->type
!= REDIS_LIST
) {
4047 addReply(c
,shared
.wrongtypeerr
);
4049 list
*srclist
= sobj
->ptr
;
4050 listNode
*ln
= listLast(srclist
);
4053 addReply(c
,shared
.nullbulk
);
4055 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4056 robj
*ele
= listNodeValue(ln
);
4059 if (dobj
&& dobj
->type
!= REDIS_LIST
) {
4060 addReply(c
,shared
.wrongtypeerr
);
4064 /* Add the element to the target list (unless it's directly
4065 * passed to some BLPOP-ing client */
4066 if (!handleClientsWaitingListPush(c
,c
->argv
[2],ele
)) {
4068 /* Create the list if the key does not exist */
4069 dobj
= createListObject();
4070 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
4071 incrRefCount(c
->argv
[2]);
4073 dstlist
= dobj
->ptr
;
4074 listAddNodeHead(dstlist
,ele
);
4078 /* Send the element to the client as reply as well */
4079 addReplyBulkLen(c
,ele
);
4081 addReply(c
,shared
.crlf
);
4083 /* Finally remove the element from the source list */
4084 listDelNode(srclist
,ln
);
4092 /* ==================================== Sets ================================ */
4094 static void saddCommand(redisClient
*c
) {
4097 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4099 set
= createSetObject();
4100 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
4101 incrRefCount(c
->argv
[1]);
4103 if (set
->type
!= REDIS_SET
) {
4104 addReply(c
,shared
.wrongtypeerr
);
4108 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
4109 incrRefCount(c
->argv
[2]);
4111 addReply(c
,shared
.cone
);
4113 addReply(c
,shared
.czero
);
4117 static void sremCommand(redisClient
*c
) {
4120 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4122 addReply(c
,shared
.czero
);
4124 if (set
->type
!= REDIS_SET
) {
4125 addReply(c
,shared
.wrongtypeerr
);
4128 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
4130 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4131 addReply(c
,shared
.cone
);
4133 addReply(c
,shared
.czero
);
4138 static void smoveCommand(redisClient
*c
) {
4139 robj
*srcset
, *dstset
;
4141 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4142 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4144 /* If the source key does not exist return 0, if it's of the wrong type
4146 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
4147 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
4150 /* Error if the destination key is not a set as well */
4151 if (dstset
&& dstset
->type
!= REDIS_SET
) {
4152 addReply(c
,shared
.wrongtypeerr
);
4155 /* Remove the element from the source set */
4156 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
4157 /* Key not found in the src set! return zero */
4158 addReply(c
,shared
.czero
);
4162 /* Add the element to the destination set */
4164 dstset
= createSetObject();
4165 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
4166 incrRefCount(c
->argv
[2]);
4168 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
4169 incrRefCount(c
->argv
[3]);
4170 addReply(c
,shared
.cone
);
4173 static void sismemberCommand(redisClient
*c
) {
4176 set
= lookupKeyRead(c
->db
,c
->argv
[1]);
4178 addReply(c
,shared
.czero
);
4180 if (set
->type
!= REDIS_SET
) {
4181 addReply(c
,shared
.wrongtypeerr
);
4184 if (dictFind(set
->ptr
,c
->argv
[2]))
4185 addReply(c
,shared
.cone
);
4187 addReply(c
,shared
.czero
);
4191 static void scardCommand(redisClient
*c
) {
4195 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4197 addReply(c
,shared
.czero
);
4200 if (o
->type
!= REDIS_SET
) {
4201 addReply(c
,shared
.wrongtypeerr
);
4204 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4210 static void spopCommand(redisClient
*c
) {
4214 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4216 addReply(c
,shared
.nullbulk
);
4218 if (set
->type
!= REDIS_SET
) {
4219 addReply(c
,shared
.wrongtypeerr
);
4222 de
= dictGetRandomKey(set
->ptr
);
4224 addReply(c
,shared
.nullbulk
);
4226 robj
*ele
= dictGetEntryKey(de
);
4228 addReplyBulkLen(c
,ele
);
4230 addReply(c
,shared
.crlf
);
4231 dictDelete(set
->ptr
,ele
);
4232 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4238 static void srandmemberCommand(redisClient
*c
) {
4242 set
= lookupKeyRead(c
->db
,c
->argv
[1]);
4244 addReply(c
,shared
.nullbulk
);
4246 if (set
->type
!= REDIS_SET
) {
4247 addReply(c
,shared
.wrongtypeerr
);
4250 de
= dictGetRandomKey(set
->ptr
);
4252 addReply(c
,shared
.nullbulk
);
4254 robj
*ele
= dictGetEntryKey(de
);
4256 addReplyBulkLen(c
,ele
);
4258 addReply(c
,shared
.crlf
);
4263 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
4264 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
4266 return dictSize(*d1
)-dictSize(*d2
);
4269 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
4270 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4273 robj
*lenobj
= NULL
, *dstset
= NULL
;
4274 unsigned long j
, cardinality
= 0;
4276 for (j
= 0; j
< setsnum
; j
++) {
4280 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4281 lookupKeyRead(c
->db
,setskeys
[j
]);
4285 if (deleteKey(c
->db
,dstkey
))
4287 addReply(c
,shared
.czero
);
4289 addReply(c
,shared
.nullmultibulk
);
4293 if (setobj
->type
!= REDIS_SET
) {
4295 addReply(c
,shared
.wrongtypeerr
);
4298 dv
[j
] = setobj
->ptr
;
4300 /* Sort sets from the smallest to largest, this will improve our
4301 * algorithm's performace */
4302 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
4304 /* The first thing we should output is the total number of elements...
4305 * since this is a multi-bulk write, but at this stage we don't know
4306 * the intersection set size, so we use a trick, append an empty object
4307 * to the output list and save the pointer to later modify it with the
4310 lenobj
= createObject(REDIS_STRING
,NULL
);
4312 decrRefCount(lenobj
);
4314 /* If we have a target key where to store the resulting set
4315 * create this key with an empty set inside */
4316 dstset
= createSetObject();
4319 /* Iterate all the elements of the first (smallest) set, and test
4320 * the element against all the other sets, if at least one set does
4321 * not include the element it is discarded */
4322 di
= dictGetIterator(dv
[0]);
4324 while((de
= dictNext(di
)) != NULL
) {
4327 for (j
= 1; j
< setsnum
; j
++)
4328 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
4330 continue; /* at least one set does not contain the member */
4331 ele
= dictGetEntryKey(de
);
4333 addReplyBulkLen(c
,ele
);
4335 addReply(c
,shared
.crlf
);
4338 dictAdd(dstset
->ptr
,ele
,NULL
);
4342 dictReleaseIterator(di
);
4345 /* Store the resulting set into the target */
4346 deleteKey(c
->db
,dstkey
);
4347 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4348 incrRefCount(dstkey
);
4352 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
4354 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4355 dictSize((dict
*)dstset
->ptr
)));
4361 static void sinterCommand(redisClient
*c
) {
4362 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
4365 static void sinterstoreCommand(redisClient
*c
) {
4366 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
4369 #define REDIS_OP_UNION 0
4370 #define REDIS_OP_DIFF 1
4372 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
4373 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4376 robj
*dstset
= NULL
;
4377 int j
, cardinality
= 0;
4379 for (j
= 0; j
< setsnum
; j
++) {
4383 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4384 lookupKeyRead(c
->db
,setskeys
[j
]);
4389 if (setobj
->type
!= REDIS_SET
) {
4391 addReply(c
,shared
.wrongtypeerr
);
4394 dv
[j
] = setobj
->ptr
;
4397 /* We need a temp set object to store our union. If the dstkey
4398 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
4399 * this set object will be the resulting object to set into the target key*/
4400 dstset
= createSetObject();
4402 /* Iterate all the elements of all the sets, add every element a single
4403 * time to the result set */
4404 for (j
= 0; j
< setsnum
; j
++) {
4405 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
4406 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
4408 di
= dictGetIterator(dv
[j
]);
4410 while((de
= dictNext(di
)) != NULL
) {
4413 /* dictAdd will not add the same element multiple times */
4414 ele
= dictGetEntryKey(de
);
4415 if (op
== REDIS_OP_UNION
|| j
== 0) {
4416 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
4420 } else if (op
== REDIS_OP_DIFF
) {
4421 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
4426 dictReleaseIterator(di
);
4428 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break; /* result set is empty */
4431 /* Output the content of the resulting set, if not in STORE mode */
4433 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
4434 di
= dictGetIterator(dstset
->ptr
);
4435 while((de
= dictNext(di
)) != NULL
) {
4438 ele
= dictGetEntryKey(de
);
4439 addReplyBulkLen(c
,ele
);
4441 addReply(c
,shared
.crlf
);
4443 dictReleaseIterator(di
);
4445 /* If we have a target key where to store the resulting set
4446 * create this key with the result set inside */
4447 deleteKey(c
->db
,dstkey
);
4448 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4449 incrRefCount(dstkey
);
4454 decrRefCount(dstset
);
4456 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4457 dictSize((dict
*)dstset
->ptr
)));
4463 static void sunionCommand(redisClient
*c
) {
4464 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
4467 static void sunionstoreCommand(redisClient
*c
) {
4468 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
4471 static void sdiffCommand(redisClient
*c
) {
4472 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
4475 static void sdiffstoreCommand(redisClient
*c
) {
4476 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
4479 /* ==================================== ZSets =============================== */
4481 /* ZSETs are ordered sets using two data structures to hold the same elements
4482 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
4485 * The elements are added to an hash table mapping Redis objects to scores.
4486 * At the same time the elements are added to a skip list mapping scores
4487 * to Redis objects (so objects are sorted by scores in this "view"). */
4489 /* This skiplist implementation is almost a C translation of the original
4490 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
4491 * Alternative to Balanced Trees", modified in three ways:
4492 * a) this implementation allows for repeated values.
4493 * b) the comparison is not just by key (our 'score') but by satellite data.
4494 * c) there is a back pointer, so it's a doubly linked list with the back
4495 * pointers being only at "level 1". This allows to traverse the list
4496 * from tail to head, useful for ZREVRANGE. */
4498 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
4499 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
4501 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
4507 static zskiplist
*zslCreate(void) {
4511 zsl
= zmalloc(sizeof(*zsl
));
4514 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
4515 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++)
4516 zsl
->header
->forward
[j
] = NULL
;
4517 zsl
->header
->backward
= NULL
;
4522 static void zslFreeNode(zskiplistNode
*node
) {
4523 decrRefCount(node
->obj
);
4524 zfree(node
->forward
);
4528 static void zslFree(zskiplist
*zsl
) {
4529 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
4531 zfree(zsl
->header
->forward
);
4534 next
= node
->forward
[0];
4541 static int zslRandomLevel(void) {
4543 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
4548 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
4549 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
4553 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4554 while (x
->forward
[i
] &&
4555 (x
->forward
[i
]->score
< score
||
4556 (x
->forward
[i
]->score
== score
&&
4557 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
4561 /* we assume the key is not already inside, since we allow duplicated
4562 * scores, and the re-insertion of score and redis object should never
4563 * happpen since the caller of zslInsert() should test in the hash table
4564 * if the element is already inside or not. */
4565 level
= zslRandomLevel();
4566 if (level
> zsl
->level
) {
4567 for (i
= zsl
->level
; i
< level
; i
++)
4568 update
[i
] = zsl
->header
;
4571 x
= zslCreateNode(level
,score
,obj
);
4572 for (i
= 0; i
< level
; i
++) {
4573 x
->forward
[i
] = update
[i
]->forward
[i
];
4574 update
[i
]->forward
[i
] = x
;
4576 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
4578 x
->forward
[0]->backward
= x
;
4584 /* Delete an element with matching score/object from the skiplist. */
4585 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
4586 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
4590 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4591 while (x
->forward
[i
] &&
4592 (x
->forward
[i
]->score
< score
||
4593 (x
->forward
[i
]->score
== score
&&
4594 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
4598 /* We may have multiple elements with the same score, what we need
4599 * is to find the element with both the right score and object. */
4601 if (x
&& score
== x
->score
&& compareStringObjects(x
->obj
,obj
) == 0) {
4602 for (i
= 0; i
< zsl
->level
; i
++) {
4603 if (update
[i
]->forward
[i
] != x
) break;
4604 update
[i
]->forward
[i
] = x
->forward
[i
];
4606 if (x
->forward
[0]) {
4607 x
->forward
[0]->backward
= (x
->backward
== zsl
->header
) ?
4610 zsl
->tail
= x
->backward
;
4613 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
4618 return 0; /* not found */
4620 return 0; /* not found */
4623 /* Delete all the elements with score between min and max from the skiplist.
4624 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
4625 * Note that this function takes the reference to the hash table view of the
4626 * sorted set, in order to remove the elements from the hash table too. */
4627 static unsigned long zslDeleteRange(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
4628 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
4629 unsigned long removed
= 0;
4633 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4634 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
4638 /* We may have multiple elements with the same score, what we need
4639 * is to find the element with both the right score and object. */
4641 while (x
&& x
->score
<= max
) {
4642 zskiplistNode
*next
;
4644 for (i
= 0; i
< zsl
->level
; i
++) {
4645 if (update
[i
]->forward
[i
] != x
) break;
4646 update
[i
]->forward
[i
] = x
->forward
[i
];
4648 if (x
->forward
[0]) {
4649 x
->forward
[0]->backward
= (x
->backward
== zsl
->header
) ?
4652 zsl
->tail
= x
->backward
;
4654 next
= x
->forward
[0];
4655 dictDelete(dict
,x
->obj
);
4657 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
4663 return removed
; /* not found */
4666 /* Find the first node having a score equal or greater than the specified one.
4667 * Returns NULL if there is no match. */
4668 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
4673 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4674 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
4677 /* We may have multiple elements with the same score, what we need
4678 * is to find the element with both the right score and object. */
4679 return x
->forward
[0];
4682 /* The actual Z-commands implementations */
4684 /* This generic command implements both ZADD and ZINCRBY.
4685 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
4686 * the increment if the operation is a ZINCRBY (doincrement == 1). */
4687 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
4692 zsetobj
= lookupKeyWrite(c
->db
,key
);
4693 if (zsetobj
== NULL
) {
4694 zsetobj
= createZsetObject();
4695 dictAdd(c
->db
->dict
,key
,zsetobj
);
4698 if (zsetobj
->type
!= REDIS_ZSET
) {
4699 addReply(c
,shared
.wrongtypeerr
);
4705 /* Ok now since we implement both ZADD and ZINCRBY here the code
4706 * needs to handle the two different conditions. It's all about setting
4707 * '*score', that is, the new score to set, to the right value. */
4708 score
= zmalloc(sizeof(double));
4712 /* Read the old score. If the element was not present starts from 0 */
4713 de
= dictFind(zs
->dict
,ele
);
4715 double *oldscore
= dictGetEntryVal(de
);
4716 *score
= *oldscore
+ scoreval
;
4724 /* What follows is a simple remove and re-insert operation that is common
4725 * to both ZADD and ZINCRBY... */
4726 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
4727 /* case 1: New element */
4728 incrRefCount(ele
); /* added to hash */
4729 zslInsert(zs
->zsl
,*score
,ele
);
4730 incrRefCount(ele
); /* added to skiplist */
4733 addReplyDouble(c
,*score
);
4735 addReply(c
,shared
.cone
);
4740 /* case 2: Score update operation */
4741 de
= dictFind(zs
->dict
,ele
);
4742 redisAssert(de
!= NULL
);
4743 oldscore
= dictGetEntryVal(de
);
4744 if (*score
!= *oldscore
) {
4747 /* Remove and insert the element in the skip list with new score */
4748 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
4749 redisAssert(deleted
!= 0);
4750 zslInsert(zs
->zsl
,*score
,ele
);
4752 /* Update the score in the hash table */
4753 dictReplace(zs
->dict
,ele
,score
);
4759 addReplyDouble(c
,*score
);
4761 addReply(c
,shared
.czero
);
4765 static void zaddCommand(redisClient
*c
) {
4768 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
4769 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
4772 static void zincrbyCommand(redisClient
*c
) {
4775 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
4776 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
4779 static void zremCommand(redisClient
*c
) {
4783 zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4784 if (zsetobj
== NULL
) {
4785 addReply(c
,shared
.czero
);
4791 if (zsetobj
->type
!= REDIS_ZSET
) {
4792 addReply(c
,shared
.wrongtypeerr
);
4796 de
= dictFind(zs
->dict
,c
->argv
[2]);
4798 addReply(c
,shared
.czero
);
4801 /* Delete from the skiplist */
4802 oldscore
= dictGetEntryVal(de
);
4803 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
4804 redisAssert(deleted
!= 0);
4806 /* Delete from the hash table */
4807 dictDelete(zs
->dict
,c
->argv
[2]);
4808 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
4810 addReply(c
,shared
.cone
);
4814 static void zremrangebyscoreCommand(redisClient
*c
) {
4815 double min
= strtod(c
->argv
[2]->ptr
,NULL
);
4816 double max
= strtod(c
->argv
[3]->ptr
,NULL
);
4820 zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4821 if (zsetobj
== NULL
) {
4822 addReply(c
,shared
.czero
);
4826 if (zsetobj
->type
!= REDIS_ZSET
) {
4827 addReply(c
,shared
.wrongtypeerr
);
4831 deleted
= zslDeleteRange(zs
->zsl
,min
,max
,zs
->dict
);
4832 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
4833 server
.dirty
+= deleted
;
4834 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",deleted
));
4838 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
4840 int start
= atoi(c
->argv
[2]->ptr
);
4841 int end
= atoi(c
->argv
[3]->ptr
);
4844 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
4846 } else if (c
->argc
>= 5) {
4847 addReply(c
,shared
.syntaxerr
);
4851 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4853 addReply(c
,shared
.nullmultibulk
);
4855 if (o
->type
!= REDIS_ZSET
) {
4856 addReply(c
,shared
.wrongtypeerr
);
4858 zset
*zsetobj
= o
->ptr
;
4859 zskiplist
*zsl
= zsetobj
->zsl
;
4862 int llen
= zsl
->length
;
4866 /* convert negative indexes */
4867 if (start
< 0) start
= llen
+start
;
4868 if (end
< 0) end
= llen
+end
;
4869 if (start
< 0) start
= 0;
4870 if (end
< 0) end
= 0;
4872 /* indexes sanity checks */
4873 if (start
> end
|| start
>= llen
) {
4874 /* Out of range start or start > end result in empty list */
4875 addReply(c
,shared
.emptymultibulk
);
4878 if (end
>= llen
) end
= llen
-1;
4879 rangelen
= (end
-start
)+1;
4881 /* Return the result in form of a multi-bulk reply */
4887 ln
= zsl
->header
->forward
[0];
4889 ln
= ln
->forward
[0];
4892 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
4893 withscores
? (rangelen
*2) : rangelen
));
4894 for (j
= 0; j
< rangelen
; j
++) {
4896 addReplyBulkLen(c
,ele
);
4898 addReply(c
,shared
.crlf
);
4900 addReplyDouble(c
,ln
->score
);
4901 ln
= reverse
? ln
->backward
: ln
->forward
[0];
4907 static void zrangeCommand(redisClient
*c
) {
4908 zrangeGenericCommand(c
,0);
4911 static void zrevrangeCommand(redisClient
*c
) {
4912 zrangeGenericCommand(c
,1);
4915 static void zrangebyscoreCommand(redisClient
*c
) {
4917 double min
= strtod(c
->argv
[2]->ptr
,NULL
);
4918 double max
= strtod(c
->argv
[3]->ptr
,NULL
);
4919 int offset
= 0, limit
= -1;
4921 if (c
->argc
!= 4 && c
->argc
!= 7) {
4923 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
4925 } else if (c
->argc
== 7 && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
4926 addReply(c
,shared
.syntaxerr
);
4928 } else if (c
->argc
== 7) {
4929 offset
= atoi(c
->argv
[5]->ptr
);
4930 limit
= atoi(c
->argv
[6]->ptr
);
4931 if (offset
< 0) offset
= 0;
4934 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4936 addReply(c
,shared
.nullmultibulk
);
4938 if (o
->type
!= REDIS_ZSET
) {
4939 addReply(c
,shared
.wrongtypeerr
);
4941 zset
*zsetobj
= o
->ptr
;
4942 zskiplist
*zsl
= zsetobj
->zsl
;
4945 unsigned int rangelen
= 0;
4947 /* Get the first node with the score >= min */
4948 ln
= zslFirstWithScore(zsl
,min
);
4950 /* No element matching the speciifed interval */
4951 addReply(c
,shared
.emptymultibulk
);
4955 /* We don't know in advance how many matching elements there
4956 * are in the list, so we push this object that will represent
4957 * the multi-bulk length in the output buffer, and will "fix"
4959 lenobj
= createObject(REDIS_STRING
,NULL
);
4961 decrRefCount(lenobj
);
4963 while(ln
&& ln
->score
<= max
) {
4966 ln
= ln
->forward
[0];
4969 if (limit
== 0) break;
4971 addReplyBulkLen(c
,ele
);
4973 addReply(c
,shared
.crlf
);
4974 ln
= ln
->forward
[0];
4976 if (limit
> 0) limit
--;
4978 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%d\r\n",rangelen
);
4983 static void zcardCommand(redisClient
*c
) {
4987 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4989 addReply(c
,shared
.czero
);
4992 if (o
->type
!= REDIS_ZSET
) {
4993 addReply(c
,shared
.wrongtypeerr
);
4996 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",zs
->zsl
->length
));
5001 static void zscoreCommand(redisClient
*c
) {
5005 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5007 addReply(c
,shared
.nullbulk
);
5010 if (o
->type
!= REDIS_ZSET
) {
5011 addReply(c
,shared
.wrongtypeerr
);
5016 de
= dictFind(zs
->dict
,c
->argv
[2]);
5018 addReply(c
,shared
.nullbulk
);
5020 double *score
= dictGetEntryVal(de
);
5022 addReplyDouble(c
,*score
);
5028 /* ========================= Non type-specific commands ==================== */
5030 static void flushdbCommand(redisClient
*c
) {
5031 server
.dirty
+= dictSize(c
->db
->dict
);
5032 dictEmpty(c
->db
->dict
);
5033 dictEmpty(c
->db
->expires
);
5034 addReply(c
,shared
.ok
);
5037 static void flushallCommand(redisClient
*c
) {
5038 server
.dirty
+= emptyDb();
5039 addReply(c
,shared
.ok
);
5040 rdbSave(server
.dbfilename
);
5044 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
5045 redisSortOperation
*so
= zmalloc(sizeof(*so
));
5047 so
->pattern
= pattern
;
5051 /* Return the value associated to the key with a name obtained
5052 * substituting the first occurence of '*' in 'pattern' with 'subst' */
5053 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
5057 int prefixlen
, sublen
, postfixlen
;
5058 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
5062 char buf
[REDIS_SORTKEY_MAX
+1];
5065 /* If the pattern is "#" return the substitution object itself in order
5066 * to implement the "SORT ... GET #" feature. */
5067 spat
= pattern
->ptr
;
5068 if (spat
[0] == '#' && spat
[1] == '\0') {
5072 /* The substitution object may be specially encoded. If so we create
5073 * a decoded object on the fly. Otherwise getDecodedObject will just
5074 * increment the ref count, that we'll decrement later. */
5075 subst
= getDecodedObject(subst
);
5078 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
5079 p
= strchr(spat
,'*');
5081 decrRefCount(subst
);
5086 sublen
= sdslen(ssub
);
5087 postfixlen
= sdslen(spat
)-(prefixlen
+1);
5088 memcpy(keyname
.buf
,spat
,prefixlen
);
5089 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
5090 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
5091 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
5092 keyname
.len
= prefixlen
+sublen
+postfixlen
;
5094 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2))
5095 decrRefCount(subst
);
5097 /* printf("lookup '%s' => %p\n", keyname.buf,de); */
5098 return lookupKeyRead(db
,&keyobj
);
5101 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
5102 * the additional parameter is not standard but a BSD-specific we have to
5103 * pass sorting parameters via the global 'server' structure */
5104 static int sortCompare(const void *s1
, const void *s2
) {
5105 const redisSortObject
*so1
= s1
, *so2
= s2
;
5108 if (!server
.sort_alpha
) {
5109 /* Numeric sorting. Here it's trivial as we precomputed scores */
5110 if (so1
->u
.score
> so2
->u
.score
) {
5112 } else if (so1
->u
.score
< so2
->u
.score
) {
5118 /* Alphanumeric sorting */
5119 if (server
.sort_bypattern
) {
5120 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
5121 /* At least one compare object is NULL */
5122 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
5124 else if (so1
->u
.cmpobj
== NULL
)
5129 /* We have both the objects, use strcoll */
5130 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
5133 /* Compare elements directly */
5136 dec1
= getDecodedObject(so1
->obj
);
5137 dec2
= getDecodedObject(so2
->obj
);
5138 cmp
= strcoll(dec1
->ptr
,dec2
->ptr
);
5143 return server
.sort_desc
? -cmp
: cmp
;
5146 /* The SORT command is the most complex command in Redis. Warning: this code
5147 * is optimized for speed and a bit less for readability */
5148 static void sortCommand(redisClient
*c
) {
5151 int desc
= 0, alpha
= 0;
5152 int limit_start
= 0, limit_count
= -1, start
, end
;
5153 int j
, dontsort
= 0, vectorlen
;
5154 int getop
= 0; /* GET operation counter */
5155 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
5156 redisSortObject
*vector
; /* Resulting vector to sort */
5158 /* Lookup the key to sort. It must be of the right types */
5159 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
5160 if (sortval
== NULL
) {
5161 addReply(c
,shared
.nullmultibulk
);
5164 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
5165 sortval
->type
!= REDIS_ZSET
)
5167 addReply(c
,shared
.wrongtypeerr
);
5171 /* Create a list of operations to perform for every sorted element.
5172 * Operations can be GET/DEL/INCR/DECR */
5173 operations
= listCreate();
5174 listSetFreeMethod(operations
,zfree
);
5177 /* Now we need to protect sortval incrementing its count, in the future
5178 * SORT may have options able to overwrite/delete keys during the sorting
5179 * and the sorted key itself may get destroied */
5180 incrRefCount(sortval
);
5182 /* The SORT command has an SQL-alike syntax, parse it */
5183 while(j
< c
->argc
) {
5184 int leftargs
= c
->argc
-j
-1;
5185 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
5187 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
5189 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
5191 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
5192 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
5193 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
5195 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
5196 storekey
= c
->argv
[j
+1];
5198 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
5199 sortby
= c
->argv
[j
+1];
5200 /* If the BY pattern does not contain '*', i.e. it is constant,
5201 * we don't need to sort nor to lookup the weight keys. */
5202 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
5204 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
5205 listAddNodeTail(operations
,createSortOperation(
5206 REDIS_SORT_GET
,c
->argv
[j
+1]));
5210 decrRefCount(sortval
);
5211 listRelease(operations
);
5212 addReply(c
,shared
.syntaxerr
);
5218 /* Load the sorting vector with all the objects to sort */
5219 switch(sortval
->type
) {
5220 case REDIS_LIST
: vectorlen
= listLength((list
*)sortval
->ptr
); break;
5221 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
5222 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
5223 default: vectorlen
= 0; redisAssert(0); /* Avoid GCC warning */
5225 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
5228 if (sortval
->type
== REDIS_LIST
) {
5229 list
*list
= sortval
->ptr
;
5233 while((ln
= listYield(list
))) {
5234 robj
*ele
= ln
->value
;
5235 vector
[j
].obj
= ele
;
5236 vector
[j
].u
.score
= 0;
5237 vector
[j
].u
.cmpobj
= NULL
;
5245 if (sortval
->type
== REDIS_SET
) {
5248 zset
*zs
= sortval
->ptr
;
5252 di
= dictGetIterator(set
);
5253 while((setele
= dictNext(di
)) != NULL
) {
5254 vector
[j
].obj
= dictGetEntryKey(setele
);
5255 vector
[j
].u
.score
= 0;
5256 vector
[j
].u
.cmpobj
= NULL
;
5259 dictReleaseIterator(di
);
5261 redisAssert(j
== vectorlen
);
5263 /* Now it's time to load the right scores in the sorting vector */
5264 if (dontsort
== 0) {
5265 for (j
= 0; j
< vectorlen
; j
++) {
5269 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
5270 if (!byval
|| byval
->type
!= REDIS_STRING
) continue;
5272 vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
5274 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
5275 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
5277 /* Don't need to decode the object if it's
5278 * integer-encoded (the only encoding supported) so
5279 * far. We can just cast it */
5280 if (byval
->encoding
== REDIS_ENCODING_INT
) {
5281 vector
[j
].u
.score
= (long)byval
->ptr
;
5283 redisAssert(1 != 1);
5288 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_RAW
)
5289 vector
[j
].u
.score
= strtod(vector
[j
].obj
->ptr
,NULL
);
5291 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_INT
)
5292 vector
[j
].u
.score
= (long) vector
[j
].obj
->ptr
;
5294 redisAssert(1 != 1);
5301 /* We are ready to sort the vector... perform a bit of sanity check
5302 * on the LIMIT option too. We'll use a partial version of quicksort. */
5303 start
= (limit_start
< 0) ? 0 : limit_start
;
5304 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
5305 if (start
>= vectorlen
) {
5306 start
= vectorlen
-1;
5309 if (end
>= vectorlen
) end
= vectorlen
-1;
5311 if (dontsort
== 0) {
5312 server
.sort_desc
= desc
;
5313 server
.sort_alpha
= alpha
;
5314 server
.sort_bypattern
= sortby
? 1 : 0;
5315 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
5316 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
5318 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
5321 /* Send command output to the output buffer, performing the specified
5322 * GET/DEL/INCR/DECR operations if any. */
5323 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
5324 if (storekey
== NULL
) {
5325 /* STORE option not specified, sent the sorting result to client */
5326 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
5327 for (j
= start
; j
<= end
; j
++) {
5330 addReplyBulkLen(c
,vector
[j
].obj
);
5331 addReply(c
,vector
[j
].obj
);
5332 addReply(c
,shared
.crlf
);
5334 listRewind(operations
);
5335 while((ln
= listYield(operations
))) {
5336 redisSortOperation
*sop
= ln
->value
;
5337 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
5340 if (sop
->type
== REDIS_SORT_GET
) {
5341 if (!val
|| val
->type
!= REDIS_STRING
) {
5342 addReply(c
,shared
.nullbulk
);
5344 addReplyBulkLen(c
,val
);
5346 addReply(c
,shared
.crlf
);
5349 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
5354 robj
*listObject
= createListObject();
5355 list
*listPtr
= (list
*) listObject
->ptr
;
5357 /* STORE option specified, set the sorting result as a List object */
5358 for (j
= start
; j
<= end
; j
++) {
5361 listAddNodeTail(listPtr
,vector
[j
].obj
);
5362 incrRefCount(vector
[j
].obj
);
5364 listRewind(operations
);
5365 while((ln
= listYield(operations
))) {
5366 redisSortOperation
*sop
= ln
->value
;
5367 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
5370 if (sop
->type
== REDIS_SORT_GET
) {
5371 if (!val
|| val
->type
!= REDIS_STRING
) {
5372 listAddNodeTail(listPtr
,createStringObject("",0));
5374 listAddNodeTail(listPtr
,val
);
5378 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
5382 if (dictReplace(c
->db
->dict
,storekey
,listObject
)) {
5383 incrRefCount(storekey
);
5385 /* Note: we add 1 because the DB is dirty anyway since even if the
5386 * SORT result is empty a new key is set and maybe the old content
5388 server
.dirty
+= 1+outputlen
;
5389 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
5393 decrRefCount(sortval
);
5394 listRelease(operations
);
5395 for (j
= 0; j
< vectorlen
; j
++) {
5396 if (sortby
&& alpha
&& vector
[j
].u
.cmpobj
)
5397 decrRefCount(vector
[j
].u
.cmpobj
);
5402 /* Create the string returned by the INFO command. This is decoupled
5403 * by the INFO command itself as we need to report the same information
5404 * on memory corruption problems. */
5405 static sds
genRedisInfoString(void) {
5407 time_t uptime
= time(NULL
)-server
.stat_starttime
;
5410 info
= sdscatprintf(sdsempty(),
5411 "redis_version:%s\r\n"
5413 "multiplexing_api:%s\r\n"
5414 "process_id:%ld\r\n"
5415 "uptime_in_seconds:%ld\r\n"
5416 "uptime_in_days:%ld\r\n"
5417 "connected_clients:%d\r\n"
5418 "connected_slaves:%d\r\n"
5419 "blocked_clients:%d\r\n"
5420 "used_memory:%zu\r\n"
5421 "changes_since_last_save:%lld\r\n"
5422 "bgsave_in_progress:%d\r\n"
5423 "last_save_time:%ld\r\n"
5424 "bgrewriteaof_in_progress:%d\r\n"
5425 "total_connections_received:%lld\r\n"
5426 "total_commands_processed:%lld\r\n"
5430 (sizeof(long) == 8) ? "64" : "32",
5435 listLength(server
.clients
)-listLength(server
.slaves
),
5436 listLength(server
.slaves
),
5437 server
.blockedclients
,
5440 server
.bgsavechildpid
!= -1,
5442 server
.bgrewritechildpid
!= -1,
5443 server
.stat_numconnections
,
5444 server
.stat_numcommands
,
5445 server
.vm_enabled
!= 0,
5446 server
.masterhost
== NULL
? "master" : "slave"
5448 if (server
.masterhost
) {
5449 info
= sdscatprintf(info
,
5450 "master_host:%s\r\n"
5451 "master_port:%d\r\n"
5452 "master_link_status:%s\r\n"
5453 "master_last_io_seconds_ago:%d\r\n"
5456 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
5458 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
5461 if (server
.vm_enabled
) {
5462 info
= sdscatprintf(info
,
5463 "vm_conf_max_memory:%llu\r\n"
5464 "vm_conf_page_size:%llu\r\n"
5465 "vm_conf_pages:%llu\r\n"
5466 "vm_stats_used_pages:%llu\r\n"
5467 "vm_stats_swapped_objects:%llu\r\n"
5468 "vm_stats_swappin_count:%llu\r\n"
5469 "vm_stats_swappout_count:%llu\r\n"
5470 ,(unsigned long long) server
.vm_max_memory
,
5471 (unsigned long long) server
.vm_page_size
,
5472 (unsigned long long) server
.vm_pages
,
5473 (unsigned long long) server
.vm_stats_used_pages
,
5474 (unsigned long long) server
.vm_stats_swapped_objects
,
5475 (unsigned long long) server
.vm_stats_swapins
,
5476 (unsigned long long) server
.vm_stats_swapouts
5479 for (j
= 0; j
< server
.dbnum
; j
++) {
5480 long long keys
, vkeys
;
5482 keys
= dictSize(server
.db
[j
].dict
);
5483 vkeys
= dictSize(server
.db
[j
].expires
);
5484 if (keys
|| vkeys
) {
5485 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
5492 static void infoCommand(redisClient
*c
) {
5493 sds info
= genRedisInfoString();
5494 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
5495 (unsigned long)sdslen(info
)));
5496 addReplySds(c
,info
);
5497 addReply(c
,shared
.crlf
);
5500 static void monitorCommand(redisClient
*c
) {
5501 /* ignore MONITOR if aleady slave or in monitor mode */
5502 if (c
->flags
& REDIS_SLAVE
) return;
5504 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
5506 listAddNodeTail(server
.monitors
,c
);
5507 addReply(c
,shared
.ok
);
5510 /* ================================= Expire ================================= */
5511 static int removeExpire(redisDb
*db
, robj
*key
) {
5512 if (dictDelete(db
->expires
,key
) == DICT_OK
) {
5519 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
5520 if (dictAdd(db
->expires
,key
,(void*)when
) == DICT_ERR
) {
5528 /* Return the expire time of the specified key, or -1 if no expire
5529 * is associated with this key (i.e. the key is non volatile) */
5530 static time_t getExpire(redisDb
*db
, robj
*key
) {
5533 /* No expire? return ASAP */
5534 if (dictSize(db
->expires
) == 0 ||
5535 (de
= dictFind(db
->expires
,key
)) == NULL
) return -1;
5537 return (time_t) dictGetEntryVal(de
);
5540 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
5544 /* No expire? return ASAP */
5545 if (dictSize(db
->expires
) == 0 ||
5546 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
5548 /* Lookup the expire */
5549 when
= (time_t) dictGetEntryVal(de
);
5550 if (time(NULL
) <= when
) return 0;
5552 /* Delete the key */
5553 dictDelete(db
->expires
,key
);
5554 return dictDelete(db
->dict
,key
) == DICT_OK
;
5557 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
5560 /* No expire? return ASAP */
5561 if (dictSize(db
->expires
) == 0 ||
5562 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
5564 /* Delete the key */
5566 dictDelete(db
->expires
,key
);
5567 return dictDelete(db
->dict
,key
) == DICT_OK
;
5570 static void expireGenericCommand(redisClient
*c
, robj
*key
, time_t seconds
) {
5573 de
= dictFind(c
->db
->dict
,key
);
5575 addReply(c
,shared
.czero
);
5579 if (deleteKey(c
->db
,key
)) server
.dirty
++;
5580 addReply(c
, shared
.cone
);
5583 time_t when
= time(NULL
)+seconds
;
5584 if (setExpire(c
->db
,key
,when
)) {
5585 addReply(c
,shared
.cone
);
5588 addReply(c
,shared
.czero
);
5594 static void expireCommand(redisClient
*c
) {
5595 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10));
5598 static void expireatCommand(redisClient
*c
) {
5599 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10)-time(NULL
));
5602 static void ttlCommand(redisClient
*c
) {
5606 expire
= getExpire(c
->db
,c
->argv
[1]);
5608 ttl
= (int) (expire
-time(NULL
));
5609 if (ttl
< 0) ttl
= -1;
5611 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
5614 /* ================================ MULTI/EXEC ============================== */
5616 /* Client state initialization for MULTI/EXEC */
5617 static void initClientMultiState(redisClient
*c
) {
5618 c
->mstate
.commands
= NULL
;
5619 c
->mstate
.count
= 0;
5622 /* Release all the resources associated with MULTI/EXEC state */
5623 static void freeClientMultiState(redisClient
*c
) {
5626 for (j
= 0; j
< c
->mstate
.count
; j
++) {
5628 multiCmd
*mc
= c
->mstate
.commands
+j
;
5630 for (i
= 0; i
< mc
->argc
; i
++)
5631 decrRefCount(mc
->argv
[i
]);
5634 zfree(c
->mstate
.commands
);
5637 /* Add a new command into the MULTI commands queue */
5638 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
5642 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
5643 sizeof(multiCmd
)*(c
->mstate
.count
+1));
5644 mc
= c
->mstate
.commands
+c
->mstate
.count
;
5647 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
5648 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
5649 for (j
= 0; j
< c
->argc
; j
++)
5650 incrRefCount(mc
->argv
[j
]);
5654 static void multiCommand(redisClient
*c
) {
5655 c
->flags
|= REDIS_MULTI
;
5656 addReply(c
,shared
.ok
);
5659 static void execCommand(redisClient
*c
) {
5664 if (!(c
->flags
& REDIS_MULTI
)) {
5665 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
5669 orig_argv
= c
->argv
;
5670 orig_argc
= c
->argc
;
5671 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
5672 for (j
= 0; j
< c
->mstate
.count
; j
++) {
5673 c
->argc
= c
->mstate
.commands
[j
].argc
;
5674 c
->argv
= c
->mstate
.commands
[j
].argv
;
5675 call(c
,c
->mstate
.commands
[j
].cmd
);
5677 c
->argv
= orig_argv
;
5678 c
->argc
= orig_argc
;
5679 freeClientMultiState(c
);
5680 initClientMultiState(c
);
5681 c
->flags
&= (~REDIS_MULTI
);
5684 /* =========================== Blocking Operations ========================= */
5686 /* Currently Redis blocking operations support is limited to list POP ops,
5687 * so the current implementation is not fully generic, but it is also not
5688 * completely specific so it will not require a rewrite to support new
5689 * kind of blocking operations in the future.
5691 * Still it's important to note that list blocking operations can be already
5692 * used as a notification mechanism in order to implement other blocking
5693 * operations at application level, so there must be a very strong evidence
5694 * of usefulness and generality before new blocking operations are implemented.
5696 * This is how the current blocking POP works, we use BLPOP as example:
5697 * - If the user calls BLPOP and the key exists and contains a non empty list
5698 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
5699 * if there is not to block.
5700 * - If instead BLPOP is called and the key does not exists or the list is
5701 * empty we need to block. In order to do so we remove the notification for
5702 * new data to read in the client socket (so that we'll not serve new
5703 * requests if the blocking request is not served). Also we put the client
5704 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
5705 * blocking for this keys.
5706 * - If a PUSH operation against a key with blocked clients waiting is
5707 * performed, we serve the first in the list: basically instead to push
5708 * the new element inside the list we return it to the (first / oldest)
5709 * blocking client, unblock the client, and remove it form the list.
5711 * The above comment and the source code should be enough in order to understand
5712 * the implementation and modify / fix it later.
5715 /* Set a client in blocking mode for the specified key, with the specified
5717 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
5722 c
->blockingkeys
= zmalloc(sizeof(robj
*)*numkeys
);
5723 c
->blockingkeysnum
= numkeys
;
5724 c
->blockingto
= timeout
;
5725 for (j
= 0; j
< numkeys
; j
++) {
5726 /* Add the key in the client structure, to map clients -> keys */
5727 c
->blockingkeys
[j
] = keys
[j
];
5728 incrRefCount(keys
[j
]);
5730 /* And in the other "side", to map keys -> clients */
5731 de
= dictFind(c
->db
->blockingkeys
,keys
[j
]);
5735 /* For every key we take a list of clients blocked for it */
5737 retval
= dictAdd(c
->db
->blockingkeys
,keys
[j
],l
);
5738 incrRefCount(keys
[j
]);
5739 assert(retval
== DICT_OK
);
5741 l
= dictGetEntryVal(de
);
5743 listAddNodeTail(l
,c
);
5745 /* Mark the client as a blocked client */
5746 c
->flags
|= REDIS_BLOCKED
;
5747 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
5748 server
.blockedclients
++;
5751 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
5752 static void unblockClient(redisClient
*c
) {
5757 assert(c
->blockingkeys
!= NULL
);
5758 /* The client may wait for multiple keys, so unblock it for every key. */
5759 for (j
= 0; j
< c
->blockingkeysnum
; j
++) {
5760 /* Remove this client from the list of clients waiting for this key. */
5761 de
= dictFind(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
5763 l
= dictGetEntryVal(de
);
5764 listDelNode(l
,listSearchKey(l
,c
));
5765 /* If the list is empty we need to remove it to avoid wasting memory */
5766 if (listLength(l
) == 0)
5767 dictDelete(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
5768 decrRefCount(c
->blockingkeys
[j
]);
5770 /* Cleanup the client structure */
5771 zfree(c
->blockingkeys
);
5772 c
->blockingkeys
= NULL
;
5773 c
->flags
&= (~REDIS_BLOCKED
);
5774 server
.blockedclients
--;
5775 /* Ok now we are ready to get read events from socket, note that we
5776 * can't trap errors here as it's possible that unblockClients() is
5777 * called from freeClient() itself, and the only thing we can do
5778 * if we failed to register the READABLE event is to kill the client.
5779 * Still the following function should never fail in the real world as
5780 * we are sure the file descriptor is sane, and we exit on out of mem. */
5781 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
, readQueryFromClient
, c
);
5782 /* As a final step we want to process data if there is some command waiting
5783 * in the input buffer. Note that this is safe even if unblockClient()
5784 * gets called from freeClient() because freeClient() will be smart
5785 * enough to call this function *after* c->querybuf was set to NULL. */
5786 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
5789 /* This should be called from any function PUSHing into lists.
5790 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
5791 * 'ele' is the element pushed.
5793 * If the function returns 0 there was no client waiting for a list push
5796 * If the function returns 1 there was a client waiting for a list push
5797 * against this key, the element was passed to this client thus it's not
5798 * needed to actually add it to the list and the caller should return asap. */
5799 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
5800 struct dictEntry
*de
;
5801 redisClient
*receiver
;
5805 de
= dictFind(c
->db
->blockingkeys
,key
);
5806 if (de
== NULL
) return 0;
5807 l
= dictGetEntryVal(de
);
5810 receiver
= ln
->value
;
5812 addReplySds(receiver
,sdsnew("*2\r\n"));
5813 addReplyBulkLen(receiver
,key
);
5814 addReply(receiver
,key
);
5815 addReply(receiver
,shared
.crlf
);
5816 addReplyBulkLen(receiver
,ele
);
5817 addReply(receiver
,ele
);
5818 addReply(receiver
,shared
.crlf
);
5819 unblockClient(receiver
);
5823 /* Blocking RPOP/LPOP */
5824 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
5829 for (j
= 1; j
< c
->argc
-1; j
++) {
5830 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
5832 if (o
->type
!= REDIS_LIST
) {
5833 addReply(c
,shared
.wrongtypeerr
);
5836 list
*list
= o
->ptr
;
5837 if (listLength(list
) != 0) {
5838 /* If the list contains elements fall back to the usual
5839 * non-blocking POP operation */
5840 robj
*argv
[2], **orig_argv
;
5843 /* We need to alter the command arguments before to call
5844 * popGenericCommand() as the command takes a single key. */
5845 orig_argv
= c
->argv
;
5846 orig_argc
= c
->argc
;
5847 argv
[1] = c
->argv
[j
];
5851 /* Also the return value is different, we need to output
5852 * the multi bulk reply header and the key name. The
5853 * "real" command will add the last element (the value)
5854 * for us. If this souds like an hack to you it's just
5855 * because it is... */
5856 addReplySds(c
,sdsnew("*2\r\n"));
5857 addReplyBulkLen(c
,argv
[1]);
5858 addReply(c
,argv
[1]);
5859 addReply(c
,shared
.crlf
);
5860 popGenericCommand(c
,where
);
5862 /* Fix the client structure with the original stuff */
5863 c
->argv
= orig_argv
;
5864 c
->argc
= orig_argc
;
5870 /* If the list is empty or the key does not exists we must block */
5871 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
5872 if (timeout
> 0) timeout
+= time(NULL
);
5873 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
5876 static void blpopCommand(redisClient
*c
) {
5877 blockingPopGenericCommand(c
,REDIS_HEAD
);
5880 static void brpopCommand(redisClient
*c
) {
5881 blockingPopGenericCommand(c
,REDIS_TAIL
);
5884 /* =============================== Replication ============================= */
5886 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
5887 ssize_t nwritten
, ret
= size
;
5888 time_t start
= time(NULL
);
5892 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
5893 nwritten
= write(fd
,ptr
,size
);
5894 if (nwritten
== -1) return -1;
5898 if ((time(NULL
)-start
) > timeout
) {
5906 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
5907 ssize_t nread
, totread
= 0;
5908 time_t start
= time(NULL
);
5912 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
5913 nread
= read(fd
,ptr
,size
);
5914 if (nread
== -1) return -1;
5919 if ((time(NULL
)-start
) > timeout
) {
5927 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
5934 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
5937 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
5948 static void syncCommand(redisClient
*c
) {
5949 /* ignore SYNC if aleady slave or in monitor mode */
5950 if (c
->flags
& REDIS_SLAVE
) return;
5952 /* SYNC can't be issued when the server has pending data to send to
5953 * the client about already issued commands. We need a fresh reply
5954 * buffer registering the differences between the BGSAVE and the current
5955 * dataset, so that we can copy to other slaves if needed. */
5956 if (listLength(c
->reply
) != 0) {
5957 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
5961 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
5962 /* Here we need to check if there is a background saving operation
5963 * in progress, or if it is required to start one */
5964 if (server
.bgsavechildpid
!= -1) {
5965 /* Ok a background save is in progress. Let's check if it is a good
5966 * one for replication, i.e. if there is another slave that is
5967 * registering differences since the server forked to save */
5971 listRewind(server
.slaves
);
5972 while((ln
= listYield(server
.slaves
))) {
5974 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
5977 /* Perfect, the server is already registering differences for
5978 * another slave. Set the right state, and copy the buffer. */
5979 listRelease(c
->reply
);
5980 c
->reply
= listDup(slave
->reply
);
5981 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
5982 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
5984 /* No way, we need to wait for the next BGSAVE in order to
5985 * register differences */
5986 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
5987 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
5990 /* Ok we don't have a BGSAVE in progress, let's start one */
5991 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
5992 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
5993 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
5994 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
5997 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
6000 c
->flags
|= REDIS_SLAVE
;
6002 listAddNodeTail(server
.slaves
,c
);
6006 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
6007 redisClient
*slave
= privdata
;
6009 REDIS_NOTUSED(mask
);
6010 char buf
[REDIS_IOBUF_LEN
];
6011 ssize_t nwritten
, buflen
;
6013 if (slave
->repldboff
== 0) {
6014 /* Write the bulk write count before to transfer the DB. In theory here
6015 * we don't know how much room there is in the output buffer of the
6016 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
6017 * operations) will never be smaller than the few bytes we need. */
6020 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
6022 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
6030 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
6031 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
6033 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
6034 (buflen
== 0) ? "premature EOF" : strerror(errno
));
6038 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
6039 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
6044 slave
->repldboff
+= nwritten
;
6045 if (slave
->repldboff
== slave
->repldbsize
) {
6046 close(slave
->repldbfd
);
6047 slave
->repldbfd
= -1;
6048 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
6049 slave
->replstate
= REDIS_REPL_ONLINE
;
6050 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
6051 sendReplyToClient
, slave
) == AE_ERR
) {
6055 addReplySds(slave
,sdsempty());
6056 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
6060 /* This function is called at the end of every backgrond saving.
6061 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
6062 * otherwise REDIS_ERR is passed to the function.
6064 * The goal of this function is to handle slaves waiting for a successful
6065 * background saving in order to perform non-blocking synchronization. */
6066 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
6068 int startbgsave
= 0;
6070 listRewind(server
.slaves
);
6071 while((ln
= listYield(server
.slaves
))) {
6072 redisClient
*slave
= ln
->value
;
6074 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
6076 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
6077 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
6078 struct redis_stat buf
;
6080 if (bgsaveerr
!= REDIS_OK
) {
6082 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
6085 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
6086 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
6088 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
6091 slave
->repldboff
= 0;
6092 slave
->repldbsize
= buf
.st_size
;
6093 slave
->replstate
= REDIS_REPL_SEND_BULK
;
6094 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
6095 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
6102 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
6103 listRewind(server
.slaves
);
6104 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
6105 while((ln
= listYield(server
.slaves
))) {
6106 redisClient
*slave
= ln
->value
;
6108 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
6115 static int syncWithMaster(void) {
6116 char buf
[1024], tmpfile
[256], authcmd
[1024];
6118 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
6122 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
6127 /* AUTH with the master if required. */
6128 if(server
.masterauth
) {
6129 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
6130 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
6132 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
6136 /* Read the AUTH result. */
6137 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
6139 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
6143 if (buf
[0] != '+') {
6145 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
6150 /* Issue the SYNC command */
6151 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
6153 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
6157 /* Read the bulk write count */
6158 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
6160 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
6164 if (buf
[0] != '$') {
6166 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
6169 dumpsize
= atoi(buf
+1);
6170 redisLog(REDIS_NOTICE
,"Receiving %d bytes data dump from MASTER",dumpsize
);
6171 /* Read the bulk write data on a temp file */
6172 snprintf(tmpfile
,256,"temp-%d.%ld.rdb",(int)time(NULL
),(long int)random());
6173 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
,0644);
6176 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
6180 int nread
, nwritten
;
6182 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
6184 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
6190 nwritten
= write(dfd
,buf
,nread
);
6191 if (nwritten
== -1) {
6192 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
6200 if (rename(tmpfile
,server
.dbfilename
) == -1) {
6201 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
6207 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
6208 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
6212 server
.master
= createClient(fd
);
6213 server
.master
->flags
|= REDIS_MASTER
;
6214 server
.master
->authenticated
= 1;
6215 server
.replstate
= REDIS_REPL_CONNECTED
;
6219 static void slaveofCommand(redisClient
*c
) {
6220 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
6221 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
6222 if (server
.masterhost
) {
6223 sdsfree(server
.masterhost
);
6224 server
.masterhost
= NULL
;
6225 if (server
.master
) freeClient(server
.master
);
6226 server
.replstate
= REDIS_REPL_NONE
;
6227 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
6230 sdsfree(server
.masterhost
);
6231 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
6232 server
.masterport
= atoi(c
->argv
[2]->ptr
);
6233 if (server
.master
) freeClient(server
.master
);
6234 server
.replstate
= REDIS_REPL_CONNECT
;
6235 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
6236 server
.masterhost
, server
.masterport
);
6238 addReply(c
,shared
.ok
);
6241 /* ============================ Maxmemory directive ======================== */
6243 /* Free one object form the pre-allocated objects free list. This is useful
6244 * under low mem conditions as by default we take 1 million free objects
6246 static void freeOneObjectFromFreelist(void) {
6249 listNode
*head
= listFirst(server
.objfreelist
);
6250 o
= listNodeValue(head
);
6251 listDelNode(server
.objfreelist
,head
);
6255 /* This function gets called when 'maxmemory' is set on the config file to limit
6256 * the max memory used by the server, and we are out of memory.
6257 * This function will try to, in order:
6259 * - Free objects from the free list
6260 * - Try to remove keys with an EXPIRE set
6262 * It is not possible to free enough memory to reach used-memory < maxmemory
6263 * the server will start refusing commands that will enlarge even more the
6266 static void freeMemoryIfNeeded(void) {
6267 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
6268 if (listLength(server
.objfreelist
)) {
6269 freeOneObjectFromFreelist();
6271 int j
, k
, freed
= 0;
6273 for (j
= 0; j
< server
.dbnum
; j
++) {
6275 robj
*minkey
= NULL
;
6276 struct dictEntry
*de
;
6278 if (dictSize(server
.db
[j
].expires
)) {
6280 /* From a sample of three keys drop the one nearest to
6281 * the natural expire */
6282 for (k
= 0; k
< 3; k
++) {
6285 de
= dictGetRandomKey(server
.db
[j
].expires
);
6286 t
= (time_t) dictGetEntryVal(de
);
6287 if (minttl
== -1 || t
< minttl
) {
6288 minkey
= dictGetEntryKey(de
);
6292 deleteKey(server
.db
+j
,minkey
);
6295 if (!freed
) return; /* nothing to free... */
6300 /* ============================== Append Only file ========================== */
6302 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
6303 sds buf
= sdsempty();
6309 /* The DB this command was targetting is not the same as the last command
6310 * we appendend. To issue a SELECT command is needed. */
6311 if (dictid
!= server
.appendseldb
) {
6314 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
6315 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
6316 (unsigned long)strlen(seldb
),seldb
);
6317 server
.appendseldb
= dictid
;
6320 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
6321 * EXPIREs into EXPIREATs calls */
6322 if (cmd
->proc
== expireCommand
) {
6325 tmpargv
[0] = createStringObject("EXPIREAT",8);
6326 tmpargv
[1] = argv
[1];
6327 incrRefCount(argv
[1]);
6328 when
= time(NULL
)+strtol(argv
[2]->ptr
,NULL
,10);
6329 tmpargv
[2] = createObject(REDIS_STRING
,
6330 sdscatprintf(sdsempty(),"%ld",when
));
6334 /* Append the actual command */
6335 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
6336 for (j
= 0; j
< argc
; j
++) {
6339 o
= getDecodedObject(o
);
6340 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
6341 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
6342 buf
= sdscatlen(buf
,"\r\n",2);
6346 /* Free the objects from the modified argv for EXPIREAT */
6347 if (cmd
->proc
== expireCommand
) {
6348 for (j
= 0; j
< 3; j
++)
6349 decrRefCount(argv
[j
]);
6352 /* We want to perform a single write. This should be guaranteed atomic
6353 * at least if the filesystem we are writing is a real physical one.
6354 * While this will save us against the server being killed I don't think
6355 * there is much to do about the whole server stopping for power problems
6357 nwritten
= write(server
.appendfd
,buf
,sdslen(buf
));
6358 if (nwritten
!= (signed)sdslen(buf
)) {
6359 /* Ooops, we are in troubles. The best thing to do for now is
6360 * to simply exit instead to give the illusion that everything is
6361 * working as expected. */
6362 if (nwritten
== -1) {
6363 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
6365 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
6369 /* If a background append only file rewriting is in progress we want to
6370 * accumulate the differences between the child DB and the current one
6371 * in a buffer, so that when the child process will do its work we
6372 * can append the differences to the new append only file. */
6373 if (server
.bgrewritechildpid
!= -1)
6374 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
6378 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
6379 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
6380 now
-server
.lastfsync
> 1))
6382 fsync(server
.appendfd
); /* Let's try to get this data on the disk */
6383 server
.lastfsync
= now
;
6387 /* In Redis commands are always executed in the context of a client, so in
6388 * order to load the append only file we need to create a fake client. */
6389 static struct redisClient
*createFakeClient(void) {
6390 struct redisClient
*c
= zmalloc(sizeof(*c
));
6394 c
->querybuf
= sdsempty();
6398 /* We set the fake client as a slave waiting for the synchronization
6399 * so that Redis will not try to send replies to this client. */
6400 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
6401 c
->reply
= listCreate();
6402 listSetFreeMethod(c
->reply
,decrRefCount
);
6403 listSetDupMethod(c
->reply
,dupClientReplyValue
);
6407 static void freeFakeClient(struct redisClient
*c
) {
6408 sdsfree(c
->querybuf
);
6409 listRelease(c
->reply
);
6413 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
6414 * error (the append only file is zero-length) REDIS_ERR is returned. On
6415 * fatal error an error message is logged and the program exists. */
6416 int loadAppendOnlyFile(char *filename
) {
6417 struct redisClient
*fakeClient
;
6418 FILE *fp
= fopen(filename
,"r");
6419 struct redis_stat sb
;
6421 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
6425 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
6429 fakeClient
= createFakeClient();
6436 struct redisCommand
*cmd
;
6438 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
6444 if (buf
[0] != '*') goto fmterr
;
6446 argv
= zmalloc(sizeof(robj
*)*argc
);
6447 for (j
= 0; j
< argc
; j
++) {
6448 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
6449 if (buf
[0] != '$') goto fmterr
;
6450 len
= strtol(buf
+1,NULL
,10);
6451 argsds
= sdsnewlen(NULL
,len
);
6452 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
6453 argv
[j
] = createObject(REDIS_STRING
,argsds
);
6454 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
6457 /* Command lookup */
6458 cmd
= lookupCommand(argv
[0]->ptr
);
6460 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
6463 /* Try object sharing and encoding */
6464 if (server
.shareobjects
) {
6466 for(j
= 1; j
< argc
; j
++)
6467 argv
[j
] = tryObjectSharing(argv
[j
]);
6469 if (cmd
->flags
& REDIS_CMD_BULK
)
6470 tryObjectEncoding(argv
[argc
-1]);
6471 /* Run the command in the context of a fake client */
6472 fakeClient
->argc
= argc
;
6473 fakeClient
->argv
= argv
;
6474 cmd
->proc(fakeClient
);
6475 /* Discard the reply objects list from the fake client */
6476 while(listLength(fakeClient
->reply
))
6477 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
6478 /* Clean up, ready for the next command */
6479 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
6483 freeFakeClient(fakeClient
);
6488 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
6490 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
6494 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
6498 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
6499 static int fwriteBulk(FILE *fp
, robj
*obj
) {
6501 obj
= getDecodedObject(obj
);
6502 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
6503 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
6504 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
6506 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
6514 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
6515 static int fwriteBulkDouble(FILE *fp
, double d
) {
6516 char buf
[128], dbuf
[128];
6518 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
6519 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
6520 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
6521 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
6525 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
6526 static int fwriteBulkLong(FILE *fp
, long l
) {
6527 char buf
[128], lbuf
[128];
6529 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
6530 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
6531 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
6532 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
6536 /* Write a sequence of commands able to fully rebuild the dataset into
6537 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
6538 static int rewriteAppendOnlyFile(char *filename
) {
6539 dictIterator
*di
= NULL
;
6544 time_t now
= time(NULL
);
6546 /* Note that we have to use a different temp name here compared to the
6547 * one used by rewriteAppendOnlyFileBackground() function. */
6548 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
6549 fp
= fopen(tmpfile
,"w");
6551 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
6554 for (j
= 0; j
< server
.dbnum
; j
++) {
6555 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
6556 redisDb
*db
= server
.db
+j
;
6558 if (dictSize(d
) == 0) continue;
6559 di
= dictGetIterator(d
);
6565 /* SELECT the new DB */
6566 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
6567 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
6569 /* Iterate this DB writing every entry */
6570 while((de
= dictNext(di
)) != NULL
) {
6575 key
= dictGetEntryKey(de
);
6576 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
) {
6577 o
= dictGetEntryVal(de
);
6580 o
= vmPreviewObject(key
);
6581 key
= dupStringObject(key
);
6584 expiretime
= getExpire(db
,key
);
6586 /* Save the key and associated value */
6587 if (o
->type
== REDIS_STRING
) {
6588 /* Emit a SET command */
6589 char cmd
[]="*3\r\n$3\r\nSET\r\n";
6590 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
6592 if (fwriteBulk(fp
,key
) == 0) goto werr
;
6593 if (fwriteBulk(fp
,o
) == 0) goto werr
;
6594 } else if (o
->type
== REDIS_LIST
) {
6595 /* Emit the RPUSHes needed to rebuild the list */
6596 list
*list
= o
->ptr
;
6600 while((ln
= listYield(list
))) {
6601 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
6602 robj
*eleobj
= listNodeValue(ln
);
6604 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
6605 if (fwriteBulk(fp
,key
) == 0) goto werr
;
6606 if (fwriteBulk(fp
,eleobj
) == 0) goto werr
;
6608 } else if (o
->type
== REDIS_SET
) {
6609 /* Emit the SADDs needed to rebuild the set */
6611 dictIterator
*di
= dictGetIterator(set
);
6614 while((de
= dictNext(di
)) != NULL
) {
6615 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
6616 robj
*eleobj
= dictGetEntryKey(de
);
6618 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
6619 if (fwriteBulk(fp
,key
) == 0) goto werr
;
6620 if (fwriteBulk(fp
,eleobj
) == 0) goto werr
;
6622 dictReleaseIterator(di
);
6623 } else if (o
->type
== REDIS_ZSET
) {
6624 /* Emit the ZADDs needed to rebuild the sorted set */
6626 dictIterator
*di
= dictGetIterator(zs
->dict
);
6629 while((de
= dictNext(di
)) != NULL
) {
6630 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
6631 robj
*eleobj
= dictGetEntryKey(de
);
6632 double *score
= dictGetEntryVal(de
);
6634 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
6635 if (fwriteBulk(fp
,key
) == 0) goto werr
;
6636 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
6637 if (fwriteBulk(fp
,eleobj
) == 0) goto werr
;
6639 dictReleaseIterator(di
);
6641 redisAssert(0 != 0);
6643 /* Save the expire time */
6644 if (expiretime
!= -1) {
6645 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
6646 /* If this key is already expired skip it */
6647 if (expiretime
< now
) continue;
6648 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
6649 if (fwriteBulk(fp
,key
) == 0) goto werr
;
6650 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
6652 /* We created a few temp objects if the key->value pair
6653 * was about a swapped out object. Free both. */
6659 dictReleaseIterator(di
);
6662 /* Make sure data will not remain on the OS's output buffers */
6667 /* Use RENAME to make sure the DB file is changed atomically only
6668 * if the generate DB file is ok. */
6669 if (rename(tmpfile
,filename
) == -1) {
6670 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
6674 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
6680 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
6681 if (di
) dictReleaseIterator(di
);
6685 /* This is how rewriting of the append only file in background works:
6687 * 1) The user calls BGREWRITEAOF
6688 * 2) Redis calls this function, that forks():
6689 * 2a) the child rewrite the append only file in a temp file.
6690 * 2b) the parent accumulates differences in server.bgrewritebuf.
6691 * 3) When the child finished '2a' exists.
6692 * 4) The parent will trap the exit code, if it's OK, will append the
6693 * data accumulated into server.bgrewritebuf into the temp file, and
6694 * finally will rename(2) the temp file in the actual file name.
6695 * The the new file is reopened as the new append only file. Profit!
6697 static int rewriteAppendOnlyFileBackground(void) {
6700 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
6701 if ((childpid
= fork()) == 0) {
6706 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
6707 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
6714 if (childpid
== -1) {
6715 redisLog(REDIS_WARNING
,
6716 "Can't rewrite append only file in background: fork: %s",
6720 redisLog(REDIS_NOTICE
,
6721 "Background append only file rewriting started by pid %d",childpid
);
6722 server
.bgrewritechildpid
= childpid
;
6723 /* We set appendseldb to -1 in order to force the next call to the
6724 * feedAppendOnlyFile() to issue a SELECT command, so the differences
6725 * accumulated by the parent into server.bgrewritebuf will start
6726 * with a SELECT statement and it will be safe to merge. */
6727 server
.appendseldb
= -1;
6730 return REDIS_OK
; /* unreached */
6733 static void bgrewriteaofCommand(redisClient
*c
) {
6734 if (server
.bgrewritechildpid
!= -1) {
6735 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
6738 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
6739 char *status
= "+Background append only file rewriting started\r\n";
6740 addReplySds(c
,sdsnew(status
));
6742 addReply(c
,shared
.err
);
6746 static void aofRemoveTempFile(pid_t childpid
) {
6749 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
6753 /* =============================== Virtual Memory =========================== */
6754 static void vmInit(void) {
6757 server
.vm_fp
= fopen("/tmp/redisvm","w+b");
6758 if (server
.vm_fp
== NULL
) {
6759 redisLog(REDIS_WARNING
,"Impossible to open the swap file. Exiting.");
6762 server
.vm_fd
= fileno(server
.vm_fp
);
6763 server
.vm_next_page
= 0;
6764 server
.vm_near_pages
= 0;
6765 server
.vm_stats_used_pages
= 0;
6766 server
.vm_stats_swapped_objects
= 0;
6767 server
.vm_stats_swapouts
= 0;
6768 server
.vm_stats_swapins
= 0;
6769 totsize
= server
.vm_pages
*server
.vm_page_size
;
6770 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
6771 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
6772 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
6776 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
6778 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
6779 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
6780 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
6781 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
6782 /* Try to remove the swap file, so the OS will really delete it from the
6783 * file system when Redis exists. */
6784 unlink("/tmp/redisvm");
6787 /* Mark the page as used */
6788 static void vmMarkPageUsed(off_t page
) {
6789 off_t byte
= page
/8;
6791 server
.vm_bitmap
[byte
] |= 1<<bit
;
6792 redisLog(REDIS_DEBUG
,"Mark used: %lld (byte:%lld bit:%d)\n",
6793 (long long)page
, (long long)byte
, bit
);
6796 /* Mark N contiguous pages as used, with 'page' being the first. */
6797 static void vmMarkPagesUsed(off_t page
, off_t count
) {
6800 for (j
= 0; j
< count
; j
++)
6801 vmMarkPageUsed(page
+j
);
6802 server
.vm_stats_used_pages
+= count
;
6805 /* Mark the page as free */
6806 static void vmMarkPageFree(off_t page
) {
6807 off_t byte
= page
/8;
6809 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
6812 /* Mark N contiguous pages as free, with 'page' being the first. */
6813 static void vmMarkPagesFree(off_t page
, off_t count
) {
6816 for (j
= 0; j
< count
; j
++)
6817 vmMarkPageFree(page
+j
);
6818 server
.vm_stats_used_pages
-= count
;
6821 /* Test if the page is free */
6822 static int vmFreePage(off_t page
) {
6823 off_t byte
= page
/8;
6825 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
6828 /* Find N contiguous free pages storing the first page of the cluster in *first.
6829 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
6830 * REDIS_ERR is returned.
6832 * This function uses a simple algorithm: we try to allocate
6833 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
6834 * again from the start of the swap file searching for free spaces.
6836 * If it looks pretty clear that there are no free pages near our offset
6837 * we try to find less populated places doing a forward jump of
6838 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
6839 * without hurry, and then we jump again and so forth...
6841 * This function can be improved using a free list to avoid to guess
6842 * too much, since we could collect data about freed pages.
6844 * note: I implemented this function just after watching an episode of
6845 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
6847 static int vmFindContiguousPages(off_t
*first
, int n
) {
6848 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
6850 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
6851 server
.vm_near_pages
= 0;
6852 server
.vm_next_page
= 0;
6854 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
6855 base
= server
.vm_next_page
;
6857 while(offset
< server
.vm_pages
) {
6858 off_t
this = base
+offset
;
6860 redisLog(REDIS_DEBUG
, "THIS: %lld (%c)\n", (long long) this, vmFreePage(this) ? 'F' : 'X');
6861 /* If we overflow, restart from page zero */
6862 if (this >= server
.vm_pages
) {
6863 this -= server
.vm_pages
;
6865 /* Just overflowed, what we found on tail is no longer
6866 * interesting, as it's no longer contiguous. */
6870 if (vmFreePage(this)) {
6871 /* This is a free page */
6873 /* Already got N free pages? Return to the caller, with success */
6875 *first
= this-(n
-1);
6876 server
.vm_next_page
= this+1;
6880 /* The current one is not a free page */
6884 /* Fast-forward if the current page is not free and we already
6885 * searched enough near this place. */
6887 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
6888 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
6890 /* Note that even if we rewind after the jump, we are don't need
6891 * to make sure numfree is set to zero as we only jump *if* it
6892 * is set to zero. */
6894 /* Otherwise just check the next page */
6901 /* Swap the 'val' object relative to 'key' into disk. Store all the information
6902 * needed to later retrieve the object into the key object.
6903 * If we can't find enough contiguous empty pages to swap the object on disk
6904 * REDIS_ERR is returned. */
6905 static int vmSwapObject(robj
*key
, robj
*val
) {
6906 off_t pages
= rdbSavedObjectPages(val
);
6909 assert(key
->storage
== REDIS_VM_MEMORY
);
6910 assert(key
->refcount
== 1);
6911 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
6912 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
6913 redisLog(REDIS_WARNING
,
6914 "Critical VM problem in vmSwapObject(): can't seek: %s",
6918 rdbSaveObject(server
.vm_fp
,val
);
6919 key
->vm
.page
= page
;
6920 key
->vm
.usedpages
= pages
;
6921 key
->storage
= REDIS_VM_SWAPPED
;
6922 key
->vtype
= val
->type
;
6923 decrRefCount(val
); /* Deallocate the object from memory. */
6924 vmMarkPagesUsed(page
,pages
);
6925 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
6926 (unsigned char*) key
->ptr
,
6927 (unsigned long long) page
, (unsigned long long) pages
);
6928 server
.vm_stats_swapped_objects
++;
6929 server
.vm_stats_swapouts
++;
6933 /* Load the value object relative to the 'key' object from swap to memory.
6934 * The newly allocated object is returned.
6936 * If preview is true the unserialized object is returned to the caller but
6937 * no changes are made to the key object, nor the pages are marked as freed */
6938 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
6941 redisAssert(key
->storage
== REDIS_VM_SWAPPED
);
6942 if (fseeko(server
.vm_fp
,key
->vm
.page
*server
.vm_page_size
,SEEK_SET
) == -1) {
6943 redisLog(REDIS_WARNING
,
6944 "Unrecoverable VM problem in vmLoadObject(): can't seek: %s",
6948 val
= rdbLoadObject(key
->vtype
,server
.vm_fp
);
6950 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmLoadObject(): can't load object from swap file: %s", strerror(errno
));
6954 key
->storage
= REDIS_VM_MEMORY
;
6955 key
->vm
.atime
= server
.unixtime
;
6956 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
6957 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
6958 (unsigned char*) key
->ptr
);
6959 server
.vm_stats_swapped_objects
--;
6961 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
6962 (unsigned char*) key
->ptr
);
6964 server
.vm_stats_swapins
++;
6968 /* Plain object loading, from swap to memory */
6969 static robj
*vmLoadObject(robj
*key
) {
6970 return vmGenericLoadObject(key
,0);
6973 /* Just load the value on disk, without to modify the key.
6974 * This is useful when we want to perform some operation on the value
6975 * without to really bring it from swap to memory, like while saving the
6976 * dataset or rewriting the append only log. */
6977 static robj
*vmPreviewObject(robj
*key
) {
6978 return vmGenericLoadObject(key
,1);
6981 /* How a good candidate is this object for swapping?
6982 * The better candidate it is, the greater the returned value.
6984 * Currently we try to perform a fast estimation of the object size in
6985 * memory, and combine it with aging informations.
6987 * Basically swappability = idle-time * log(estimated size)
6989 * Bigger objects are preferred over smaller objects, but not
6990 * proportionally, this is why we use the logarithm. This algorithm is
6991 * just a first try and will probably be tuned later. */
6992 static double computeObjectSwappability(robj
*o
) {
6993 time_t age
= server
.unixtime
- o
->vm
.atime
;
6997 struct dictEntry
*de
;
7000 if (age
<= 0) return 0;
7003 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
7006 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
7011 listNode
*ln
= listFirst(l
);
7013 asize
= sizeof(list
);
7015 robj
*ele
= ln
->value
;
7018 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
7019 (sizeof(*o
)+sdslen(ele
->ptr
)) :
7021 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
7026 z
= (o
->type
== REDIS_ZSET
);
7027 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
7029 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
7030 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
7035 de
= dictGetRandomKey(d
);
7036 ele
= dictGetEntryKey(de
);
7037 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
7038 (sizeof(*o
)+sdslen(ele
->ptr
)) :
7040 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
7041 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
7045 return (double)asize
*log(1+asize
);
7048 /* Try to swap an object that's a good candidate for swapping.
7049 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
7050 * to swap any object at all. */
7051 static int vmSwapOneObject(void) {
7053 struct dictEntry
*best
= NULL
;
7054 double best_swappability
= 0;
7057 for (j
= 0; j
< server
.dbnum
; j
++) {
7058 redisDb
*db
= server
.db
+j
;
7059 int maxtries
= 1000;
7061 if (dictSize(db
->dict
) == 0) continue;
7062 for (i
= 0; i
< 5; i
++) {
7064 double swappability
;
7066 if (maxtries
) maxtries
--;
7067 de
= dictGetRandomKey(db
->dict
);
7068 key
= dictGetEntryKey(de
);
7069 val
= dictGetEntryVal(de
);
7070 if (key
->storage
!= REDIS_VM_MEMORY
) {
7071 if (maxtries
) i
--; /* don't count this try */
7074 swappability
= computeObjectSwappability(val
);
7075 if (!best
|| swappability
> best_swappability
) {
7077 best_swappability
= swappability
;
7082 redisLog(REDIS_DEBUG
,"No swappable key found!");
7085 key
= dictGetEntryKey(best
);
7086 val
= dictGetEntryVal(best
);
7088 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
7089 key
->ptr
, best_swappability
);
7091 /* Unshare the key if needed */
7092 if (key
->refcount
> 1) {
7093 robj
*newkey
= dupStringObject(key
);
7095 key
= dictGetEntryKey(best
) = newkey
;
7098 if (vmSwapObject(key
,val
) == REDIS_OK
) {
7099 dictGetEntryVal(best
) = NULL
;
7106 /* Return true if it's safe to swap out objects in a given moment.
7107 * Basically we don't want to swap objects out while there is a BGSAVE
7108 * or a BGAEOREWRITE running in backgroud. */
7109 static int vmCanSwapOut(void) {
7110 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
7113 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
7114 * and was deleted. Otherwise 0 is returned. */
7115 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
7119 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
7120 foundkey
= dictGetEntryKey(de
);
7121 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
7126 /* ================================= Debugging ============================== */
7128 static void debugCommand(redisClient
*c
) {
7129 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
7131 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
7132 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
7133 addReply(c
,shared
.err
);
7137 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
7138 addReply(c
,shared
.err
);
7141 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
7142 addReply(c
,shared
.ok
);
7143 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
7145 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
7146 addReply(c
,shared
.err
);
7149 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
7150 addReply(c
,shared
.ok
);
7151 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
7152 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
7156 addReply(c
,shared
.nokeyerr
);
7159 key
= dictGetEntryKey(de
);
7160 val
= dictGetEntryVal(de
);
7161 addReplySds(c
,sdscatprintf(sdsempty(),
7162 "+Key at:%p refcount:%d, value at:%p refcount:%d encoding:%d serializedlength:%lld\r\n",
7163 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
7164 val
->encoding
, rdbSavedObjectLen(val
)));
7165 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
7166 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
7169 if (!server
.vm_enabled
) {
7170 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
7174 addReply(c
,shared
.nokeyerr
);
7177 key
= dictGetEntryKey(de
);
7178 val
= dictGetEntryVal(de
);
7179 /* If the key is shared we want to create a copy */
7180 if (key
->refcount
> 1) {
7181 robj
*newkey
= dupStringObject(key
);
7183 key
= dictGetEntryKey(de
) = newkey
;
7186 if (key
->storage
!= REDIS_VM_MEMORY
) {
7187 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
7188 } else if (vmSwapObject(key
,val
) == REDIS_OK
) {
7189 dictGetEntryVal(de
) = NULL
;
7190 addReply(c
,shared
.ok
);
7192 addReply(c
,shared
.err
);
7195 addReplySds(c
,sdsnew(
7196 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPOUT <key>|RELOAD]\r\n"));
7200 static void _redisAssert(char *estr
) {
7201 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
7202 redisLog(REDIS_WARNING
,"==> %s\n",estr
);
7203 #ifdef HAVE_BACKTRACE
7204 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
7209 /* =================================== Main! ================================ */
7212 int linuxOvercommitMemoryValue(void) {
7213 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
7217 if (fgets(buf
,64,fp
) == NULL
) {
7226 void linuxOvercommitMemoryWarning(void) {
7227 if (linuxOvercommitMemoryValue() == 0) {
7228 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.");
7231 #endif /* __linux__ */
7233 static void daemonize(void) {
7237 if (fork() != 0) exit(0); /* parent exits */
7238 printf("New pid: %d\n", getpid());
7239 setsid(); /* create a new session */
7241 /* Every output goes to /dev/null. If Redis is daemonized but
7242 * the 'logfile' is set to 'stdout' in the configuration file
7243 * it will not log at all. */
7244 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
7245 dup2(fd
, STDIN_FILENO
);
7246 dup2(fd
, STDOUT_FILENO
);
7247 dup2(fd
, STDERR_FILENO
);
7248 if (fd
> STDERR_FILENO
) close(fd
);
7250 /* Try to write the pid file */
7251 fp
= fopen(server
.pidfile
,"w");
7253 fprintf(fp
,"%d\n",getpid());
7258 int main(int argc
, char **argv
) {
7261 resetServerSaveParams();
7262 loadServerConfig(argv
[1]);
7263 } else if (argc
> 2) {
7264 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
7267 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'");
7269 if (server
.daemonize
) daemonize();
7271 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
7273 linuxOvercommitMemoryWarning();
7275 if (server
.appendonly
) {
7276 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
7277 redisLog(REDIS_NOTICE
,"DB loaded from append only file");
7279 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
7280 redisLog(REDIS_NOTICE
,"DB loaded from disk");
7282 if (aeCreateFileEvent(server
.el
, server
.fd
, AE_READABLE
,
7283 acceptHandler
, NULL
) == AE_ERR
) oom("creating file event");
7284 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
7286 aeDeleteEventLoop(server
.el
);
7290 /* ============================= Backtrace support ========================= */
7292 #ifdef HAVE_BACKTRACE
7293 static char *findFuncName(void *pointer
, unsigned long *offset
);
7295 static void *getMcontextEip(ucontext_t
*uc
) {
7296 #if defined(__FreeBSD__)
7297 return (void*) uc
->uc_mcontext
.mc_eip
;
7298 #elif defined(__dietlibc__)
7299 return (void*) uc
->uc_mcontext
.eip
;
7300 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
7302 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
7304 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
7306 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
7307 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
7308 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
7310 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
7312 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
7313 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
7314 #elif defined(__ia64__) /* Linux IA64 */
7315 return (void*) uc
->uc_mcontext
.sc_ip
;
7321 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
7323 char **messages
= NULL
;
7324 int i
, trace_size
= 0;
7325 unsigned long offset
=0;
7326 ucontext_t
*uc
= (ucontext_t
*) secret
;
7328 REDIS_NOTUSED(info
);
7330 redisLog(REDIS_WARNING
,
7331 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
7332 infostring
= genRedisInfoString();
7333 redisLog(REDIS_WARNING
, "%s",infostring
);
7334 /* It's not safe to sdsfree() the returned string under memory
7335 * corruption conditions. Let it leak as we are going to abort */
7337 trace_size
= backtrace(trace
, 100);
7338 /* overwrite sigaction with caller's address */
7339 if (getMcontextEip(uc
) != NULL
) {
7340 trace
[1] = getMcontextEip(uc
);
7342 messages
= backtrace_symbols(trace
, trace_size
);
7344 for (i
=1; i
<trace_size
; ++i
) {
7345 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
7347 p
= strchr(messages
[i
],'+');
7348 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
7349 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
7351 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
7354 /* free(messages); Don't call free() with possibly corrupted memory. */
7358 static void setupSigSegvAction(void) {
7359 struct sigaction act
;
7361 sigemptyset (&act
.sa_mask
);
7362 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
7363 * is used. Otherwise, sa_handler is used */
7364 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
7365 act
.sa_sigaction
= segvHandler
;
7366 sigaction (SIGSEGV
, &act
, NULL
);
7367 sigaction (SIGBUS
, &act
, NULL
);
7368 sigaction (SIGFPE
, &act
, NULL
);
7369 sigaction (SIGILL
, &act
, NULL
);
7370 sigaction (SIGBUS
, &act
, NULL
);
7374 #include "staticsymbols.h"
7375 /* This function try to convert a pointer into a function name. It's used in
7376 * oreder to provide a backtrace under segmentation fault that's able to
7377 * display functions declared as static (otherwise the backtrace is useless). */
7378 static char *findFuncName(void *pointer
, unsigned long *offset
){
7380 unsigned long off
, minoff
= 0;
7382 /* Try to match against the Symbol with the smallest offset */
7383 for (i
=0; symsTable
[i
].pointer
; i
++) {
7384 unsigned long lp
= (unsigned long) pointer
;
7386 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
7387 off
=lp
-symsTable
[i
].pointer
;
7388 if (ret
< 0 || off
< minoff
) {
7394 if (ret
== -1) return NULL
;
7396 return symsTable
[ret
].name
;
7398 #else /* HAVE_BACKTRACE */
7399 static void setupSigSegvAction(void) {
7401 #endif /* HAVE_BACKTRACE */