2 * Copyright (c) 2009-2012, 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.
41 #include <arpa/inet.h>
45 #include <sys/resource.h>
50 #include <sys/resource.h>
51 #include <sys/utsname.h>
53 /* Our shared "common" objects */
55 struct sharedObjectsStruct shared
;
57 /* Global vars that are actually used as constants. The following double
58 * values are used for double on-disk serialization, and are initialized
59 * at runtime to avoid strange compiler optimizations. */
61 double R_Zero
, R_PosInf
, R_NegInf
, R_Nan
;
63 /*================================= Globals ================================= */
66 struct redisServer server
; /* server global state */
67 struct redisCommand
*commandTable
;
71 * Every entry is composed of the following fields:
73 * name: a string representing the command name.
74 * function: pointer to the C function implementing the command.
75 * arity: number of arguments, it is possible to use -N to say >= N
76 * sflags: command flags as string. See below for a table of flags.
77 * flags: flags as bitmask. Computed by Redis using the 'sflags' field.
78 * get_keys_proc: an optional function to get key arguments from a command.
79 * This is only used when the following three fields are not
80 * enough to specify what arguments are keys.
81 * first_key_index: first argument that is a key
82 * last_key_index: last argument that is a key
83 * key_step: step to get all the keys from first to last argument. For instance
84 * in MSET the step is two since arguments are key,val,key,val,...
85 * microseconds: microseconds of total execution time for this command.
86 * calls: total number of calls of this command.
88 * The flags, microseconds and calls fields are computed by Redis and should
89 * always be set to zero.
91 * Command flags are expressed using strings where every character represents
92 * a flag. Later the populateCommandTable() function will take care of
93 * populating the real 'flags' field using this characters.
95 * This is the meaning of the flags:
97 * w: write command (may modify the key space).
98 * r: read command (will never modify the key space).
99 * m: may increase memory usage once called. Don't allow if out of memory.
100 * a: admin command, like SAVE or SHUTDOWN.
101 * p: Pub/Sub related command.
102 * f: force replication of this command, regarless of server.dirty.
103 * s: command not allowed in scripts.
104 * R: random command. Command is not deterministic, that is, the same command
105 * with the same arguments, with the same key space, may have different
106 * results. For instance SPOP and RANDOMKEY are two random commands.
107 * S: Sort command output array if called from script, so that the output
109 * l: Allow command while loading the database.
110 * t: Allow command while a slave has stale data but is not allowed to
111 * server this data. Normally no command is accepted in this condition
113 * M: Do not automatically propagate the command on MONITOR.
115 struct redisCommand redisCommandTable
[] = {
116 {"get",getCommand
,2,"r",0,NULL
,1,1,1,0,0},
117 {"set",setCommand
,3,"wm",0,noPreloadGetKeys
,1,1,1,0,0},
118 {"setnx",setnxCommand
,3,"wm",0,noPreloadGetKeys
,1,1,1,0,0},
119 {"setex",setexCommand
,4,"wm",0,noPreloadGetKeys
,1,1,1,0,0},
120 {"psetex",psetexCommand
,4,"wm",0,noPreloadGetKeys
,1,1,1,0,0},
121 {"append",appendCommand
,3,"wm",0,NULL
,1,1,1,0,0},
122 {"strlen",strlenCommand
,2,"r",0,NULL
,1,1,1,0,0},
123 {"del",delCommand
,-2,"w",0,noPreloadGetKeys
,1,-1,1,0,0},
124 {"exists",existsCommand
,2,"r",0,NULL
,1,1,1,0,0},
125 {"setbit",setbitCommand
,4,"wm",0,NULL
,1,1,1,0,0},
126 {"getbit",getbitCommand
,3,"r",0,NULL
,1,1,1,0,0},
127 {"setrange",setrangeCommand
,4,"wm",0,NULL
,1,1,1,0,0},
128 {"getrange",getrangeCommand
,4,"r",0,NULL
,1,1,1,0,0},
129 {"substr",getrangeCommand
,4,"r",0,NULL
,1,1,1,0,0},
130 {"incr",incrCommand
,2,"wm",0,NULL
,1,1,1,0,0},
131 {"decr",decrCommand
,2,"wm",0,NULL
,1,1,1,0,0},
132 {"mget",mgetCommand
,-2,"r",0,NULL
,1,-1,1,0,0},
133 {"rpush",rpushCommand
,-3,"wm",0,NULL
,1,1,1,0,0},
134 {"lpush",lpushCommand
,-3,"wm",0,NULL
,1,1,1,0,0},
135 {"rpushx",rpushxCommand
,3,"wm",0,NULL
,1,1,1,0,0},
136 {"lpushx",lpushxCommand
,3,"wm",0,NULL
,1,1,1,0,0},
137 {"linsert",linsertCommand
,5,"wm",0,NULL
,1,1,1,0,0},
138 {"rpop",rpopCommand
,2,"w",0,NULL
,1,1,1,0,0},
139 {"lpop",lpopCommand
,2,"w",0,NULL
,1,1,1,0,0},
140 {"brpop",brpopCommand
,-3,"ws",0,NULL
,1,1,1,0,0},
141 {"brpoplpush",brpoplpushCommand
,4,"wms",0,NULL
,1,2,1,0,0},
142 {"blpop",blpopCommand
,-3,"ws",0,NULL
,1,-2,1,0,0},
143 {"llen",llenCommand
,2,"r",0,NULL
,1,1,1,0,0},
144 {"lindex",lindexCommand
,3,"r",0,NULL
,1,1,1,0,0},
145 {"lset",lsetCommand
,4,"wm",0,NULL
,1,1,1,0,0},
146 {"lrange",lrangeCommand
,4,"r",0,NULL
,1,1,1,0,0},
147 {"ltrim",ltrimCommand
,4,"w",0,NULL
,1,1,1,0,0},
148 {"lrem",lremCommand
,4,"w",0,NULL
,1,1,1,0,0},
149 {"rpoplpush",rpoplpushCommand
,3,"wm",0,NULL
,1,2,1,0,0},
150 {"sadd",saddCommand
,-3,"wm",0,NULL
,1,1,1,0,0},
151 {"srem",sremCommand
,-3,"w",0,NULL
,1,1,1,0,0},
152 {"smove",smoveCommand
,4,"w",0,NULL
,1,2,1,0,0},
153 {"sismember",sismemberCommand
,3,"r",0,NULL
,1,1,1,0,0},
154 {"scard",scardCommand
,2,"r",0,NULL
,1,1,1,0,0},
155 {"spop",spopCommand
,2,"wRs",0,NULL
,1,1,1,0,0},
156 {"srandmember",srandmemberCommand
,-2,"rR",0,NULL
,1,1,1,0,0},
157 {"sinter",sinterCommand
,-2,"rS",0,NULL
,1,-1,1,0,0},
158 {"sinterstore",sinterstoreCommand
,-3,"wm",0,NULL
,1,-1,1,0,0},
159 {"sunion",sunionCommand
,-2,"rS",0,NULL
,1,-1,1,0,0},
160 {"sunionstore",sunionstoreCommand
,-3,"wm",0,NULL
,1,-1,1,0,0},
161 {"sdiff",sdiffCommand
,-2,"rS",0,NULL
,1,-1,1,0,0},
162 {"sdiffstore",sdiffstoreCommand
,-3,"wm",0,NULL
,1,-1,1,0,0},
163 {"smembers",sinterCommand
,2,"rS",0,NULL
,1,1,1,0,0},
164 {"zadd",zaddCommand
,-4,"wm",0,NULL
,1,1,1,0,0},
165 {"zincrby",zincrbyCommand
,4,"wm",0,NULL
,1,1,1,0,0},
166 {"zrem",zremCommand
,-3,"w",0,NULL
,1,1,1,0,0},
167 {"zremrangebyscore",zremrangebyscoreCommand
,4,"w",0,NULL
,1,1,1,0,0},
168 {"zremrangebyrank",zremrangebyrankCommand
,4,"w",0,NULL
,1,1,1,0,0},
169 {"zunionstore",zunionstoreCommand
,-4,"wm",0,zunionInterGetKeys
,0,0,0,0,0},
170 {"zinterstore",zinterstoreCommand
,-4,"wm",0,zunionInterGetKeys
,0,0,0,0,0},
171 {"zrange",zrangeCommand
,-4,"r",0,NULL
,1,1,1,0,0},
172 {"zrangebyscore",zrangebyscoreCommand
,-4,"r",0,NULL
,1,1,1,0,0},
173 {"zrevrangebyscore",zrevrangebyscoreCommand
,-4,"r",0,NULL
,1,1,1,0,0},
174 {"zcount",zcountCommand
,4,"r",0,NULL
,1,1,1,0,0},
175 {"zrevrange",zrevrangeCommand
,-4,"r",0,NULL
,1,1,1,0,0},
176 {"zcard",zcardCommand
,2,"r",0,NULL
,1,1,1,0,0},
177 {"zscore",zscoreCommand
,3,"r",0,NULL
,1,1,1,0,0},
178 {"zrank",zrankCommand
,3,"r",0,NULL
,1,1,1,0,0},
179 {"zrevrank",zrevrankCommand
,3,"r",0,NULL
,1,1,1,0,0},
180 {"hset",hsetCommand
,4,"wm",0,NULL
,1,1,1,0,0},
181 {"hsetnx",hsetnxCommand
,4,"wm",0,NULL
,1,1,1,0,0},
182 {"hget",hgetCommand
,3,"r",0,NULL
,1,1,1,0,0},
183 {"hmset",hmsetCommand
,-4,"wm",0,NULL
,1,1,1,0,0},
184 {"hmget",hmgetCommand
,-3,"r",0,NULL
,1,1,1,0,0},
185 {"hincrby",hincrbyCommand
,4,"wm",0,NULL
,1,1,1,0,0},
186 {"hincrbyfloat",hincrbyfloatCommand
,4,"wm",0,NULL
,1,1,1,0,0},
187 {"hdel",hdelCommand
,-3,"w",0,NULL
,1,1,1,0,0},
188 {"hlen",hlenCommand
,2,"r",0,NULL
,1,1,1,0,0},
189 {"hkeys",hkeysCommand
,2,"rS",0,NULL
,1,1,1,0,0},
190 {"hvals",hvalsCommand
,2,"rS",0,NULL
,1,1,1,0,0},
191 {"hgetall",hgetallCommand
,2,"r",0,NULL
,1,1,1,0,0},
192 {"hexists",hexistsCommand
,3,"r",0,NULL
,1,1,1,0,0},
193 {"incrby",incrbyCommand
,3,"wm",0,NULL
,1,1,1,0,0},
194 {"decrby",decrbyCommand
,3,"wm",0,NULL
,1,1,1,0,0},
195 {"incrbyfloat",incrbyfloatCommand
,3,"wm",0,NULL
,1,1,1,0,0},
196 {"getset",getsetCommand
,3,"wm",0,NULL
,1,1,1,0,0},
197 {"mset",msetCommand
,-3,"wm",0,NULL
,1,-1,2,0,0},
198 {"msetnx",msetnxCommand
,-3,"wm",0,NULL
,1,-1,2,0,0},
199 {"randomkey",randomkeyCommand
,1,"rR",0,NULL
,0,0,0,0,0},
200 {"select",selectCommand
,2,"r",0,NULL
,0,0,0,0,0},
201 {"move",moveCommand
,3,"w",0,NULL
,1,1,1,0,0},
202 {"rename",renameCommand
,3,"w",0,renameGetKeys
,1,2,1,0,0},
203 {"renamenx",renamenxCommand
,3,"w",0,renameGetKeys
,1,2,1,0,0},
204 {"expire",expireCommand
,3,"w",0,NULL
,1,1,1,0,0},
205 {"expireat",expireatCommand
,3,"w",0,NULL
,1,1,1,0,0},
206 {"pexpire",pexpireCommand
,3,"w",0,NULL
,1,1,1,0,0},
207 {"pexpireat",pexpireatCommand
,3,"w",0,NULL
,1,1,1,0,0},
208 {"keys",keysCommand
,2,"rS",0,NULL
,0,0,0,0,0},
209 {"dbsize",dbsizeCommand
,1,"r",0,NULL
,0,0,0,0,0},
210 {"auth",authCommand
,2,"rs",0,NULL
,0,0,0,0,0},
211 {"ping",pingCommand
,1,"r",0,NULL
,0,0,0,0,0},
212 {"echo",echoCommand
,2,"r",0,NULL
,0,0,0,0,0},
213 {"save",saveCommand
,1,"ars",0,NULL
,0,0,0,0,0},
214 {"bgsave",bgsaveCommand
,1,"ar",0,NULL
,0,0,0,0,0},
215 {"bgrewriteaof",bgrewriteaofCommand
,1,"ar",0,NULL
,0,0,0,0,0},
216 {"shutdown",shutdownCommand
,-1,"ar",0,NULL
,0,0,0,0,0},
217 {"lastsave",lastsaveCommand
,1,"r",0,NULL
,0,0,0,0,0},
218 {"type",typeCommand
,2,"r",0,NULL
,1,1,1,0,0},
219 {"multi",multiCommand
,1,"rs",0,NULL
,0,0,0,0,0},
220 {"exec",execCommand
,1,"sM",0,NULL
,0,0,0,0,0},
221 {"discard",discardCommand
,1,"rs",0,NULL
,0,0,0,0,0},
222 {"sync",syncCommand
,1,"ars",0,NULL
,0,0,0,0,0},
223 {"replconf",replconfCommand
,-1,"ars",0,NULL
,0,0,0,0,0},
224 {"flushdb",flushdbCommand
,1,"w",0,NULL
,0,0,0,0,0},
225 {"flushall",flushallCommand
,1,"w",0,NULL
,0,0,0,0,0},
226 {"sort",sortCommand
,-2,"wm",0,NULL
,1,1,1,0,0},
227 {"info",infoCommand
,-1,"rlt",0,NULL
,0,0,0,0,0},
228 {"monitor",monitorCommand
,1,"ars",0,NULL
,0,0,0,0,0},
229 {"ttl",ttlCommand
,2,"r",0,NULL
,1,1,1,0,0},
230 {"pttl",pttlCommand
,2,"r",0,NULL
,1,1,1,0,0},
231 {"persist",persistCommand
,2,"w",0,NULL
,1,1,1,0,0},
232 {"slaveof",slaveofCommand
,3,"ast",0,NULL
,0,0,0,0,0},
233 {"debug",debugCommand
,-2,"as",0,NULL
,0,0,0,0,0},
234 {"config",configCommand
,-2,"ar",0,NULL
,0,0,0,0,0},
235 {"subscribe",subscribeCommand
,-2,"rpslt",0,NULL
,0,0,0,0,0},
236 {"unsubscribe",unsubscribeCommand
,-1,"rpslt",0,NULL
,0,0,0,0,0},
237 {"psubscribe",psubscribeCommand
,-2,"rpslt",0,NULL
,0,0,0,0,0},
238 {"punsubscribe",punsubscribeCommand
,-1,"rpslt",0,NULL
,0,0,0,0,0},
239 {"publish",publishCommand
,3,"pflt",0,NULL
,0,0,0,0,0},
240 {"watch",watchCommand
,-2,"rs",0,noPreloadGetKeys
,1,-1,1,0,0},
241 {"unwatch",unwatchCommand
,1,"rs",0,NULL
,0,0,0,0,0},
242 {"restore",restoreCommand
,4,"awm",0,NULL
,1,1,1,0,0},
243 {"migrate",migrateCommand
,6,"aw",0,NULL
,0,0,0,0,0},
244 {"dump",dumpCommand
,2,"ar",0,NULL
,1,1,1,0,0},
245 {"object",objectCommand
,-2,"r",0,NULL
,2,2,2,0,0},
246 {"client",clientCommand
,-2,"ar",0,NULL
,0,0,0,0,0},
247 {"eval",evalCommand
,-3,"s",0,zunionInterGetKeys
,0,0,0,0,0},
248 {"evalsha",evalShaCommand
,-3,"s",0,zunionInterGetKeys
,0,0,0,0,0},
249 {"slowlog",slowlogCommand
,-2,"r",0,NULL
,0,0,0,0,0},
250 {"script",scriptCommand
,-2,"ras",0,NULL
,0,0,0,0,0},
251 {"time",timeCommand
,1,"rR",0,NULL
,0,0,0,0,0},
252 {"bitop",bitopCommand
,-4,"wm",0,NULL
,2,-1,1,0,0},
253 {"bitcount",bitcountCommand
,-2,"r",0,NULL
,1,1,1,0,0}
256 /*============================ Utility functions ============================ */
258 /* Low level logging. To use only for very big messages, otherwise
259 * redisLog() is to prefer. */
260 void redisLogRaw(int level
, const char *msg
) {
261 const int syslogLevelMap
[] = { LOG_DEBUG
, LOG_INFO
, LOG_NOTICE
, LOG_WARNING
};
262 const char *c
= ".-*#";
265 int rawmode
= (level
& REDIS_LOG_RAW
);
267 level
&= 0xff; /* clear flags */
268 if (level
< server
.verbosity
) return;
270 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
274 fprintf(fp
,"%s",msg
);
279 gettimeofday(&tv
,NULL
);
280 off
= strftime(buf
,sizeof(buf
),"%d %b %H:%M:%S.",localtime(&tv
.tv_sec
));
281 snprintf(buf
+off
,sizeof(buf
)-off
,"%03d",(int)tv
.tv_usec
/1000);
282 fprintf(fp
,"[%d] %s %c %s\n",(int)getpid(),buf
,c
[level
],msg
);
286 if (server
.logfile
) fclose(fp
);
288 if (server
.syslog_enabled
) syslog(syslogLevelMap
[level
], "%s", msg
);
291 /* Like redisLogRaw() but with printf-alike support. This is the funciton that
292 * is used across the code. The raw version is only used in order to dump
293 * the INFO output on crash. */
294 void redisLog(int level
, const char *fmt
, ...) {
296 char msg
[REDIS_MAX_LOGMSG_LEN
];
298 if ((level
&0xff) < server
.verbosity
) return;
301 vsnprintf(msg
, sizeof(msg
), fmt
, ap
);
304 redisLogRaw(level
,msg
);
307 /* Log a fixed message without printf-alike capabilities, in a way that is
308 * safe to call from a signal handler.
310 * We actually use this only for signals that are not fatal from the point
311 * of view of Redis. Signals that are going to kill the server anyway and
312 * where we need printf-alike features are served by redisLog(). */
313 void redisLogFromHandler(int level
, const char *msg
) {
317 if ((level
&0xff) < server
.verbosity
||
318 (server
.logfile
== NULL
&& server
.daemonize
)) return;
319 fd
= server
.logfile
?
320 open(server
.logfile
, O_APPEND
|O_CREAT
|O_WRONLY
, 0644) :
322 if (fd
== -1) return;
323 ll2string(buf
,sizeof(buf
),getpid());
324 if (write(fd
,"[",1) == -1) goto err
;
325 if (write(fd
,buf
,strlen(buf
)) == -1) goto err
;
326 if (write(fd
," | signal handler] (",20) == -1) goto err
;
327 ll2string(buf
,sizeof(buf
),time(NULL
));
328 if (write(fd
,buf
,strlen(buf
)) == -1) goto err
;
329 if (write(fd
,") ",2) == -1) goto err
;
330 if (write(fd
,msg
,strlen(msg
)) == -1) goto err
;
331 if (write(fd
,"\n",1) == -1) goto err
;
333 if (server
.logfile
) close(fd
);
336 /* Return the UNIX time in microseconds */
337 long long ustime(void) {
341 gettimeofday(&tv
, NULL
);
342 ust
= ((long long)tv
.tv_sec
)*1000000;
347 /* Return the UNIX time in milliseconds */
348 long long mstime(void) {
349 return ustime()/1000;
352 /* After an RDB dump or AOF rewrite we exit from children using _exit() instead of
353 * exit(), because the latter may interact with the same file objects used by
354 * the parent process. However if we are testing the coverage normal exit() is
355 * used in order to obtain the right coverage information. */
356 void exitFromChild(int retcode
) {
364 /*====================== Hash table type implementation ==================== */
366 /* This is an hash table type that uses the SDS dynamic strings libary as
367 * keys and radis objects as values (objects can hold SDS strings,
370 void dictVanillaFree(void *privdata
, void *val
)
372 DICT_NOTUSED(privdata
);
376 void dictListDestructor(void *privdata
, void *val
)
378 DICT_NOTUSED(privdata
);
379 listRelease((list
*)val
);
382 int dictSdsKeyCompare(void *privdata
, const void *key1
,
386 DICT_NOTUSED(privdata
);
388 l1
= sdslen((sds
)key1
);
389 l2
= sdslen((sds
)key2
);
390 if (l1
!= l2
) return 0;
391 return memcmp(key1
, key2
, l1
) == 0;
394 /* A case insensitive version used for the command lookup table and other
395 * places where case insensitive non binary-safe comparison is needed. */
396 int dictSdsKeyCaseCompare(void *privdata
, const void *key1
,
399 DICT_NOTUSED(privdata
);
401 return strcasecmp(key1
, key2
) == 0;
404 void dictRedisObjectDestructor(void *privdata
, void *val
)
406 DICT_NOTUSED(privdata
);
408 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
412 void dictSdsDestructor(void *privdata
, void *val
)
414 DICT_NOTUSED(privdata
);
419 int dictObjKeyCompare(void *privdata
, const void *key1
,
422 const robj
*o1
= key1
, *o2
= key2
;
423 return dictSdsKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
426 unsigned int dictObjHash(const void *key
) {
428 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
431 unsigned int dictSdsHash(const void *key
) {
432 return dictGenHashFunction((unsigned char*)key
, sdslen((char*)key
));
435 unsigned int dictSdsCaseHash(const void *key
) {
436 return dictGenCaseHashFunction((unsigned char*)key
, sdslen((char*)key
));
439 int dictEncObjKeyCompare(void *privdata
, const void *key1
,
442 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
445 if (o1
->encoding
== REDIS_ENCODING_INT
&&
446 o2
->encoding
== REDIS_ENCODING_INT
)
447 return o1
->ptr
== o2
->ptr
;
449 o1
= getDecodedObject(o1
);
450 o2
= getDecodedObject(o2
);
451 cmp
= dictSdsKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
457 unsigned int dictEncObjHash(const void *key
) {
458 robj
*o
= (robj
*) key
;
460 if (o
->encoding
== REDIS_ENCODING_RAW
) {
461 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
463 if (o
->encoding
== REDIS_ENCODING_INT
) {
467 len
= ll2string(buf
,32,(long)o
->ptr
);
468 return dictGenHashFunction((unsigned char*)buf
, len
);
472 o
= getDecodedObject(o
);
473 hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
480 /* Sets type hash table */
481 dictType setDictType
= {
482 dictEncObjHash
, /* hash function */
485 dictEncObjKeyCompare
, /* key compare */
486 dictRedisObjectDestructor
, /* key destructor */
487 NULL
/* val destructor */
490 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
491 dictType zsetDictType
= {
492 dictEncObjHash
, /* hash function */
495 dictEncObjKeyCompare
, /* key compare */
496 dictRedisObjectDestructor
, /* key destructor */
497 NULL
/* val destructor */
500 /* Db->dict, keys are sds strings, vals are Redis objects. */
501 dictType dbDictType
= {
502 dictSdsHash
, /* hash function */
505 dictSdsKeyCompare
, /* key compare */
506 dictSdsDestructor
, /* key destructor */
507 dictRedisObjectDestructor
/* val destructor */
510 /* server.lua_scripts sha (as sds string) -> scripts (as robj) cache. */
511 dictType shaScriptObjectDictType
= {
512 dictSdsCaseHash
, /* hash function */
515 dictSdsKeyCaseCompare
, /* key compare */
516 dictSdsDestructor
, /* key destructor */
517 dictRedisObjectDestructor
/* val destructor */
521 dictType keyptrDictType
= {
522 dictSdsHash
, /* hash function */
525 dictSdsKeyCompare
, /* key compare */
526 NULL
, /* key destructor */
527 NULL
/* val destructor */
530 /* Command table. sds string -> command struct pointer. */
531 dictType commandTableDictType
= {
532 dictSdsCaseHash
, /* hash function */
535 dictSdsKeyCaseCompare
, /* key compare */
536 dictSdsDestructor
, /* key destructor */
537 NULL
/* val destructor */
540 /* Hash type hash table (note that small hashes are represented with zimpaps) */
541 dictType hashDictType
= {
542 dictEncObjHash
, /* hash function */
545 dictEncObjKeyCompare
, /* key compare */
546 dictRedisObjectDestructor
, /* key destructor */
547 dictRedisObjectDestructor
/* val destructor */
550 /* Keylist hash table type has unencoded redis objects as keys and
551 * lists as values. It's used for blocking operations (BLPOP) and to
552 * map swapped keys to a list of clients waiting for this keys to be loaded. */
553 dictType keylistDictType
= {
554 dictObjHash
, /* hash function */
557 dictObjKeyCompare
, /* key compare */
558 dictRedisObjectDestructor
, /* key destructor */
559 dictListDestructor
/* val destructor */
562 int htNeedsResize(dict
*dict
) {
563 long long size
, used
;
565 size
= dictSlots(dict
);
566 used
= dictSize(dict
);
567 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
568 (used
*100/size
< REDIS_HT_MINFILL
));
571 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
572 * we resize the hash table to save memory */
573 void tryResizeHashTables(void) {
576 for (j
= 0; j
< server
.dbnum
; j
++) {
577 if (htNeedsResize(server
.db
[j
].dict
))
578 dictResize(server
.db
[j
].dict
);
579 if (htNeedsResize(server
.db
[j
].expires
))
580 dictResize(server
.db
[j
].expires
);
584 /* Our hash table implementation performs rehashing incrementally while
585 * we write/read from the hash table. Still if the server is idle, the hash
586 * table will use two tables for a long time. So we try to use 1 millisecond
587 * of CPU time at every serverCron() loop in order to rehash some key. */
588 void incrementallyRehash(void) {
591 for (j
= 0; j
< server
.dbnum
; j
++) {
592 /* Keys dictionary */
593 if (dictIsRehashing(server
.db
[j
].dict
)) {
594 dictRehashMilliseconds(server
.db
[j
].dict
,1);
595 break; /* already used our millisecond for this loop... */
598 if (dictIsRehashing(server
.db
[j
].expires
)) {
599 dictRehashMilliseconds(server
.db
[j
].expires
,1);
600 break; /* already used our millisecond for this loop... */
605 /* This function is called once a background process of some kind terminates,
606 * as we want to avoid resizing the hash tables when there is a child in order
607 * to play well with copy-on-write (otherwise when a resize happens lots of
608 * memory pages are copied). The goal of this function is to update the ability
609 * for dict.c to resize the hash tables accordingly to the fact we have o not
611 void updateDictResizePolicy(void) {
612 if (server
.rdb_child_pid
== -1 && server
.aof_child_pid
== -1)
618 /* ======================= Cron: called every 100 ms ======================== */
620 /* Try to expire a few timed out keys. The algorithm used is adaptive and
621 * will use few CPU cycles if there are few expiring keys, otherwise
622 * it will get more aggressive to avoid that too much memory is used by
623 * keys that can be removed from the keyspace. */
624 void activeExpireCycle(void) {
625 int j
, iteration
= 0;
626 long long start
= ustime(), timelimit
;
628 /* We can use at max REDIS_EXPIRELOOKUPS_TIME_PERC percentage of CPU time
629 * per iteration. Since this function gets called with a frequency of
630 * REDIS_HZ times per second, the following is the max amount of
631 * microseconds we can spend in this function. */
632 timelimit
= 1000000*REDIS_EXPIRELOOKUPS_TIME_PERC
/REDIS_HZ
/100;
633 if (timelimit
<= 0) timelimit
= 1;
635 for (j
= 0; j
< server
.dbnum
; j
++) {
637 redisDb
*db
= server
.db
+j
;
639 /* Continue to expire if at the end of the cycle more than 25%
640 * of the keys were expired. */
642 unsigned long num
= dictSize(db
->expires
);
643 unsigned long slots
= dictSlots(db
->expires
);
644 long long now
= mstime();
646 /* When there are less than 1% filled slots getting random
647 * keys is expensive, so stop here waiting for better times...
648 * The dictionary will be resized asap. */
649 if (num
&& slots
> DICT_HT_INITIAL_SIZE
&&
650 (num
*100/slots
< 1)) break;
652 /* The main collection cycle. Sample random keys among keys
653 * with an expire set, checking for expired ones. */
655 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
656 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
661 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
662 t
= dictGetSignedIntegerVal(de
);
664 sds key
= dictGetKey(de
);
665 robj
*keyobj
= createStringObject(key
,sdslen(key
));
667 propagateExpire(db
,keyobj
);
669 decrRefCount(keyobj
);
671 server
.stat_expiredkeys
++;
674 /* We can't block forever here even if there are many keys to
675 * expire. So after a given amount of milliseconds return to the
676 * caller waiting for the other active expire cycle. */
678 if ((iteration
& 0xf) == 0 && /* check once every 16 cycles. */
679 (ustime()-start
) > timelimit
) return;
680 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
684 void updateLRUClock(void) {
685 server
.lruclock
= (server
.unixtime
/REDIS_LRU_CLOCK_RESOLUTION
) &
690 /* Add a sample to the operations per second array of samples. */
691 void trackOperationsPerSecond(void) {
692 long long t
= mstime() - server
.ops_sec_last_sample_time
;
693 long long ops
= server
.stat_numcommands
- server
.ops_sec_last_sample_ops
;
696 ops_sec
= t
> 0 ? (ops
*1000/t
) : 0;
698 server
.ops_sec_samples
[server
.ops_sec_idx
] = ops_sec
;
699 server
.ops_sec_idx
= (server
.ops_sec_idx
+1) % REDIS_OPS_SEC_SAMPLES
;
700 server
.ops_sec_last_sample_time
= mstime();
701 server
.ops_sec_last_sample_ops
= server
.stat_numcommands
;
704 /* Return the mean of all the samples. */
705 long long getOperationsPerSecond(void) {
709 for (j
= 0; j
< REDIS_OPS_SEC_SAMPLES
; j
++)
710 sum
+= server
.ops_sec_samples
[j
];
711 return sum
/ REDIS_OPS_SEC_SAMPLES
;
714 /* Check for timeouts. Returns non-zero if the client was terminated */
715 int clientsCronHandleTimeout(redisClient
*c
) {
716 time_t now
= server
.unixtime
;
718 if (server
.maxidletime
&&
719 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
720 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
721 !(c
->flags
& REDIS_BLOCKED
) && /* no timeout for BLPOP */
722 dictSize(c
->pubsub_channels
) == 0 && /* no timeout for pubsub */
723 listLength(c
->pubsub_patterns
) == 0 &&
724 (now
- c
->lastinteraction
> server
.maxidletime
))
726 redisLog(REDIS_VERBOSE
,"Closing idle client");
729 } else if (c
->flags
& REDIS_BLOCKED
) {
730 if (c
->bpop
.timeout
!= 0 && c
->bpop
.timeout
< now
) {
731 addReply(c
,shared
.nullmultibulk
);
732 unblockClientWaitingData(c
);
738 /* The client query buffer is an sds.c string that can end with a lot of
739 * free space not used, this function reclaims space if needed.
741 * The funciton always returns 0 as it never terminates the client. */
742 int clientsCronResizeQueryBuffer(redisClient
*c
) {
743 size_t querybuf_size
= sdsAllocSize(c
->querybuf
);
744 time_t idletime
= server
.unixtime
- c
->lastinteraction
;
746 /* There are two conditions to resize the query buffer:
747 * 1) Query buffer is > BIG_ARG and too big for latest peak.
748 * 2) Client is inactive and the buffer is bigger than 1k. */
749 if (((querybuf_size
> REDIS_MBULK_BIG_ARG
) &&
750 (querybuf_size
/(c
->querybuf_peak
+1)) > 2) ||
751 (querybuf_size
> 1024 && idletime
> 2))
753 /* Only resize the query buffer if it is actually wasting space. */
754 if (sdsavail(c
->querybuf
) > 1024) {
755 c
->querybuf
= sdsRemoveFreeSpace(c
->querybuf
);
758 /* Reset the peak again to capture the peak memory usage in the next
760 c
->querybuf_peak
= 0;
764 void clientsCron(void) {
765 /* Make sure to process at least 1/(REDIS_HZ*10) of clients per call.
766 * Since this function is called REDIS_HZ times per second we are sure that
767 * in the worst case we process all the clients in 10 seconds.
768 * In normal conditions (a reasonable number of clients) we process
769 * all the clients in a shorter time. */
770 int numclients
= listLength(server
.clients
);
771 int iterations
= numclients
/(REDIS_HZ
*10);
774 iterations
= (numclients
< 50) ? numclients
: 50;
775 while(listLength(server
.clients
) && iterations
--) {
779 /* Rotate the list, take the current head, process.
780 * This way if the client must be removed from the list it's the
781 * first element and we don't incur into O(N) computation. */
782 listRotate(server
.clients
);
783 head
= listFirst(server
.clients
);
784 c
= listNodeValue(head
);
785 /* The following functions do different service checks on the client.
786 * The protocol is that they return non-zero if the client was
788 if (clientsCronHandleTimeout(c
)) continue;
789 if (clientsCronResizeQueryBuffer(c
)) continue;
793 /* This is our timer interrupt, called REDIS_HZ times per second.
794 * Here is where we do a number of things that need to be done asynchronously.
797 * - Active expired keys collection (it is also performed in a lazy way on
799 * - Software watchdong.
800 * - Update some statistic.
801 * - Incremental rehashing of the DBs hash tables.
802 * - Triggering BGSAVE / AOF rewrite, and handling of terminated children.
803 * - Clients timeout of differnet kinds.
804 * - Replication reconnection.
807 * Everything directly called here will be called REDIS_HZ times per second,
808 * so in order to throttle execution of things we want to do less frequently
809 * a macro is used: run_with_period(milliseconds) { .... }
812 int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
814 REDIS_NOTUSED(eventLoop
);
816 REDIS_NOTUSED(clientData
);
818 /* Software watchdog: deliver the SIGALRM that will reach the signal
819 * handler if we don't return here fast enough. */
820 if (server
.watchdog_period
) watchdogScheduleSignal(server
.watchdog_period
);
822 /* We take a cached value of the unix time in the global state because
823 * with virtual memory and aging there is to store the current time
824 * in objects at every object access, and accuracy is not needed.
825 * To access a global var is faster than calling time(NULL) */
826 server
.unixtime
= time(NULL
);
828 run_with_period(100) trackOperationsPerSecond();
830 /* We have just 22 bits per object for LRU information.
831 * So we use an (eventually wrapping) LRU clock with 10 seconds resolution.
832 * 2^22 bits with 10 seconds resoluton is more or less 1.5 years.
834 * Note that even if this will wrap after 1.5 years it's not a problem,
835 * everything will still work but just some object will appear younger
836 * to Redis. But for this to happen a given object should never be touched
839 * Note that you can change the resolution altering the
840 * REDIS_LRU_CLOCK_RESOLUTION define.
844 /* Record the max memory used since the server was started. */
845 if (zmalloc_used_memory() > server
.stat_peak_memory
)
846 server
.stat_peak_memory
= zmalloc_used_memory();
848 /* We received a SIGTERM, shutting down here in a safe way, as it is
849 * not ok doing so inside the signal handler. */
850 if (server
.shutdown_asap
) {
851 if (prepareForShutdown(0) == REDIS_OK
) exit(0);
852 redisLog(REDIS_WARNING
,"SIGTERM received but errors trying to shut down the server, check the logs for more information");
855 /* Show some info about non-empty databases */
856 run_with_period(5000) {
857 for (j
= 0; j
< server
.dbnum
; j
++) {
858 long long size
, used
, vkeys
;
860 size
= dictSlots(server
.db
[j
].dict
);
861 used
= dictSize(server
.db
[j
].dict
);
862 vkeys
= dictSize(server
.db
[j
].expires
);
864 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
865 /* dictPrintStats(server.dict); */
870 /* We don't want to resize the hash tables while a bacground saving
871 * is in progress: the saving child is created using fork() that is
872 * implemented with a copy-on-write semantic in most modern systems, so
873 * if we resize the HT while there is the saving child at work actually
874 * a lot of memory movements in the parent will cause a lot of pages
876 if (server
.rdb_child_pid
== -1 && server
.aof_child_pid
== -1) {
877 tryResizeHashTables();
878 if (server
.activerehashing
) incrementallyRehash();
881 /* Show information about connected clients */
882 if (!server
.sentinel_mode
) {
883 run_with_period(5000) {
884 redisLog(REDIS_VERBOSE
,
885 "%d clients connected (%d slaves), %zu bytes in use",
886 listLength(server
.clients
)-listLength(server
.slaves
),
887 listLength(server
.slaves
),
888 zmalloc_used_memory());
892 /* We need to do a few operations on clients asynchronously. */
895 /* Start a scheduled AOF rewrite if this was requested by the user while
896 * a BGSAVE was in progress. */
897 if (server
.rdb_child_pid
== -1 && server
.aof_child_pid
== -1 &&
898 server
.aof_rewrite_scheduled
)
900 rewriteAppendOnlyFileBackground();
903 /* Check if a background saving or AOF rewrite in progress terminated. */
904 if (server
.rdb_child_pid
!= -1 || server
.aof_child_pid
!= -1) {
908 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
909 int exitcode
= WEXITSTATUS(statloc
);
912 if (WIFSIGNALED(statloc
)) bysignal
= WTERMSIG(statloc
);
914 if (pid
== server
.rdb_child_pid
) {
915 backgroundSaveDoneHandler(exitcode
,bysignal
);
916 } else if (pid
== server
.aof_child_pid
) {
917 backgroundRewriteDoneHandler(exitcode
,bysignal
);
919 redisLog(REDIS_WARNING
,
920 "Warning, detected child with unmatched pid: %ld",
923 updateDictResizePolicy();
926 /* If there is not a background saving/rewrite in progress check if
927 * we have to save/rewrite now */
928 for (j
= 0; j
< server
.saveparamslen
; j
++) {
929 struct saveparam
*sp
= server
.saveparams
+j
;
931 if (server
.dirty
>= sp
->changes
&&
932 server
.unixtime
-server
.lastsave
> sp
->seconds
) {
933 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
934 sp
->changes
, sp
->seconds
);
935 rdbSaveBackground(server
.rdb_filename
);
940 /* Trigger an AOF rewrite if needed */
941 if (server
.rdb_child_pid
== -1 &&
942 server
.aof_child_pid
== -1 &&
943 server
.aof_rewrite_perc
&&
944 server
.aof_current_size
> server
.aof_rewrite_min_size
)
946 long long base
= server
.aof_rewrite_base_size
?
947 server
.aof_rewrite_base_size
: 1;
948 long long growth
= (server
.aof_current_size
*100/base
) - 100;
949 if (growth
>= server
.aof_rewrite_perc
) {
950 redisLog(REDIS_NOTICE
,"Starting automatic rewriting of AOF on %lld%% growth",growth
);
951 rewriteAppendOnlyFileBackground();
957 /* If we postponed an AOF buffer flush, let's try to do it every time the
958 * cron function is called. */
959 if (server
.aof_flush_postponed_start
) flushAppendOnlyFile(0);
961 /* Expire a few keys per cycle, only if this is a master.
962 * On slaves we wait for DEL operations synthesized by the master
963 * in order to guarantee a strict consistency. */
964 if (server
.masterhost
== NULL
) activeExpireCycle();
966 /* Close clients that need to be closed asynchronous */
967 freeClientsInAsyncFreeQueue();
969 /* Replication cron function -- used to reconnect to master and
970 * to detect transfer failures. */
971 run_with_period(1000) replicationCron();
973 /* Run the sentinel timer if we are in sentinel mode. */
974 run_with_period(100) {
975 if (server
.sentinel_mode
) sentinelTimer();
979 return 1000/REDIS_HZ
;
982 /* This function gets called every time Redis is entering the
983 * main loop of the event driven library, that is, before to sleep
984 * for ready file descriptors. */
985 void beforeSleep(struct aeEventLoop
*eventLoop
) {
986 REDIS_NOTUSED(eventLoop
);
990 /* Try to process pending commands for clients that were just unblocked. */
991 while (listLength(server
.unblocked_clients
)) {
992 ln
= listFirst(server
.unblocked_clients
);
993 redisAssert(ln
!= NULL
);
995 listDelNode(server
.unblocked_clients
,ln
);
996 c
->flags
&= ~REDIS_UNBLOCKED
;
998 /* Process remaining data in the input buffer. */
999 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) {
1000 server
.current_client
= c
;
1001 processInputBuffer(c
);
1002 server
.current_client
= NULL
;
1006 /* Write the AOF buffer on disk */
1007 flushAppendOnlyFile(0);
1010 /* =========================== Server initialization ======================== */
1012 void createSharedObjects(void) {
1015 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1016 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1017 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1018 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1019 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1020 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1021 shared
.cnegone
= createObject(REDIS_STRING
,sdsnew(":-1\r\n"));
1022 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1023 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1024 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1025 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1026 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1027 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1028 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1029 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1030 "-ERR no such key\r\n"));
1031 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1032 "-ERR syntax error\r\n"));
1033 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1034 "-ERR source and destination objects are the same\r\n"));
1035 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1036 "-ERR index out of range\r\n"));
1037 shared
.noscripterr
= createObject(REDIS_STRING
,sdsnew(
1038 "-NOSCRIPT No matching script. Please use EVAL.\r\n"));
1039 shared
.loadingerr
= createObject(REDIS_STRING
,sdsnew(
1040 "-LOADING Redis is loading the dataset in memory\r\n"));
1041 shared
.slowscripterr
= createObject(REDIS_STRING
,sdsnew(
1042 "-BUSY Redis is busy running a script. You can only call SCRIPT KILL or SHUTDOWN NOSAVE.\r\n"));
1043 shared
.masterdownerr
= createObject(REDIS_STRING
,sdsnew(
1044 "-MASTERDOWN Link with MASTER is down and slave-serve-stale-data is set to 'no'.\r\n"));
1045 shared
.bgsaveerr
= createObject(REDIS_STRING
,sdsnew(
1046 "-MISCONF Redis is configured to save RDB snapshots, but is currently not able to persist on disk. Commands that may modify the data set are disabled. Please check Redis logs for details about the error.\r\n"));
1047 shared
.roslaveerr
= createObject(REDIS_STRING
,sdsnew(
1048 "-READONLY You can't write against a read only slave.\r\n"));
1049 shared
.oomerr
= createObject(REDIS_STRING
,sdsnew(
1050 "-OOM command not allowed when used memory > 'maxmemory'.\r\n"));
1051 shared
.execaborterr
= createObject(REDIS_STRING
,sdsnew(
1052 "-EXECABORT Transaction discarded because of previous errors.\r\n"));
1053 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1054 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1055 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1057 for (j
= 0; j
< REDIS_SHARED_SELECT_CMDS
; j
++) {
1058 shared
.select
[j
] = createObject(REDIS_STRING
,
1059 sdscatprintf(sdsempty(),"select %d\r\n", j
));
1061 shared
.messagebulk
= createStringObject("$7\r\nmessage\r\n",13);
1062 shared
.pmessagebulk
= createStringObject("$8\r\npmessage\r\n",14);
1063 shared
.subscribebulk
= createStringObject("$9\r\nsubscribe\r\n",15);
1064 shared
.unsubscribebulk
= createStringObject("$11\r\nunsubscribe\r\n",18);
1065 shared
.psubscribebulk
= createStringObject("$10\r\npsubscribe\r\n",17);
1066 shared
.punsubscribebulk
= createStringObject("$12\r\npunsubscribe\r\n",19);
1067 shared
.del
= createStringObject("DEL",3);
1068 shared
.rpop
= createStringObject("RPOP",4);
1069 shared
.lpop
= createStringObject("LPOP",4);
1070 shared
.lpush
= createStringObject("LPUSH",5);
1071 for (j
= 0; j
< REDIS_SHARED_INTEGERS
; j
++) {
1072 shared
.integers
[j
] = createObject(REDIS_STRING
,(void*)(long)j
);
1073 shared
.integers
[j
]->encoding
= REDIS_ENCODING_INT
;
1075 for (j
= 0; j
< REDIS_SHARED_BULKHDR_LEN
; j
++) {
1076 shared
.mbulkhdr
[j
] = createObject(REDIS_STRING
,
1077 sdscatprintf(sdsempty(),"*%d\r\n",j
));
1078 shared
.bulkhdr
[j
] = createObject(REDIS_STRING
,
1079 sdscatprintf(sdsempty(),"$%d\r\n",j
));
1083 void initServerConfig() {
1084 getRandomHexChars(server
.runid
,REDIS_RUN_ID_SIZE
);
1085 server
.runid
[REDIS_RUN_ID_SIZE
] = '\0';
1086 server
.arch_bits
= (sizeof(long) == 8) ? 64 : 32;
1087 server
.port
= REDIS_SERVERPORT
;
1088 server
.bindaddr
= NULL
;
1089 server
.unixsocket
= NULL
;
1090 server
.unixsocketperm
= 0;
1093 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1094 server
.verbosity
= REDIS_NOTICE
;
1095 server
.maxidletime
= REDIS_MAXIDLETIME
;
1096 server
.client_max_querybuf_len
= REDIS_MAX_QUERYBUF_LEN
;
1097 server
.saveparams
= NULL
;
1099 server
.logfile
= NULL
; /* NULL = log on standard output */
1100 server
.syslog_enabled
= 0;
1101 server
.syslog_ident
= zstrdup("redis");
1102 server
.syslog_facility
= LOG_LOCAL0
;
1103 server
.daemonize
= 0;
1104 server
.aof_state
= REDIS_AOF_OFF
;
1105 server
.aof_fsync
= AOF_FSYNC_EVERYSEC
;
1106 server
.aof_no_fsync_on_rewrite
= 0;
1107 server
.aof_rewrite_perc
= REDIS_AOF_REWRITE_PERC
;
1108 server
.aof_rewrite_min_size
= REDIS_AOF_REWRITE_MIN_SIZE
;
1109 server
.aof_rewrite_base_size
= 0;
1110 server
.aof_rewrite_scheduled
= 0;
1111 server
.aof_last_fsync
= time(NULL
);
1112 server
.aof_rewrite_time_last
= -1;
1113 server
.aof_rewrite_time_start
= -1;
1114 server
.aof_lastbgrewrite_status
= REDIS_OK
;
1115 server
.aof_delayed_fsync
= 0;
1117 server
.aof_selected_db
= -1; /* Make sure the first time will not match */
1118 server
.aof_flush_postponed_start
= 0;
1119 server
.pidfile
= zstrdup("/var/run/redis.pid");
1120 server
.rdb_filename
= zstrdup("dump.rdb");
1121 server
.aof_filename
= zstrdup("appendonly.aof");
1122 server
.mdb_state
= REDIS_MDB_OFF
;
1123 server
.mdb_environment
= zstrdup("archive");
1124 server
.mdb_mapsize
= 10485760;
1125 server
.requirepass
= NULL
;
1126 server
.rdb_compression
= 1;
1127 server
.rdb_checksum
= 1;
1128 server
.activerehashing
= 1;
1129 server
.maxclients
= REDIS_MAX_CLIENTS
;
1130 server
.bpop_blocked_clients
= 0;
1131 server
.maxmemory
= 0;
1132 server
.maxmemory_policy
= REDIS_MAXMEMORY_VOLATILE_LRU
;
1133 server
.maxmemory_samples
= 3;
1134 server
.hash_max_ziplist_entries
= REDIS_HASH_MAX_ZIPLIST_ENTRIES
;
1135 server
.hash_max_ziplist_value
= REDIS_HASH_MAX_ZIPLIST_VALUE
;
1136 server
.list_max_ziplist_entries
= REDIS_LIST_MAX_ZIPLIST_ENTRIES
;
1137 server
.list_max_ziplist_value
= REDIS_LIST_MAX_ZIPLIST_VALUE
;
1138 server
.set_max_intset_entries
= REDIS_SET_MAX_INTSET_ENTRIES
;
1139 server
.zset_max_ziplist_entries
= REDIS_ZSET_MAX_ZIPLIST_ENTRIES
;
1140 server
.zset_max_ziplist_value
= REDIS_ZSET_MAX_ZIPLIST_VALUE
;
1141 server
.shutdown_asap
= 0;
1142 server
.repl_ping_slave_period
= REDIS_REPL_PING_SLAVE_PERIOD
;
1143 server
.repl_timeout
= REDIS_REPL_TIMEOUT
;
1144 server
.lua_caller
= NULL
;
1145 server
.lua_time_limit
= REDIS_LUA_TIME_LIMIT
;
1146 server
.lua_client
= NULL
;
1147 server
.lua_timedout
= 0;
1150 resetServerSaveParams();
1152 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1153 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1154 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1155 /* Replication related */
1156 server
.masterauth
= NULL
;
1157 server
.masterhost
= NULL
;
1158 server
.masterport
= 6379;
1159 server
.master
= NULL
;
1160 server
.repl_state
= REDIS_REPL_NONE
;
1161 server
.repl_syncio_timeout
= REDIS_REPL_SYNCIO_TIMEOUT
;
1162 server
.repl_serve_stale_data
= 1;
1163 server
.repl_slave_ro
= 1;
1164 server
.repl_down_since
= time(NULL
);
1165 server
.slave_priority
= REDIS_DEFAULT_SLAVE_PRIORITY
;
1167 /* Client output buffer limits */
1168 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_NORMAL
].hard_limit_bytes
= 0;
1169 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_NORMAL
].soft_limit_bytes
= 0;
1170 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_NORMAL
].soft_limit_seconds
= 0;
1171 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_SLAVE
].hard_limit_bytes
= 1024*1024*256;
1172 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_SLAVE
].soft_limit_bytes
= 1024*1024*64;
1173 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_SLAVE
].soft_limit_seconds
= 60;
1174 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_PUBSUB
].hard_limit_bytes
= 1024*1024*32;
1175 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_PUBSUB
].soft_limit_bytes
= 1024*1024*8;
1176 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_PUBSUB
].soft_limit_seconds
= 60;
1178 /* Double constants initialization */
1180 R_PosInf
= 1.0/R_Zero
;
1181 R_NegInf
= -1.0/R_Zero
;
1182 R_Nan
= R_Zero
/R_Zero
;
1184 /* Command table -- we intiialize it here as it is part of the
1185 * initial configuration, since command names may be changed via
1186 * redis.conf using the rename-command directive. */
1187 server
.commands
= dictCreate(&commandTableDictType
,NULL
);
1188 populateCommandTable();
1189 server
.delCommand
= lookupCommandByCString("del");
1190 server
.multiCommand
= lookupCommandByCString("multi");
1191 server
.lpushCommand
= lookupCommandByCString("lpush");
1192 server
.lpopCommand
= lookupCommandByCString("lpop");
1193 server
.rpopCommand
= lookupCommandByCString("rpop");
1196 server
.slowlog_log_slower_than
= REDIS_SLOWLOG_LOG_SLOWER_THAN
;
1197 server
.slowlog_max_len
= REDIS_SLOWLOG_MAX_LEN
;
1200 server
.assert_failed
= "<no assertion failed>";
1201 server
.assert_file
= "<no file>";
1202 server
.assert_line
= 0;
1203 server
.bug_report_start
= 0;
1204 server
.watchdog_period
= 0;
1207 /* This function will try to raise the max number of open files accordingly to
1208 * the configured max number of clients. It will also account for 32 additional
1209 * file descriptors as we need a few more for persistence, listening
1210 * sockets, log files and so forth.
1212 * If it will not be possible to set the limit accordingly to the configured
1213 * max number of clients, the function will do the reverse setting
1214 * server.maxclients to the value that we can actually handle. */
1215 void adjustOpenFilesLimit(void) {
1216 rlim_t maxfiles
= server
.maxclients
+32;
1217 struct rlimit limit
;
1219 if (getrlimit(RLIMIT_NOFILE
,&limit
) == -1) {
1220 redisLog(REDIS_WARNING
,"Unable to obtain the current NOFILE limit (%s), assuming 1024 and setting the max clients configuration accordingly.",
1222 server
.maxclients
= 1024-32;
1224 rlim_t oldlimit
= limit
.rlim_cur
;
1226 /* Set the max number of files if the current limit is not enough
1228 if (oldlimit
< maxfiles
) {
1232 while(f
> oldlimit
) {
1235 if (setrlimit(RLIMIT_NOFILE
,&limit
) != -1) break;
1238 if (f
< oldlimit
) f
= oldlimit
;
1239 if (f
!= maxfiles
) {
1240 server
.maxclients
= f
-32;
1241 redisLog(REDIS_WARNING
,"Unable to set the max number of files limit to %d (%s), setting the max clients configuration to %d.",
1242 (int) maxfiles
, strerror(errno
), (int) server
.maxclients
);
1244 redisLog(REDIS_NOTICE
,"Max number of open files set to %d",
1254 signal(SIGHUP
, SIG_IGN
);
1255 signal(SIGPIPE
, SIG_IGN
);
1256 setupSignalHandlers();
1258 if (server
.syslog_enabled
) {
1259 openlog(server
.syslog_ident
, LOG_PID
| LOG_NDELAY
| LOG_NOWAIT
,
1260 server
.syslog_facility
);
1263 server
.current_client
= NULL
;
1264 server
.clients
= listCreate();
1265 server
.clients_to_close
= listCreate();
1266 server
.slaves
= listCreate();
1267 server
.monitors
= listCreate();
1268 server
.unblocked_clients
= listCreate();
1269 server
.ready_keys
= listCreate();
1271 createSharedObjects();
1272 adjustOpenFilesLimit();
1273 server
.el
= aeCreateEventLoop(server
.maxclients
+1024);
1274 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1276 if (server
.port
!= 0) {
1277 server
.ipfd
= anetTcpServer(server
.neterr
,server
.port
,server
.bindaddr
);
1278 if (server
.ipfd
== ANET_ERR
) {
1279 redisLog(REDIS_WARNING
, "Opening port %d: %s",
1280 server
.port
, server
.neterr
);
1284 if (server
.unixsocket
!= NULL
) {
1285 unlink(server
.unixsocket
); /* don't care if this fails */
1286 server
.sofd
= anetUnixServer(server
.neterr
,server
.unixsocket
,server
.unixsocketperm
);
1287 if (server
.sofd
== ANET_ERR
) {
1288 redisLog(REDIS_WARNING
, "Opening socket: %s", server
.neterr
);
1292 if (server
.ipfd
< 0 && server
.sofd
< 0) {
1293 redisLog(REDIS_WARNING
, "Configured to not listen anywhere, exiting.");
1296 for (j
= 0; j
< server
.dbnum
; j
++) {
1297 server
.db
[j
].dict
= dictCreate(&dbDictType
,NULL
);
1298 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1299 server
.db
[j
].blocking_keys
= dictCreate(&keylistDictType
,NULL
);
1300 server
.db
[j
].ready_keys
= dictCreate(&setDictType
,NULL
);
1301 server
.db
[j
].watched_keys
= dictCreate(&keylistDictType
,NULL
);
1302 server
.db
[j
].id
= j
;
1304 server
.pubsub_channels
= dictCreate(&keylistDictType
,NULL
);
1305 server
.pubsub_patterns
= listCreate();
1306 listSetFreeMethod(server
.pubsub_patterns
,freePubsubPattern
);
1307 listSetMatchMethod(server
.pubsub_patterns
,listMatchPubsubPattern
);
1308 server
.cronloops
= 0;
1309 server
.rdb_child_pid
= -1;
1310 server
.aof_child_pid
= -1;
1311 aofRewriteBufferReset();
1312 server
.aof_buf
= sdsempty();
1313 server
.lastsave
= time(NULL
);
1314 server
.rdb_save_time_last
= -1;
1315 server
.rdb_save_time_start
= -1;
1317 server
.stat_numcommands
= 0;
1318 server
.stat_numconnections
= 0;
1319 server
.stat_expiredkeys
= 0;
1320 server
.stat_evictedkeys
= 0;
1321 server
.stat_starttime
= time(NULL
);
1322 server
.stat_keyspace_misses
= 0;
1323 server
.stat_keyspace_hits
= 0;
1324 server
.stat_peak_memory
= 0;
1325 server
.stat_fork_time
= 0;
1326 server
.stat_rejected_conn
= 0;
1327 memset(server
.ops_sec_samples
,0,sizeof(server
.ops_sec_samples
));
1328 server
.ops_sec_idx
= 0;
1329 server
.ops_sec_last_sample_time
= mstime();
1330 server
.ops_sec_last_sample_ops
= 0;
1331 server
.unixtime
= time(NULL
);
1332 server
.lastbgsave_status
= REDIS_OK
;
1333 server
.stop_writes_on_bgsave_err
= 1;
1334 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1335 if (server
.ipfd
> 0 && aeCreateFileEvent(server
.el
,server
.ipfd
,AE_READABLE
,
1336 acceptTcpHandler
,NULL
) == AE_ERR
) redisPanic("Unrecoverable error creating server.ipfd file event.");
1337 if (server
.sofd
> 0 && aeCreateFileEvent(server
.el
,server
.sofd
,AE_READABLE
,
1338 acceptUnixHandler
,NULL
) == AE_ERR
) redisPanic("Unrecoverable error creating server.sofd file event.");
1340 if (server
.aof_state
== REDIS_AOF_ON
) {
1341 server
.aof_fd
= open(server
.aof_filename
,
1342 O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1343 if (server
.aof_fd
== -1) {
1344 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1350 /* 32 bit instances are limited to 4GB of address space, so if there is
1351 * no explicit limit in the user provided configuration we set a limit
1352 * at 3 GB using maxmemory with 'noeviction' policy'. This avoids
1353 * useless crashes of the Redis instance for out of memory. */
1354 if (server
.arch_bits
== 32 && server
.maxmemory
== 0) {
1355 redisLog(REDIS_WARNING
,"Warning: 32 bit instance detected but no memory limit set. Setting 3 GB maxmemory limit with 'noeviction' policy now.");
1356 server
.maxmemory
= 3072LL*(1024*1024); /* 3 GB */
1357 server
.maxmemory_policy
= REDIS_MAXMEMORY_NO_EVICTION
;
1365 /* Populates the Redis Command Table starting from the hard coded list
1366 * we have on top of redis.c file. */
1367 void populateCommandTable(void) {
1369 int numcommands
= sizeof(redisCommandTable
)/sizeof(struct redisCommand
);
1371 for (j
= 0; j
< numcommands
; j
++) {
1372 struct redisCommand
*c
= redisCommandTable
+j
;
1373 char *f
= c
->sflags
;
1378 case 'w': c
->flags
|= REDIS_CMD_WRITE
; break;
1379 case 'r': c
->flags
|= REDIS_CMD_READONLY
; break;
1380 case 'm': c
->flags
|= REDIS_CMD_DENYOOM
; break;
1381 case 'a': c
->flags
|= REDIS_CMD_ADMIN
; break;
1382 case 'p': c
->flags
|= REDIS_CMD_PUBSUB
; break;
1383 case 'f': c
->flags
|= REDIS_CMD_FORCE_REPLICATION
; break;
1384 case 's': c
->flags
|= REDIS_CMD_NOSCRIPT
; break;
1385 case 'R': c
->flags
|= REDIS_CMD_RANDOM
; break;
1386 case 'S': c
->flags
|= REDIS_CMD_SORT_FOR_SCRIPT
; break;
1387 case 'l': c
->flags
|= REDIS_CMD_LOADING
; break;
1388 case 't': c
->flags
|= REDIS_CMD_STALE
; break;
1389 case 'M': c
->flags
|= REDIS_CMD_SKIP_MONITOR
; break;
1390 default: redisPanic("Unsupported command flag"); break;
1395 retval
= dictAdd(server
.commands
, sdsnew(c
->name
), c
);
1396 assert(retval
== DICT_OK
);
1400 void resetCommandTableStats(void) {
1401 int numcommands
= sizeof(redisCommandTable
)/sizeof(struct redisCommand
);
1404 for (j
= 0; j
< numcommands
; j
++) {
1405 struct redisCommand
*c
= redisCommandTable
+j
;
1407 c
->microseconds
= 0;
1412 /* ========================== Redis OP Array API ============================ */
1414 void redisOpArrayInit(redisOpArray
*oa
) {
1419 int redisOpArrayAppend(redisOpArray
*oa
, struct redisCommand
*cmd
, int dbid
,
1420 robj
**argv
, int argc
, int target
)
1424 oa
->ops
= zrealloc(oa
->ops
,sizeof(redisOp
)*(oa
->numops
+1));
1425 op
= oa
->ops
+oa
->numops
;
1430 op
->target
= target
;
1435 void redisOpArrayFree(redisOpArray
*oa
) {
1441 op
= oa
->ops
+oa
->numops
;
1442 for (j
= 0; j
< op
->argc
; j
++)
1443 decrRefCount(op
->argv
[j
]);
1449 /* ====================== Commands lookup and execution ===================== */
1451 struct redisCommand
*lookupCommand(sds name
) {
1452 return dictFetchValue(server
.commands
, name
);
1455 struct redisCommand
*lookupCommandByCString(char *s
) {
1456 struct redisCommand
*cmd
;
1457 sds name
= sdsnew(s
);
1459 cmd
= dictFetchValue(server
.commands
, name
);
1464 /* Propagate the specified command (in the context of the specified database id)
1465 * to AOF and Slaves.
1467 * flags are an xor between:
1468 * + REDIS_PROPAGATE_NONE (no propagation of command at all)
1469 * + REDIS_PROPAGATE_AOF (propagate into the AOF file if is enabled)
1470 * + REDIS_PROPAGATE_REPL (propagate into the replication link)
1472 void propagate(struct redisCommand
*cmd
, int dbid
, robj
**argv
, int argc
,
1475 if (server
.aof_state
!= REDIS_AOF_OFF
&& flags
& REDIS_PROPAGATE_AOF
)
1476 feedAppendOnlyFile(cmd
,dbid
,argv
,argc
);
1477 if (flags
& REDIS_PROPAGATE_REPL
&& listLength(server
.slaves
))
1478 replicationFeedSlaves(server
.slaves
,dbid
,argv
,argc
);
1481 /* Used inside commands to schedule the propagation of additional commands
1482 * after the current command is propagated to AOF / Replication. */
1483 void alsoPropagate(struct redisCommand
*cmd
, int dbid
, robj
**argv
, int argc
,
1486 redisOpArrayAppend(&server
.also_propagate
,cmd
,dbid
,argv
,argc
,target
);
1489 /* Call() is the core of Redis execution of a command */
1490 void call(redisClient
*c
, int flags
) {
1491 long long dirty
, start
= ustime(), duration
;
1493 /* Sent the command to clients in MONITOR mode, only if the commands are
1494 * not geneated from reading an AOF. */
1495 if (listLength(server
.monitors
) &&
1497 !(c
->cmd
->flags
& REDIS_CMD_SKIP_MONITOR
))
1499 replicationFeedMonitors(c
,server
.monitors
,c
->db
->id
,c
->argv
,c
->argc
);
1502 /* Call the command. */
1503 redisOpArrayInit(&server
.also_propagate
);
1504 dirty
= server
.dirty
;
1506 dirty
= server
.dirty
-dirty
;
1507 duration
= ustime()-start
;
1509 /* When EVAL is called loading the AOF we don't want commands called
1510 * from Lua to go into the slowlog or to populate statistics. */
1511 if (server
.loading
&& c
->flags
& REDIS_LUA_CLIENT
)
1512 flags
&= ~(REDIS_CALL_SLOWLOG
| REDIS_CALL_STATS
);
1514 /* Log the command into the Slow log if needed, and populate the
1515 * per-command statistics that we show in INFO commandstats. */
1516 if (flags
& REDIS_CALL_SLOWLOG
)
1517 slowlogPushEntryIfNeeded(c
->argv
,c
->argc
,duration
);
1518 if (flags
& REDIS_CALL_STATS
) {
1519 c
->cmd
->microseconds
+= duration
;
1523 /* Propagate the command into the AOF and replication link */
1524 if (flags
& REDIS_CALL_PROPAGATE
) {
1525 int flags
= REDIS_PROPAGATE_NONE
;
1527 if (c
->cmd
->flags
& REDIS_CMD_FORCE_REPLICATION
)
1528 flags
|= REDIS_PROPAGATE_REPL
;
1530 flags
|= (REDIS_PROPAGATE_REPL
| REDIS_PROPAGATE_AOF
);
1531 if (flags
!= REDIS_PROPAGATE_NONE
)
1532 propagate(c
->cmd
,c
->db
->id
,c
->argv
,c
->argc
,flags
);
1534 /* Commands such as LPUSH or BRPOPLPUSH may propagate an additional
1536 if (server
.also_propagate
.numops
) {
1540 for (j
= 0; j
< server
.also_propagate
.numops
; j
++) {
1541 rop
= &server
.also_propagate
.ops
[j
];
1542 propagate(rop
->cmd
, rop
->dbid
, rop
->argv
, rop
->argc
, rop
->target
);
1544 redisOpArrayFree(&server
.also_propagate
);
1546 server
.stat_numcommands
++;
1549 /* If this function gets called we already read a whole
1550 * command, arguments are in the client argv/argc fields.
1551 * processCommand() execute the command or prepare the
1552 * server for a bulk read from the client.
1554 * If 1 is returned the client is still alive and valid and
1555 * and other operations can be performed by the caller. Otherwise
1556 * if 0 is returned the client was destroied (i.e. after QUIT). */
1557 int processCommand(redisClient
*c
) {
1558 /* The QUIT command is handled separately. Normal command procs will
1559 * go through checking for replication and QUIT will cause trouble
1560 * when FORCE_REPLICATION is enabled and would be implemented in
1561 * a regular command proc. */
1562 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
1563 addReply(c
,shared
.ok
);
1564 c
->flags
|= REDIS_CLOSE_AFTER_REPLY
;
1568 /* Now lookup the command and check ASAP about trivial error conditions
1569 * such as wrong arity, bad command name and so forth. */
1570 c
->cmd
= c
->lastcmd
= lookupCommand(c
->argv
[0]->ptr
);
1573 addReplyErrorFormat(c
,"unknown command '%s'",
1574 (char*)c
->argv
[0]->ptr
);
1576 } else if ((c
->cmd
->arity
> 0 && c
->cmd
->arity
!= c
->argc
) ||
1577 (c
->argc
< -c
->cmd
->arity
)) {
1579 addReplyErrorFormat(c
,"wrong number of arguments for '%s' command",
1584 /* Check if the user is authenticated */
1585 if (server
.requirepass
&& !c
->authenticated
&& c
->cmd
->proc
!= authCommand
)
1588 addReplyError(c
,"operation not permitted");
1592 /* Handle the maxmemory directive.
1594 * First we try to free some memory if possible (if there are volatile
1595 * keys in the dataset). If there are not the only thing we can do
1596 * is returning an error. */
1597 if (server
.maxmemory
) {
1598 int retval
= freeMemoryIfNeeded();
1599 if ((c
->cmd
->flags
& REDIS_CMD_DENYOOM
) && retval
== REDIS_ERR
) {
1601 addReply(c
, shared
.oomerr
);
1606 /* Don't accept write commands if there are problems persisting on disk. */
1607 if (server
.stop_writes_on_bgsave_err
&&
1608 server
.saveparamslen
> 0
1609 && server
.lastbgsave_status
== REDIS_ERR
&&
1610 c
->cmd
->flags
& REDIS_CMD_WRITE
)
1613 addReply(c
, shared
.bgsaveerr
);
1617 /* Don't accept write commands if this is a read only slave. But
1618 * accept write commands if this is our master. */
1619 if (server
.masterhost
&& server
.repl_slave_ro
&&
1620 !(c
->flags
& REDIS_MASTER
) &&
1621 c
->cmd
->flags
& REDIS_CMD_WRITE
)
1623 addReply(c
, shared
.roslaveerr
);
1627 /* Only allow SUBSCRIBE and UNSUBSCRIBE in the context of Pub/Sub */
1628 if ((dictSize(c
->pubsub_channels
) > 0 || listLength(c
->pubsub_patterns
) > 0)
1630 c
->cmd
->proc
!= subscribeCommand
&&
1631 c
->cmd
->proc
!= unsubscribeCommand
&&
1632 c
->cmd
->proc
!= psubscribeCommand
&&
1633 c
->cmd
->proc
!= punsubscribeCommand
) {
1634 addReplyError(c
,"only (P)SUBSCRIBE / (P)UNSUBSCRIBE / QUIT allowed in this context");
1638 /* Only allow INFO and SLAVEOF when slave-serve-stale-data is no and
1639 * we are a slave with a broken link with master. */
1640 if (server
.masterhost
&& server
.repl_state
!= REDIS_REPL_CONNECTED
&&
1641 server
.repl_serve_stale_data
== 0 &&
1642 !(c
->cmd
->flags
& REDIS_CMD_STALE
))
1645 addReply(c
, shared
.masterdownerr
);
1649 /* Loading DB? Return an error if the command has not the
1650 * REDIS_CMD_LOADING flag. */
1651 if (server
.loading
&& !(c
->cmd
->flags
& REDIS_CMD_LOADING
)) {
1652 addReply(c
, shared
.loadingerr
);
1656 /* Lua script too slow? Only allow commands with REDIS_CMD_STALE flag. */
1657 if (server
.lua_timedout
&&
1658 c
->cmd
->proc
!= authCommand
&&
1659 !(c
->cmd
->proc
== shutdownCommand
&&
1661 tolower(((char*)c
->argv
[1]->ptr
)[0]) == 'n') &&
1662 !(c
->cmd
->proc
== scriptCommand
&&
1664 tolower(((char*)c
->argv
[1]->ptr
)[0]) == 'k'))
1667 addReply(c
, shared
.slowscripterr
);
1671 /* Exec the command */
1672 if (c
->flags
& REDIS_MULTI
&&
1673 c
->cmd
->proc
!= execCommand
&& c
->cmd
->proc
!= discardCommand
&&
1674 c
->cmd
->proc
!= multiCommand
&& c
->cmd
->proc
!= watchCommand
)
1676 queueMultiCommand(c
);
1677 addReply(c
,shared
.queued
);
1679 call(c
,REDIS_CALL_FULL
);
1680 if (listLength(server
.ready_keys
))
1681 handleClientsBlockedOnLists();
1686 /*================================== Shutdown =============================== */
1688 int prepareForShutdown(int flags
) {
1689 int save
= flags
& REDIS_SHUTDOWN_SAVE
;
1690 int nosave
= flags
& REDIS_SHUTDOWN_NOSAVE
;
1692 redisLog(REDIS_WARNING
,"User requested shutdown...");
1693 /* Kill the saving child if there is a background saving in progress.
1694 We want to avoid race conditions, for instance our saving child may
1695 overwrite the synchronous saving did by SHUTDOWN. */
1696 if (server
.rdb_child_pid
!= -1) {
1697 redisLog(REDIS_WARNING
,"There is a child saving an .rdb. Killing it!");
1698 kill(server
.rdb_child_pid
,SIGKILL
);
1699 rdbRemoveTempFile(server
.rdb_child_pid
);
1701 if (server
.aof_state
!= REDIS_AOF_OFF
) {
1702 /* Kill the AOF saving child as the AOF we already have may be longer
1703 * but contains the full dataset anyway. */
1704 if (server
.aof_child_pid
!= -1) {
1705 redisLog(REDIS_WARNING
,
1706 "There is a child rewriting the AOF. Killing it!");
1707 kill(server
.aof_child_pid
,SIGKILL
);
1709 /* Append only file: fsync() the AOF and exit */
1710 redisLog(REDIS_NOTICE
,"Calling fsync() on the AOF file.");
1711 aof_fsync(server
.aof_fd
);
1713 if ((server
.saveparamslen
> 0 && !nosave
) || save
) {
1714 redisLog(REDIS_NOTICE
,"Saving the final RDB snapshot before exiting.");
1715 /* Snapshotting. Perform a SYNC SAVE and exit */
1716 if (rdbSave(server
.rdb_filename
) != REDIS_OK
) {
1717 /* Ooops.. error saving! The best we can do is to continue
1718 * operating. Note that if there was a background saving process,
1719 * in the next cron() Redis will be notified that the background
1720 * saving aborted, handling special stuff like slaves pending for
1721 * synchronization... */
1722 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit.");
1726 if (server
.daemonize
) {
1727 redisLog(REDIS_NOTICE
,"Removing the pid file.");
1728 unlink(server
.pidfile
);
1730 /* Close the listening sockets. Apparently this allows faster restarts. */
1731 if (server
.ipfd
!= -1) close(server
.ipfd
);
1732 if (server
.sofd
!= -1) close(server
.sofd
);
1733 if (server
.unixsocket
) {
1734 redisLog(REDIS_NOTICE
,"Removing the unix socket file.");
1735 unlink(server
.unixsocket
); /* don't care if this fails */
1738 redisLog(REDIS_WARNING
,"Redis is now ready to exit, bye bye...");
1742 /*================================== Commands =============================== */
1744 /* Return zero if strings are the same, non-zero if they are not.
1745 * The comparison is performed in a way that prevents an attacker to obtain
1746 * information about the nature of the strings just monitoring the execution
1747 * time of the function.
1749 * Note that limiting the comparison length to strings up to 512 bytes we
1750 * can avoid leaking any information about the password length and any
1751 * possible branch misprediction related leak.
1753 int time_independent_strcmp(char *a
, char *b
) {
1754 char bufa
[REDIS_AUTHPASS_MAX_LEN
], bufb
[REDIS_AUTHPASS_MAX_LEN
];
1755 /* The above two strlen perform len(a) + len(b) operations where either
1756 * a or b are fixed (our password) length, and the difference is only
1757 * relative to the length of the user provided string, so no information
1758 * leak is possible in the following two lines of code. */
1759 int alen
= strlen(a
);
1760 int blen
= strlen(b
);
1764 /* We can't compare strings longer than our static buffers.
1765 * Note that this will never pass the first test in practical circumstances
1766 * so there is no info leak. */
1767 if (alen
> sizeof(bufa
) || blen
> sizeof(bufb
)) return 1;
1769 memset(bufa
,0,sizeof(bufa
)); /* Constant time. */
1770 memset(bufb
,0,sizeof(bufb
)); /* Constant time. */
1771 /* Again the time of the following two copies is proportional to
1772 * len(a) + len(b) so no info is leaked. */
1773 memcpy(bufa
,a
,alen
);
1774 memcpy(bufb
,b
,blen
);
1776 /* Always compare all the chars in the two buffers without
1777 * conditional expressions. */
1778 for (j
= 0; j
< sizeof(bufa
); j
++) {
1779 diff
|= (bufa
[j
] ^ bufb
[j
]);
1781 /* Length must be equal as well. */
1782 diff
|= alen
^ blen
;
1783 return diff
; /* If zero strings are the same. */
1786 void authCommand(redisClient
*c
) {
1787 if (!server
.requirepass
) {
1788 addReplyError(c
,"Client sent AUTH, but no password is set");
1789 } else if (!time_independent_strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
1790 c
->authenticated
= 1;
1791 addReply(c
,shared
.ok
);
1793 c
->authenticated
= 0;
1794 addReplyError(c
,"invalid password");
1798 void pingCommand(redisClient
*c
) {
1799 addReply(c
,shared
.pong
);
1802 void echoCommand(redisClient
*c
) {
1803 addReplyBulk(c
,c
->argv
[1]);
1806 void timeCommand(redisClient
*c
) {
1809 /* gettimeofday() can only fail if &tv is a bad addresss so we
1810 * don't check for errors. */
1811 gettimeofday(&tv
,NULL
);
1812 addReplyMultiBulkLen(c
,2);
1813 addReplyBulkLongLong(c
,tv
.tv_sec
);
1814 addReplyBulkLongLong(c
,tv
.tv_usec
);
1817 /* Convert an amount of bytes into a human readable string in the form
1818 * of 100B, 2G, 100M, 4K, and so forth. */
1819 void bytesToHuman(char *s
, unsigned long long n
) {
1824 sprintf(s
,"%lluB",n
);
1826 } else if (n
< (1024*1024)) {
1827 d
= (double)n
/(1024);
1828 sprintf(s
,"%.2fK",d
);
1829 } else if (n
< (1024LL*1024*1024)) {
1830 d
= (double)n
/(1024*1024);
1831 sprintf(s
,"%.2fM",d
);
1832 } else if (n
< (1024LL*1024*1024*1024)) {
1833 d
= (double)n
/(1024LL*1024*1024);
1834 sprintf(s
,"%.2fG",d
);
1838 /* Create the string returned by the INFO command. This is decoupled
1839 * by the INFO command itself as we need to report the same information
1840 * on memory corruption problems. */
1841 sds
genRedisInfoString(char *section
) {
1842 sds info
= sdsempty();
1843 time_t uptime
= server
.unixtime
-server
.stat_starttime
;
1845 struct rusage self_ru
, c_ru
;
1846 unsigned long lol
, bib
;
1847 int allsections
= 0, defsections
= 0;
1851 allsections
= strcasecmp(section
,"all") == 0;
1852 defsections
= strcasecmp(section
,"default") == 0;
1855 getrusage(RUSAGE_SELF
, &self_ru
);
1856 getrusage(RUSAGE_CHILDREN
, &c_ru
);
1857 getClientsMaxBuffers(&lol
,&bib
);
1860 if (allsections
|| defsections
|| !strcasecmp(section
,"server")) {
1861 struct utsname name
;
1864 if (server
.sentinel_mode
) mode
= "sentinel";
1865 else mode
= "standalone";
1867 if (sections
++) info
= sdscat(info
,"\r\n");
1869 info
= sdscatprintf(info
,
1871 "redis_version:%s\r\n"
1872 "redis_git_sha1:%s\r\n"
1873 "redis_git_dirty:%d\r\n"
1877 "multiplexing_api:%s\r\n"
1878 "gcc_version:%d.%d.%d\r\n"
1879 "process_id:%ld\r\n"
1882 "uptime_in_seconds:%ld\r\n"
1883 "uptime_in_days:%ld\r\n"
1884 "lru_clock:%ld\r\n",
1887 strtol(redisGitDirty(),NULL
,10) > 0,
1889 name
.sysname
, name
.release
, name
.machine
,
1893 __GNUC__
,__GNUC_MINOR__
,__GNUC_PATCHLEVEL__
,
1902 (unsigned long) server
.lruclock
);
1906 if (allsections
|| defsections
|| !strcasecmp(section
,"clients")) {
1907 if (sections
++) info
= sdscat(info
,"\r\n");
1908 info
= sdscatprintf(info
,
1910 "connected_clients:%lu\r\n"
1911 "client_longest_output_list:%lu\r\n"
1912 "client_biggest_input_buf:%lu\r\n"
1913 "blocked_clients:%d\r\n",
1914 listLength(server
.clients
)-listLength(server
.slaves
),
1916 server
.bpop_blocked_clients
);
1920 if (allsections
|| defsections
|| !strcasecmp(section
,"memory")) {
1924 bytesToHuman(hmem
,zmalloc_used_memory());
1925 bytesToHuman(peak_hmem
,server
.stat_peak_memory
);
1926 if (sections
++) info
= sdscat(info
,"\r\n");
1927 info
= sdscatprintf(info
,
1929 "used_memory:%zu\r\n"
1930 "used_memory_human:%s\r\n"
1931 "used_memory_rss:%zu\r\n"
1932 "used_memory_peak:%zu\r\n"
1933 "used_memory_peak_human:%s\r\n"
1934 "used_memory_lua:%lld\r\n"
1935 "mem_fragmentation_ratio:%.2f\r\n"
1936 "mem_allocator:%s\r\n",
1937 zmalloc_used_memory(),
1940 server
.stat_peak_memory
,
1942 ((long long)lua_gc(server
.lua
,LUA_GCCOUNT
,0))*1024LL,
1943 zmalloc_get_fragmentation_ratio(),
1949 if (allsections
|| defsections
|| !strcasecmp(section
,"persistence")) {
1950 if (sections
++) info
= sdscat(info
,"\r\n");
1951 info
= sdscatprintf(info
,
1954 "rdb_changes_since_last_save:%lld\r\n"
1955 "rdb_bgsave_in_progress:%d\r\n"
1956 "rdb_last_save_time:%ld\r\n"
1957 "rdb_last_bgsave_status:%s\r\n"
1958 "rdb_last_bgsave_time_sec:%ld\r\n"
1959 "rdb_current_bgsave_time_sec:%ld\r\n"
1960 "aof_enabled:%d\r\n"
1961 "aof_rewrite_in_progress:%d\r\n"
1962 "aof_rewrite_scheduled:%d\r\n"
1963 "aof_last_rewrite_time_sec:%ld\r\n"
1964 "aof_current_rewrite_time_sec:%ld\r\n"
1965 "aof_last_bgrewrite_status:%s\r\n",
1968 server
.rdb_child_pid
!= -1,
1970 (server
.lastbgsave_status
== REDIS_OK
) ? "ok" : "err",
1971 server
.rdb_save_time_last
,
1972 (server
.rdb_child_pid
== -1) ?
1973 -1 : time(NULL
)-server
.rdb_save_time_start
,
1974 server
.aof_state
!= REDIS_AOF_OFF
,
1975 server
.aof_child_pid
!= -1,
1976 server
.aof_rewrite_scheduled
,
1977 server
.aof_rewrite_time_last
,
1978 (server
.aof_child_pid
== -1) ?
1979 -1 : time(NULL
)-server
.aof_rewrite_time_start
,
1980 (server
.aof_lastbgrewrite_status
== REDIS_OK
) ? "ok" : "err");
1982 if (server
.aof_state
!= REDIS_AOF_OFF
) {
1983 info
= sdscatprintf(info
,
1984 "aof_current_size:%lld\r\n"
1985 "aof_base_size:%lld\r\n"
1986 "aof_pending_rewrite:%d\r\n"
1987 "aof_buffer_length:%zu\r\n"
1988 "aof_rewrite_buffer_length:%lu\r\n"
1989 "aof_pending_bio_fsync:%llu\r\n"
1990 "aof_delayed_fsync:%lu\r\n",
1991 (long long) server
.aof_current_size
,
1992 (long long) server
.aof_rewrite_base_size
,
1993 server
.aof_rewrite_scheduled
,
1994 sdslen(server
.aof_buf
),
1995 aofRewriteBufferSize(),
1996 bioPendingJobsOfType(REDIS_BIO_AOF_FSYNC
),
1997 server
.aof_delayed_fsync
);
2000 if (server
.loading
) {
2002 time_t eta
, elapsed
;
2003 off_t remaining_bytes
= server
.loading_total_bytes
-
2004 server
.loading_loaded_bytes
;
2006 perc
= ((double)server
.loading_loaded_bytes
/
2007 server
.loading_total_bytes
) * 100;
2009 elapsed
= server
.unixtime
-server
.loading_start_time
;
2011 eta
= 1; /* A fake 1 second figure if we don't have
2014 eta
= (elapsed
*remaining_bytes
)/server
.loading_loaded_bytes
;
2017 info
= sdscatprintf(info
,
2018 "loading_start_time:%ld\r\n"
2019 "loading_total_bytes:%llu\r\n"
2020 "loading_loaded_bytes:%llu\r\n"
2021 "loading_loaded_perc:%.2f\r\n"
2022 "loading_eta_seconds:%ld\r\n"
2023 ,(unsigned long) server
.loading_start_time
,
2024 (unsigned long long) server
.loading_total_bytes
,
2025 (unsigned long long) server
.loading_loaded_bytes
,
2033 if (allsections
|| defsections
|| !strcasecmp(section
,"stats")) {
2034 if (sections
++) info
= sdscat(info
,"\r\n");
2035 info
= sdscatprintf(info
,
2037 "total_connections_received:%lld\r\n"
2038 "total_commands_processed:%lld\r\n"
2039 "instantaneous_ops_per_sec:%lld\r\n"
2040 "rejected_connections:%lld\r\n"
2041 "expired_keys:%lld\r\n"
2042 "evicted_keys:%lld\r\n"
2043 "keyspace_hits:%lld\r\n"
2044 "keyspace_misses:%lld\r\n"
2045 "pubsub_channels:%ld\r\n"
2046 "pubsub_patterns:%lu\r\n"
2047 "latest_fork_usec:%lld\r\n",
2048 server
.stat_numconnections
,
2049 server
.stat_numcommands
,
2050 getOperationsPerSecond(),
2051 server
.stat_rejected_conn
,
2052 server
.stat_expiredkeys
,
2053 server
.stat_evictedkeys
,
2054 server
.stat_keyspace_hits
,
2055 server
.stat_keyspace_misses
,
2056 dictSize(server
.pubsub_channels
),
2057 listLength(server
.pubsub_patterns
),
2058 server
.stat_fork_time
);
2062 if (allsections
|| defsections
|| !strcasecmp(section
,"replication")) {
2063 if (sections
++) info
= sdscat(info
,"\r\n");
2064 info
= sdscatprintf(info
,
2067 server
.masterhost
== NULL
? "master" : "slave");
2068 if (server
.masterhost
) {
2069 info
= sdscatprintf(info
,
2070 "master_host:%s\r\n"
2071 "master_port:%d\r\n"
2072 "master_link_status:%s\r\n"
2073 "master_last_io_seconds_ago:%d\r\n"
2074 "master_sync_in_progress:%d\r\n"
2077 (server
.repl_state
== REDIS_REPL_CONNECTED
) ?
2080 ((int)(server
.unixtime
-server
.master
->lastinteraction
)) : -1,
2081 server
.repl_state
== REDIS_REPL_TRANSFER
2084 if (server
.repl_state
== REDIS_REPL_TRANSFER
) {
2085 info
= sdscatprintf(info
,
2086 "master_sync_left_bytes:%lld\r\n"
2087 "master_sync_last_io_seconds_ago:%d\r\n"
2089 (server
.repl_transfer_size
- server
.repl_transfer_read
),
2090 (int)(server
.unixtime
-server
.repl_transfer_lastio
)
2094 if (server
.repl_state
!= REDIS_REPL_CONNECTED
) {
2095 info
= sdscatprintf(info
,
2096 "master_link_down_since_seconds:%ld\r\n",
2097 (long)server
.unixtime
-server
.repl_down_since
);
2099 info
= sdscatprintf(info
,
2100 "slave_priority:%d\r\n"
2101 "slave_read_only:%d\r\n",
2102 server
.slave_priority
,
2103 server
.repl_slave_ro
);
2105 info
= sdscatprintf(info
,
2106 "connected_slaves:%lu\r\n",
2107 listLength(server
.slaves
));
2108 if (listLength(server
.slaves
)) {
2113 listRewind(server
.slaves
,&li
);
2114 while((ln
= listNext(&li
))) {
2115 redisClient
*slave
= listNodeValue(ln
);
2120 if (anetPeerToString(slave
->fd
,ip
,&port
) == -1) continue;
2121 switch(slave
->replstate
) {
2122 case REDIS_REPL_WAIT_BGSAVE_START
:
2123 case REDIS_REPL_WAIT_BGSAVE_END
:
2124 state
= "wait_bgsave";
2126 case REDIS_REPL_SEND_BULK
:
2127 state
= "send_bulk";
2129 case REDIS_REPL_ONLINE
:
2133 if (state
== NULL
) continue;
2134 info
= sdscatprintf(info
,"slave%d:%s,%d,%s\r\n",
2135 slaveid
,ip
,slave
->slave_listening_port
,state
);
2142 if (allsections
|| defsections
|| !strcasecmp(section
,"cpu")) {
2143 if (sections
++) info
= sdscat(info
,"\r\n");
2144 info
= sdscatprintf(info
,
2146 "used_cpu_sys:%.2f\r\n"
2147 "used_cpu_user:%.2f\r\n"
2148 "used_cpu_sys_children:%.2f\r\n"
2149 "used_cpu_user_children:%.2f\r\n",
2150 (float)self_ru
.ru_stime
.tv_sec
+(float)self_ru
.ru_stime
.tv_usec
/1000000,
2151 (float)self_ru
.ru_utime
.tv_sec
+(float)self_ru
.ru_utime
.tv_usec
/1000000,
2152 (float)c_ru
.ru_stime
.tv_sec
+(float)c_ru
.ru_stime
.tv_usec
/1000000,
2153 (float)c_ru
.ru_utime
.tv_sec
+(float)c_ru
.ru_utime
.tv_usec
/1000000);
2157 if (allsections
|| !strcasecmp(section
,"commandstats")) {
2158 if (sections
++) info
= sdscat(info
,"\r\n");
2159 info
= sdscatprintf(info
, "# Commandstats\r\n");
2160 numcommands
= sizeof(redisCommandTable
)/sizeof(struct redisCommand
);
2161 for (j
= 0; j
< numcommands
; j
++) {
2162 struct redisCommand
*c
= redisCommandTable
+j
;
2164 if (!c
->calls
) continue;
2165 info
= sdscatprintf(info
,
2166 "cmdstat_%s:calls=%lld,usec=%lld,usec_per_call=%.2f\r\n",
2167 c
->name
, c
->calls
, c
->microseconds
,
2168 (c
->calls
== 0) ? 0 : ((float)c
->microseconds
/c
->calls
));
2173 if (allsections
|| defsections
|| !strcasecmp(section
,"keyspace")) {
2174 if (sections
++) info
= sdscat(info
,"\r\n");
2175 info
= sdscatprintf(info
, "# Keyspace\r\n");
2176 for (j
= 0; j
< server
.dbnum
; j
++) {
2177 long long keys
, vkeys
;
2179 keys
= dictSize(server
.db
[j
].dict
);
2180 vkeys
= dictSize(server
.db
[j
].expires
);
2181 if (keys
|| vkeys
) {
2182 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
2190 void infoCommand(redisClient
*c
) {
2191 char *section
= c
->argc
== 2 ? c
->argv
[1]->ptr
: "default";
2194 addReply(c
,shared
.syntaxerr
);
2197 sds info
= genRedisInfoString(section
);
2198 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
2199 (unsigned long)sdslen(info
)));
2200 addReplySds(c
,info
);
2201 addReply(c
,shared
.crlf
);
2204 void monitorCommand(redisClient
*c
) {
2205 /* ignore MONITOR if already slave or in monitor mode */
2206 if (c
->flags
& REDIS_SLAVE
) return;
2208 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
2210 listAddNodeTail(server
.monitors
,c
);
2211 addReply(c
,shared
.ok
);
2214 /* ============================ Maxmemory directive ======================== */
2216 /* This function gets called when 'maxmemory' is set on the config file to limit
2217 * the max memory used by the server, before processing a command.
2219 * The goal of the function is to free enough memory to keep Redis under the
2220 * configured memory limit.
2222 * The function starts calculating how many bytes should be freed to keep
2223 * Redis under the limit, and enters a loop selecting the best keys to
2224 * evict accordingly to the configured policy.
2226 * If all the bytes needed to return back under the limit were freed the
2227 * function returns REDIS_OK, otherwise REDIS_ERR is returned, and the caller
2228 * should block the execution of commands that will result in more memory
2229 * used by the server.
2231 int freeMemoryIfNeeded(void) {
2232 size_t mem_used
, mem_tofree
, mem_freed
;
2233 int slaves
= listLength(server
.slaves
);
2235 /* Remove the size of slaves output buffers and AOF buffer from the
2236 * count of used memory. */
2237 mem_used
= zmalloc_used_memory();
2242 listRewind(server
.slaves
,&li
);
2243 while((ln
= listNext(&li
))) {
2244 redisClient
*slave
= listNodeValue(ln
);
2245 unsigned long obuf_bytes
= getClientOutputBufferMemoryUsage(slave
);
2246 if (obuf_bytes
> mem_used
)
2249 mem_used
-= obuf_bytes
;
2252 if (server
.aof_state
!= REDIS_AOF_OFF
) {
2253 mem_used
-= sdslen(server
.aof_buf
);
2254 mem_used
-= aofRewriteBufferSize();
2257 /* Check if we are over the memory limit. */
2258 if (mem_used
<= server
.maxmemory
) return REDIS_OK
;
2260 if (server
.maxmemory_policy
== REDIS_MAXMEMORY_NO_EVICTION
)
2261 return REDIS_ERR
; /* We need to free memory, but policy forbids. */
2263 /* Compute how much memory we need to free. */
2264 mem_tofree
= mem_used
- server
.maxmemory
;
2266 while (mem_freed
< mem_tofree
) {
2267 int j
, k
, keys_freed
= 0;
2269 for (j
= 0; j
< server
.dbnum
; j
++) {
2270 long bestval
= 0; /* just to prevent warning */
2272 struct dictEntry
*de
;
2273 redisDb
*db
= server
.db
+j
;
2276 if (server
.maxmemory_policy
== REDIS_MAXMEMORY_ALLKEYS_LRU
||
2277 server
.maxmemory_policy
== REDIS_MAXMEMORY_ALLKEYS_RANDOM
)
2279 dict
= server
.db
[j
].dict
;
2281 dict
= server
.db
[j
].expires
;
2283 if (dictSize(dict
) == 0) continue;
2285 /* volatile-random and allkeys-random policy */
2286 if (server
.maxmemory_policy
== REDIS_MAXMEMORY_ALLKEYS_RANDOM
||
2287 server
.maxmemory_policy
== REDIS_MAXMEMORY_VOLATILE_RANDOM
)
2289 de
= dictGetRandomKey(dict
);
2290 bestkey
= dictGetKey(de
);
2293 /* volatile-lru and allkeys-lru policy */
2294 else if (server
.maxmemory_policy
== REDIS_MAXMEMORY_ALLKEYS_LRU
||
2295 server
.maxmemory_policy
== REDIS_MAXMEMORY_VOLATILE_LRU
)
2297 for (k
= 0; k
< server
.maxmemory_samples
; k
++) {
2302 de
= dictGetRandomKey(dict
);
2303 thiskey
= dictGetKey(de
);
2304 /* When policy is volatile-lru we need an additional lookup
2305 * to locate the real key, as dict is set to db->expires. */
2306 if (server
.maxmemory_policy
== REDIS_MAXMEMORY_VOLATILE_LRU
)
2307 de
= dictFind(db
->dict
, thiskey
);
2309 thisval
= estimateObjectIdleTime(o
);
2311 /* Higher idle time is better candidate for deletion */
2312 if (bestkey
== NULL
|| thisval
> bestval
) {
2320 else if (server
.maxmemory_policy
== REDIS_MAXMEMORY_VOLATILE_TTL
) {
2321 for (k
= 0; k
< server
.maxmemory_samples
; k
++) {
2325 de
= dictGetRandomKey(dict
);
2326 thiskey
= dictGetKey(de
);
2327 thisval
= (long) dictGetVal(de
);
2329 /* Expire sooner (minor expire unix timestamp) is better
2330 * candidate for deletion */
2331 if (bestkey
== NULL
|| thisval
< bestval
) {
2338 /* Finally remove the selected key. */
2342 robj
*keyobj
= createStringObject(bestkey
,sdslen(bestkey
));
2343 int archived
= archive(db
, keyobj
);
2344 redisAssert(archived
!= 0);
2345 propagateExpire(db
,keyobj
);
2346 /* We compute the amount of memory freed by dbDelete() alone.
2347 * It is possible that actually the memory needed to propagate
2348 * the DEL in AOF and replication link is greater than the one
2349 * we are freeing removing the key, but we can't account for
2350 * that otherwise we would never exit the loop.
2352 * AOF and Output buffer memory will be freed eventually so
2353 * we only care about memory used by the key space. */
2354 delta
= (long long) zmalloc_used_memory();
2355 dbDelete(db
,keyobj
);
2356 delta
-= (long long) zmalloc_used_memory();
2358 server
.stat_evictedkeys
++;
2359 decrRefCount(keyobj
);
2362 /* When the memory to free starts to be big enough, we may
2363 * start spending so much time here that is impossible to
2364 * deliver data to the slaves fast enough, so we force the
2365 * transmission here inside the loop. */
2366 if (slaves
) flushSlavesOutputBuffers();
2369 if (!keys_freed
) return REDIS_ERR
; /* nothing to free... */
2374 /* =================================== Main! ================================ */
2377 int linuxOvercommitMemoryValue(void) {
2378 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
2382 if (fgets(buf
,64,fp
) == NULL
) {
2391 void linuxOvercommitMemoryWarning(void) {
2392 if (linuxOvercommitMemoryValue() == 0) {
2393 redisLog(REDIS_WARNING
,"WARNING overcommit_memory is set to 0! Background save may fail under low memory condition. To fix this issue add 'vm.overcommit_memory = 1' to /etc/sysctl.conf and then reboot or run the command 'sysctl vm.overcommit_memory=1' for this to take effect.");
2396 #endif /* __linux__ */
2398 void createPidFile(void) {
2399 /* Try to write the pid file in a best-effort way. */
2400 FILE *fp
= fopen(server
.pidfile
,"w");
2402 fprintf(fp
,"%d\n",(int)getpid());
2407 void daemonize(void) {
2410 if (fork() != 0) exit(0); /* parent exits */
2411 setsid(); /* create a new session */
2413 /* Every output goes to /dev/null. If Redis is daemonized but
2414 * the 'logfile' is set to 'stdout' in the configuration file
2415 * it will not log at all. */
2416 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
2417 dup2(fd
, STDIN_FILENO
);
2418 dup2(fd
, STDOUT_FILENO
);
2419 dup2(fd
, STDERR_FILENO
);
2420 if (fd
> STDERR_FILENO
) close(fd
);
2425 printf("Redis server v=%s sha=%s:%d malloc=%s bits=%d\n",
2428 atoi(redisGitDirty()) > 0,
2430 sizeof(long) == 4 ? 32 : 64);
2435 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf] [options]\n");
2436 fprintf(stderr
," ./redis-server - (read config from stdin)\n");
2437 fprintf(stderr
," ./redis-server -v or --version\n");
2438 fprintf(stderr
," ./redis-server -h or --help\n");
2439 fprintf(stderr
," ./redis-server --test-memory <megabytes>\n\n");
2440 fprintf(stderr
,"Examples:\n");
2441 fprintf(stderr
," ./redis-server (run the server with default conf)\n");
2442 fprintf(stderr
," ./redis-server /etc/redis/6379.conf\n");
2443 fprintf(stderr
," ./redis-server --port 7777\n");
2444 fprintf(stderr
," ./redis-server --port 7777 --slaveof 127.0.0.1 8888\n");
2445 fprintf(stderr
," ./redis-server /etc/myredis.conf --loglevel verbose\n\n");
2446 fprintf(stderr
,"Sentinel mode:\n");
2447 fprintf(stderr
," ./redis-server /etc/sentinel.conf --sentinel\n");
2451 void redisAsciiArt(void) {
2452 #include "asciilogo.h"
2453 char *buf
= zmalloc(1024*16);
2454 char *mode
= "stand alone";
2456 if (server
.sentinel_mode
) mode
= "sentinel";
2458 snprintf(buf
,1024*16,ascii_logo
,
2461 strtol(redisGitDirty(),NULL
,10) > 0,
2462 (sizeof(long) == 8) ? "64" : "32",
2466 redisLogRaw(REDIS_NOTICE
|REDIS_LOG_RAW
,buf
);
2470 static void sigtermHandler(int sig
) {
2473 redisLogFromHandler(REDIS_WARNING
,"Received SIGTERM, scheduling shutdown...");
2474 server
.shutdown_asap
= 1;
2477 void setupSignalHandlers(void) {
2478 struct sigaction act
;
2480 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction is used.
2481 * Otherwise, sa_handler is used. */
2482 sigemptyset(&act
.sa_mask
);
2484 act
.sa_handler
= sigtermHandler
;
2485 sigaction(SIGTERM
, &act
, NULL
);
2487 #ifdef HAVE_BACKTRACE
2488 sigemptyset(&act
.sa_mask
);
2489 act
.sa_flags
= SA_NODEFER
| SA_RESETHAND
| SA_SIGINFO
;
2490 act
.sa_sigaction
= sigsegvHandler
;
2491 sigaction(SIGSEGV
, &act
, NULL
);
2492 sigaction(SIGBUS
, &act
, NULL
);
2493 sigaction(SIGFPE
, &act
, NULL
);
2494 sigaction(SIGILL
, &act
, NULL
);
2499 void memtest(size_t megabytes
, int passes
);
2501 /* Returns 1 if there is --sentinel among the arguments or if
2502 * argv[0] is exactly "redis-sentinel". */
2503 int checkForSentinelMode(int argc
, char **argv
) {
2506 if (strstr(argv
[0],"redis-sentinel") != NULL
) return 1;
2507 for (j
= 1; j
< argc
; j
++)
2508 if (!strcmp(argv
[j
],"--sentinel")) return 1;
2512 /* Function called at startup to load RDB or AOF file in memory. */
2513 void loadDataFromDisk(void) {
2514 long long start
= ustime();
2515 if (server
.aof_state
== REDIS_AOF_ON
) {
2516 if (loadAppendOnlyFile(server
.aof_filename
) == REDIS_OK
)
2517 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %.3f seconds",(float)(ustime()-start
)/1000000);
2519 if (rdbLoad(server
.rdb_filename
) == REDIS_OK
) {
2520 redisLog(REDIS_NOTICE
,"DB loaded from disk: %.3f seconds",
2521 (float)(ustime()-start
)/1000000);
2522 } else if (errno
!= ENOENT
) {
2523 redisLog(REDIS_WARNING
,"Fatal error loading the DB. Exiting.");
2529 void redisOutOfMemoryHandler(size_t allocation_size
) {
2530 redisLog(REDIS_WARNING
,"Out Of Memory allocating %zu bytes!",
2535 int main(int argc
, char **argv
) {
2538 /* We need to initialize our libraries, and the server configuration. */
2539 zmalloc_enable_thread_safeness();
2540 zmalloc_set_oom_handler(redisOutOfMemoryHandler
);
2541 srand(time(NULL
)^getpid());
2542 gettimeofday(&tv
,NULL
);
2543 dictSetHashFunctionSeed(tv
.tv_sec
^tv
.tv_usec
^getpid());
2544 server
.sentinel_mode
= checkForSentinelMode(argc
,argv
);
2547 /* We need to init sentinel right now as parsing the configuration file
2548 * in sentinel mode will have the effect of populating the sentinel
2549 * data structures with master nodes to monitor. */
2550 if (server
.sentinel_mode
) {
2551 initSentinelConfig();
2556 int j
= 1; /* First option to parse in argv[] */
2557 sds options
= sdsempty();
2558 char *configfile
= NULL
;
2560 /* Handle special options --help and --version */
2561 if (strcmp(argv
[1], "-v") == 0 ||
2562 strcmp(argv
[1], "--version") == 0) version();
2563 if (strcmp(argv
[1], "--help") == 0 ||
2564 strcmp(argv
[1], "-h") == 0) usage();
2565 if (strcmp(argv
[1], "--test-memory") == 0) {
2567 memtest(atoi(argv
[2]),50);
2570 fprintf(stderr
,"Please specify the amount of memory to test in megabytes.\n");
2571 fprintf(stderr
,"Example: ./redis-server --test-memory 4096\n\n");
2576 /* First argument is the config file name? */
2577 if (argv
[j
][0] != '-' || argv
[j
][1] != '-')
2578 configfile
= argv
[j
++];
2579 /* All the other options are parsed and conceptually appended to the
2580 * configuration file. For instance --port 6380 will generate the
2581 * string "port 6380\n" to be parsed after the actual file name
2582 * is parsed, if any. */
2584 if (argv
[j
][0] == '-' && argv
[j
][1] == '-') {
2586 if (sdslen(options
)) options
= sdscat(options
,"\n");
2587 options
= sdscat(options
,argv
[j
]+2);
2588 options
= sdscat(options
," ");
2590 /* Option argument */
2591 options
= sdscatrepr(options
,argv
[j
],strlen(argv
[j
]));
2592 options
= sdscat(options
," ");
2596 resetServerSaveParams();
2597 loadServerConfig(configfile
,options
);
2600 redisLog(REDIS_WARNING
, "Warning: no config file specified, using the default config. In order to specify a config file use %s /path/to/%s.conf", argv
[0], server
.sentinel_mode
? "sentinel" : "redis");
2602 if (server
.daemonize
) daemonize();
2604 if (server
.daemonize
) createPidFile();
2607 if (!server
.sentinel_mode
) {
2608 /* Things only needed when not running in Sentinel mode. */
2609 redisLog(REDIS_WARNING
,"Server started, Redis version " REDIS_VERSION
);
2611 linuxOvercommitMemoryWarning();
2614 if (server
.ipfd
> 0)
2615 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
2616 if (server
.sofd
> 0)
2617 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections at %s", server
.unixsocket
);
2620 /* Warning the user about suspicious maxmemory setting. */
2621 if (server
.maxmemory
> 0 && server
.maxmemory
< 1024*1024) {
2622 redisLog(REDIS_WARNING
,"WARNING: You specified a maxmemory value that is less than 1MB (current value is %llu bytes). Are you sure this is what you really want?", server
.maxmemory
);
2625 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
2627 aeDeleteEventLoop(server
.el
);