2 * Copyright (c) 2009-2010, Salvatore Sanfilippo <antirez at gmail dot com>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
8 * * Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * * Neither the name of Redis nor the names of its contributors may be used
14 * to endorse or promote products derived from this software without
15 * specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 * POSSIBILITY OF SUCH DAMAGE.
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
114 struct redisCommand redisCommandTable
[] = {
115 {"get",getCommand
,2,"r",0,NULL
,1,1,1,0,0},
116 {"set",setCommand
,3,"wm",0,noPreloadGetKeys
,1,1,1,0,0},
117 {"setnx",setnxCommand
,3,"wm",0,noPreloadGetKeys
,1,1,1,0,0},
118 {"setex",setexCommand
,4,"wm",0,noPreloadGetKeys
,1,1,1,0,0},
119 {"psetex",psetexCommand
,4,"wm",0,noPreloadGetKeys
,1,1,1,0,0},
120 {"append",appendCommand
,3,"wm",0,NULL
,1,1,1,0,0},
121 {"strlen",strlenCommand
,2,"r",0,NULL
,1,1,1,0,0},
122 {"del",delCommand
,-2,"w",0,noPreloadGetKeys
,1,-1,1,0,0},
123 {"exists",existsCommand
,2,"r",0,NULL
,1,1,1,0,0},
124 {"setbit",setbitCommand
,4,"wm",0,NULL
,1,1,1,0,0},
125 {"getbit",getbitCommand
,3,"r",0,NULL
,1,1,1,0,0},
126 {"setrange",setrangeCommand
,4,"wm",0,NULL
,1,1,1,0,0},
127 {"getrange",getrangeCommand
,4,"r",0,NULL
,1,1,1,0,0},
128 {"substr",getrangeCommand
,4,"r",0,NULL
,1,1,1,0,0},
129 {"incr",incrCommand
,2,"wm",0,NULL
,1,1,1,0,0},
130 {"decr",decrCommand
,2,"wm",0,NULL
,1,1,1,0,0},
131 {"mget",mgetCommand
,-2,"r",0,NULL
,1,-1,1,0,0},
132 {"rpush",rpushCommand
,-3,"wm",0,NULL
,1,1,1,0,0},
133 {"lpush",lpushCommand
,-3,"wm",0,NULL
,1,1,1,0,0},
134 {"rpushx",rpushxCommand
,3,"wm",0,NULL
,1,1,1,0,0},
135 {"lpushx",lpushxCommand
,3,"wm",0,NULL
,1,1,1,0,0},
136 {"linsert",linsertCommand
,5,"wm",0,NULL
,1,1,1,0,0},
137 {"rpop",rpopCommand
,2,"w",0,NULL
,1,1,1,0,0},
138 {"lpop",lpopCommand
,2,"w",0,NULL
,1,1,1,0,0},
139 {"brpop",brpopCommand
,-3,"ws",0,NULL
,1,1,1,0,0},
140 {"brpoplpush",brpoplpushCommand
,4,"wms",0,NULL
,1,2,1,0,0},
141 {"blpop",blpopCommand
,-3,"ws",0,NULL
,1,-2,1,0,0},
142 {"llen",llenCommand
,2,"r",0,NULL
,1,1,1,0,0},
143 {"lindex",lindexCommand
,3,"r",0,NULL
,1,1,1,0,0},
144 {"lset",lsetCommand
,4,"wm",0,NULL
,1,1,1,0,0},
145 {"lrange",lrangeCommand
,4,"r",0,NULL
,1,1,1,0,0},
146 {"ltrim",ltrimCommand
,4,"w",0,NULL
,1,1,1,0,0},
147 {"lrem",lremCommand
,4,"w",0,NULL
,1,1,1,0,0},
148 {"rpoplpush",rpoplpushCommand
,3,"wm",0,NULL
,1,2,1,0,0},
149 {"sadd",saddCommand
,-3,"wm",0,NULL
,1,1,1,0,0},
150 {"srem",sremCommand
,-3,"w",0,NULL
,1,1,1,0,0},
151 {"smove",smoveCommand
,4,"w",0,NULL
,1,2,1,0,0},
152 {"sismember",sismemberCommand
,3,"r",0,NULL
,1,1,1,0,0},
153 {"scard",scardCommand
,2,"r",0,NULL
,1,1,1,0,0},
154 {"spop",spopCommand
,2,"wRs",0,NULL
,1,1,1,0,0},
155 {"srandmember",srandmemberCommand
,2,"rR",0,NULL
,1,1,1,0,0},
156 {"sinter",sinterCommand
,-2,"rS",0,NULL
,1,-1,1,0,0},
157 {"sinterstore",sinterstoreCommand
,-3,"wm",0,NULL
,1,-1,1,0,0},
158 {"sunion",sunionCommand
,-2,"rS",0,NULL
,1,-1,1,0,0},
159 {"sunionstore",sunionstoreCommand
,-3,"wm",0,NULL
,1,-1,1,0,0},
160 {"sdiff",sdiffCommand
,-2,"rS",0,NULL
,1,-1,1,0,0},
161 {"sdiffstore",sdiffstoreCommand
,-3,"wm",0,NULL
,1,-1,1,0,0},
162 {"smembers",sinterCommand
,2,"rS",0,NULL
,1,1,1,0,0},
163 {"zadd",zaddCommand
,-4,"wm",0,NULL
,1,1,1,0,0},
164 {"zincrby",zincrbyCommand
,4,"wm",0,NULL
,1,1,1,0,0},
165 {"zrem",zremCommand
,-3,"w",0,NULL
,1,1,1,0,0},
166 {"zremrangebyscore",zremrangebyscoreCommand
,4,"w",0,NULL
,1,1,1,0,0},
167 {"zremrangebyrank",zremrangebyrankCommand
,4,"w",0,NULL
,1,1,1,0,0},
168 {"zunionstore",zunionstoreCommand
,-4,"wm",0,zunionInterGetKeys
,0,0,0,0,0},
169 {"zinterstore",zinterstoreCommand
,-4,"wm",0,zunionInterGetKeys
,0,0,0,0,0},
170 {"zrange",zrangeCommand
,-4,"r",0,NULL
,1,1,1,0,0},
171 {"zrangebyscore",zrangebyscoreCommand
,-4,"r",0,NULL
,1,1,1,0,0},
172 {"zrevrangebyscore",zrevrangebyscoreCommand
,-4,"r",0,NULL
,1,1,1,0,0},
173 {"zcount",zcountCommand
,4,"r",0,NULL
,1,1,1,0,0},
174 {"zrevrange",zrevrangeCommand
,-4,"r",0,NULL
,1,1,1,0,0},
175 {"zcard",zcardCommand
,2,"r",0,NULL
,1,1,1,0,0},
176 {"zscore",zscoreCommand
,3,"r",0,NULL
,1,1,1,0,0},
177 {"zrank",zrankCommand
,3,"r",0,NULL
,1,1,1,0,0},
178 {"zrevrank",zrevrankCommand
,3,"r",0,NULL
,1,1,1,0,0},
179 {"hset",hsetCommand
,4,"wm",0,NULL
,1,1,1,0,0},
180 {"hsetnx",hsetnxCommand
,4,"wm",0,NULL
,1,1,1,0,0},
181 {"hget",hgetCommand
,3,"r",0,NULL
,1,1,1,0,0},
182 {"hmset",hmsetCommand
,-4,"wm",0,NULL
,1,1,1,0,0},
183 {"hmget",hmgetCommand
,-3,"r",0,NULL
,1,1,1,0,0},
184 {"hincrby",hincrbyCommand
,4,"wm",0,NULL
,1,1,1,0,0},
185 {"hincrbyfloat",hincrbyfloatCommand
,4,"wm",0,NULL
,1,1,1,0,0},
186 {"hdel",hdelCommand
,-3,"w",0,NULL
,1,1,1,0,0},
187 {"hlen",hlenCommand
,2,"r",0,NULL
,1,1,1,0,0},
188 {"hkeys",hkeysCommand
,2,"rS",0,NULL
,1,1,1,0,0},
189 {"hvals",hvalsCommand
,2,"rS",0,NULL
,1,1,1,0,0},
190 {"hgetall",hgetallCommand
,2,"r",0,NULL
,1,1,1,0,0},
191 {"hexists",hexistsCommand
,3,"r",0,NULL
,1,1,1,0,0},
192 {"incrby",incrbyCommand
,3,"wm",0,NULL
,1,1,1,0,0},
193 {"decrby",decrbyCommand
,3,"wm",0,NULL
,1,1,1,0,0},
194 {"incrbyfloat",incrbyfloatCommand
,3,"wm",0,NULL
,1,1,1,0,0},
195 {"getset",getsetCommand
,3,"wm",0,NULL
,1,1,1,0,0},
196 {"mset",msetCommand
,-3,"wm",0,NULL
,1,-1,2,0,0},
197 {"msetnx",msetnxCommand
,-3,"wm",0,NULL
,1,-1,2,0,0},
198 {"randomkey",randomkeyCommand
,1,"rR",0,NULL
,0,0,0,0,0},
199 {"select",selectCommand
,2,"r",0,NULL
,0,0,0,0,0},
200 {"move",moveCommand
,3,"w",0,NULL
,1,1,1,0,0},
201 {"rename",renameCommand
,3,"w",0,renameGetKeys
,1,2,1,0,0},
202 {"renamenx",renamenxCommand
,3,"w",0,renameGetKeys
,1,2,1,0,0},
203 {"expire",expireCommand
,3,"w",0,NULL
,1,1,1,0,0},
204 {"expireat",expireatCommand
,3,"w",0,NULL
,1,1,1,0,0},
205 {"pexpire",pexpireCommand
,3,"w",0,NULL
,1,1,1,0,0},
206 {"pexpireat",pexpireatCommand
,3,"w",0,NULL
,1,1,1,0,0},
207 {"keys",keysCommand
,2,"rS",0,NULL
,0,0,0,0,0},
208 {"dbsize",dbsizeCommand
,1,"r",0,NULL
,0,0,0,0,0},
209 {"auth",authCommand
,2,"rs",0,NULL
,0,0,0,0,0},
210 {"ping",pingCommand
,1,"r",0,NULL
,0,0,0,0,0},
211 {"echo",echoCommand
,2,"r",0,NULL
,0,0,0,0,0},
212 {"save",saveCommand
,1,"ars",0,NULL
,0,0,0,0,0},
213 {"bgsave",bgsaveCommand
,1,"ar",0,NULL
,0,0,0,0,0},
214 {"bgrewriteaof",bgrewriteaofCommand
,1,"ar",0,NULL
,0,0,0,0,0},
215 {"shutdown",shutdownCommand
,-1,"ar",0,NULL
,0,0,0,0,0},
216 {"lastsave",lastsaveCommand
,1,"r",0,NULL
,0,0,0,0,0},
217 {"type",typeCommand
,2,"r",0,NULL
,1,1,1,0,0},
218 {"multi",multiCommand
,1,"rs",0,NULL
,0,0,0,0,0},
219 {"exec",execCommand
,1,"s",0,NULL
,0,0,0,0,0},
220 {"discard",discardCommand
,1,"rs",0,NULL
,0,0,0,0,0},
221 {"sync",syncCommand
,1,"ars",0,NULL
,0,0,0,0,0},
222 {"replconf",replconfCommand
,-1,"ars",0,NULL
,0,0,0,0,0},
223 {"flushdb",flushdbCommand
,1,"w",0,NULL
,0,0,0,0,0},
224 {"flushall",flushallCommand
,1,"w",0,NULL
,0,0,0,0,0},
225 {"sort",sortCommand
,-2,"wmS",0,NULL
,1,1,1,0,0},
226 {"info",infoCommand
,-1,"rlt",0,NULL
,0,0,0,0,0},
227 {"monitor",monitorCommand
,1,"ars",0,NULL
,0,0,0,0,0},
228 {"ttl",ttlCommand
,2,"r",0,NULL
,1,1,1,0,0},
229 {"pttl",pttlCommand
,2,"r",0,NULL
,1,1,1,0,0},
230 {"persist",persistCommand
,2,"w",0,NULL
,1,1,1,0,0},
231 {"slaveof",slaveofCommand
,3,"ast",0,NULL
,0,0,0,0,0},
232 {"debug",debugCommand
,-2,"as",0,NULL
,0,0,0,0,0},
233 {"config",configCommand
,-2,"ar",0,NULL
,0,0,0,0,0},
234 {"subscribe",subscribeCommand
,-2,"rpslt",0,NULL
,0,0,0,0,0},
235 {"unsubscribe",unsubscribeCommand
,-1,"rpslt",0,NULL
,0,0,0,0,0},
236 {"psubscribe",psubscribeCommand
,-2,"rpslt",0,NULL
,0,0,0,0,0},
237 {"punsubscribe",punsubscribeCommand
,-1,"rpslt",0,NULL
,0,0,0,0,0},
238 {"publish",publishCommand
,3,"pflt",0,NULL
,0,0,0,0,0},
239 {"watch",watchCommand
,-2,"rs",0,noPreloadGetKeys
,1,-1,1,0,0},
240 {"unwatch",unwatchCommand
,1,"rs",0,NULL
,0,0,0,0,0},
241 {"cluster",clusterCommand
,-2,"ar",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 {"asking",askingCommand
,1,"r",0,NULL
,0,0,0,0,0},
245 {"dump",dumpCommand
,2,"ar",0,NULL
,1,1,1,0,0},
246 {"object",objectCommand
,-2,"r",0,NULL
,2,2,2,0,0},
247 {"client",clientCommand
,-2,"ar",0,NULL
,0,0,0,0,0},
248 {"eval",evalCommand
,-3,"s",0,zunionInterGetKeys
,0,0,0,0,0},
249 {"evalsha",evalShaCommand
,-3,"s",0,zunionInterGetKeys
,0,0,0,0,0},
250 {"slowlog",slowlogCommand
,-2,"r",0,NULL
,0,0,0,0,0},
251 {"script",scriptCommand
,-2,"ras",0,NULL
,0,0,0,0,0},
252 {"time",timeCommand
,1,"rR",0,NULL
,0,0,0,0,0},
253 {"bitop",bitopCommand
,-4,"wm",0,NULL
,2,-1,1,0,0},
254 {"bitcount",bitcountCommand
,-2,"r",0,NULL
,1,1,1,0,0}
257 /*============================ Utility functions ============================ */
259 /* Low level logging. To use only for very big messages, otherwise
260 * redisLog() is to prefer. */
261 void redisLogRaw(int level
, const char *msg
) {
262 const int syslogLevelMap
[] = { LOG_DEBUG
, LOG_INFO
, LOG_NOTICE
, LOG_WARNING
};
263 const char *c
= ".-*#";
266 int rawmode
= (level
& REDIS_LOG_RAW
);
268 level
&= 0xff; /* clear flags */
269 if (level
< server
.verbosity
) return;
271 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
275 fprintf(fp
,"%s",msg
);
280 gettimeofday(&tv
,NULL
);
281 off
= strftime(buf
,sizeof(buf
),"%d %b %H:%M:%S.",localtime(&tv
.tv_sec
));
282 snprintf(buf
+off
,sizeof(buf
)-off
,"%03d",(int)tv
.tv_usec
/1000);
283 fprintf(fp
,"[%d] %s %c %s\n",(int)getpid(),buf
,c
[level
],msg
);
287 if (server
.logfile
) fclose(fp
);
289 if (server
.syslog_enabled
) syslog(syslogLevelMap
[level
], "%s", msg
);
292 /* Like redisLogRaw() but with printf-alike support. This is the funciton that
293 * is used across the code. The raw version is only used in order to dump
294 * the INFO output on crash. */
295 void redisLog(int level
, const char *fmt
, ...) {
297 char msg
[REDIS_MAX_LOGMSG_LEN
];
299 if ((level
&0xff) < server
.verbosity
) return;
302 vsnprintf(msg
, sizeof(msg
), fmt
, ap
);
305 redisLogRaw(level
,msg
);
308 /* Log a fixed message without printf-alike capabilities, in a way that is
309 * safe to call from a signal handler.
311 * We actually use this only for signals that are not fatal from the point
312 * of view of Redis. Signals that are going to kill the server anyway and
313 * where we need printf-alike features are served by redisLog(). */
314 void redisLogFromHandler(int level
, const char *msg
) {
318 if ((level
&0xff) < server
.verbosity
||
319 (server
.logfile
== NULL
&& server
.daemonize
)) return;
320 fd
= server
.logfile
?
321 open(server
.logfile
, O_APPEND
|O_CREAT
|O_WRONLY
, 0644) :
323 if (fd
== -1) return;
324 ll2string(buf
,sizeof(buf
),getpid());
325 if (write(fd
,"[",1) == -1) goto err
;
326 if (write(fd
,buf
,strlen(buf
)) == -1) goto err
;
327 if (write(fd
," | signal handler] (",20) == -1) goto err
;
328 ll2string(buf
,sizeof(buf
),time(NULL
));
329 if (write(fd
,buf
,strlen(buf
)) == -1) goto err
;
330 if (write(fd
,") ",2) == -1) goto err
;
331 if (write(fd
,msg
,strlen(msg
)) == -1) goto err
;
332 if (write(fd
,"\n",1) == -1) goto err
;
334 if (server
.logfile
) close(fd
);
337 /* Redis generally does not try to recover from out of memory conditions
338 * when allocating objects or strings, it is not clear if it will be possible
339 * to report this condition to the client since the networking layer itself
340 * is based on heap allocation for send buffers, so we simply abort.
341 * At least the code will be simpler to read... */
342 void oom(const char *msg
) {
343 redisLog(REDIS_WARNING
, "%s: Out of memory\n",msg
);
348 /* Return the UNIX time in microseconds */
349 long long ustime(void) {
353 gettimeofday(&tv
, NULL
);
354 ust
= ((long long)tv
.tv_sec
)*1000000;
359 /* Return the UNIX time in milliseconds */
360 long long mstime(void) {
361 return ustime()/1000;
364 /* After an RDB dump or AOF rewrite we exit from children using _exit() instead of
365 * exit(), because the latter may interact with the same file objects used by
366 * the parent process. However if we are testing the coverage normal exit() is
367 * used in order to obtain the right coverage information. */
368 void exitFromChild(int retcode
) {
376 /*====================== Hash table type implementation ==================== */
378 /* This is an hash table type that uses the SDS dynamic strings libary as
379 * keys and radis objects as values (objects can hold SDS strings,
382 void dictVanillaFree(void *privdata
, void *val
)
384 DICT_NOTUSED(privdata
);
388 void dictListDestructor(void *privdata
, void *val
)
390 DICT_NOTUSED(privdata
);
391 listRelease((list
*)val
);
394 int dictSdsKeyCompare(void *privdata
, const void *key1
,
398 DICT_NOTUSED(privdata
);
400 l1
= sdslen((sds
)key1
);
401 l2
= sdslen((sds
)key2
);
402 if (l1
!= l2
) return 0;
403 return memcmp(key1
, key2
, l1
) == 0;
406 /* A case insensitive version used for the command lookup table. */
407 int dictSdsKeyCaseCompare(void *privdata
, const void *key1
,
410 DICT_NOTUSED(privdata
);
412 return strcasecmp(key1
, key2
) == 0;
415 void dictRedisObjectDestructor(void *privdata
, void *val
)
417 DICT_NOTUSED(privdata
);
419 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
423 void dictSdsDestructor(void *privdata
, void *val
)
425 DICT_NOTUSED(privdata
);
430 int dictObjKeyCompare(void *privdata
, const void *key1
,
433 const robj
*o1
= key1
, *o2
= key2
;
434 return dictSdsKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
437 unsigned int dictObjHash(const void *key
) {
439 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
442 unsigned int dictSdsHash(const void *key
) {
443 return dictGenHashFunction((unsigned char*)key
, sdslen((char*)key
));
446 unsigned int dictSdsCaseHash(const void *key
) {
447 return dictGenCaseHashFunction((unsigned char*)key
, sdslen((char*)key
));
450 int dictEncObjKeyCompare(void *privdata
, const void *key1
,
453 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
456 if (o1
->encoding
== REDIS_ENCODING_INT
&&
457 o2
->encoding
== REDIS_ENCODING_INT
)
458 return o1
->ptr
== o2
->ptr
;
460 o1
= getDecodedObject(o1
);
461 o2
= getDecodedObject(o2
);
462 cmp
= dictSdsKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
468 unsigned int dictEncObjHash(const void *key
) {
469 robj
*o
= (robj
*) key
;
471 if (o
->encoding
== REDIS_ENCODING_RAW
) {
472 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
474 if (o
->encoding
== REDIS_ENCODING_INT
) {
478 len
= ll2string(buf
,32,(long)o
->ptr
);
479 return dictGenHashFunction((unsigned char*)buf
, len
);
483 o
= getDecodedObject(o
);
484 hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
491 /* Sets type hash table */
492 dictType setDictType
= {
493 dictEncObjHash
, /* hash function */
496 dictEncObjKeyCompare
, /* key compare */
497 dictRedisObjectDestructor
, /* key destructor */
498 NULL
/* val destructor */
501 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
502 dictType zsetDictType
= {
503 dictEncObjHash
, /* hash function */
506 dictEncObjKeyCompare
, /* key compare */
507 dictRedisObjectDestructor
, /* key destructor */
508 NULL
/* val destructor */
511 /* Db->dict, keys are sds strings, vals are Redis objects. */
512 dictType dbDictType
= {
513 dictSdsHash
, /* hash function */
516 dictSdsKeyCompare
, /* key compare */
517 dictSdsDestructor
, /* key destructor */
518 dictRedisObjectDestructor
/* val destructor */
522 dictType keyptrDictType
= {
523 dictSdsHash
, /* hash function */
526 dictSdsKeyCompare
, /* key compare */
527 NULL
, /* key destructor */
528 NULL
/* val destructor */
531 /* Command table. sds string -> command struct pointer. */
532 dictType commandTableDictType
= {
533 dictSdsCaseHash
, /* hash function */
536 dictSdsKeyCaseCompare
, /* key compare */
537 dictSdsDestructor
, /* key destructor */
538 NULL
/* val destructor */
541 /* Hash type hash table (note that small hashes are represented with zimpaps) */
542 dictType hashDictType
= {
543 dictEncObjHash
, /* hash function */
546 dictEncObjKeyCompare
, /* key compare */
547 dictRedisObjectDestructor
, /* key destructor */
548 dictRedisObjectDestructor
/* val destructor */
551 /* Keylist hash table type has unencoded redis objects as keys and
552 * lists as values. It's used for blocking operations (BLPOP) and to
553 * map swapped keys to a list of clients waiting for this keys to be loaded. */
554 dictType keylistDictType
= {
555 dictObjHash
, /* hash function */
558 dictObjKeyCompare
, /* key compare */
559 dictRedisObjectDestructor
, /* key destructor */
560 dictListDestructor
/* val destructor */
563 /* Cluster nodes hash table, mapping nodes addresses 1.2.3.4:6379 to
564 * clusterNode structures. */
565 dictType clusterNodesDictType
= {
566 dictSdsHash
, /* hash function */
569 dictSdsKeyCompare
, /* key compare */
570 dictSdsDestructor
, /* key destructor */
571 NULL
/* val destructor */
574 int htNeedsResize(dict
*dict
) {
575 long long size
, used
;
577 size
= dictSlots(dict
);
578 used
= dictSize(dict
);
579 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
580 (used
*100/size
< REDIS_HT_MINFILL
));
583 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
584 * we resize the hash table to save memory */
585 void tryResizeHashTables(void) {
588 for (j
= 0; j
< server
.dbnum
; j
++) {
589 if (htNeedsResize(server
.db
[j
].dict
))
590 dictResize(server
.db
[j
].dict
);
591 if (htNeedsResize(server
.db
[j
].expires
))
592 dictResize(server
.db
[j
].expires
);
596 /* Our hash table implementation performs rehashing incrementally while
597 * we write/read from the hash table. Still if the server is idle, the hash
598 * table will use two tables for a long time. So we try to use 1 millisecond
599 * of CPU time at every serverCron() loop in order to rehash some key. */
600 void incrementallyRehash(void) {
603 for (j
= 0; j
< server
.dbnum
; j
++) {
604 /* Keys dictionary */
605 if (dictIsRehashing(server
.db
[j
].dict
)) {
606 dictRehashMilliseconds(server
.db
[j
].dict
,1);
607 break; /* already used our millisecond for this loop... */
610 if (dictIsRehashing(server
.db
[j
].expires
)) {
611 dictRehashMilliseconds(server
.db
[j
].expires
,1);
612 break; /* already used our millisecond for this loop... */
617 /* This function is called once a background process of some kind terminates,
618 * as we want to avoid resizing the hash tables when there is a child in order
619 * to play well with copy-on-write (otherwise when a resize happens lots of
620 * memory pages are copied). The goal of this function is to update the ability
621 * for dict.c to resize the hash tables accordingly to the fact we have o not
623 void updateDictResizePolicy(void) {
624 if (server
.rdb_child_pid
== -1 && server
.aof_child_pid
== -1)
630 /* ======================= Cron: called every 100 ms ======================== */
632 /* Try to expire a few timed out keys. The algorithm used is adaptive and
633 * will use few CPU cycles if there are few expiring keys, otherwise
634 * it will get more aggressive to avoid that too much memory is used by
635 * keys that can be removed from the keyspace. */
636 void activeExpireCycle(void) {
637 int j
, iteration
= 0;
638 long long start
= ustime(), timelimit
;
640 /* We can use at max REDIS_EXPIRELOOKUPS_TIME_PERC percentage of CPU time
641 * per iteration. Since this function gets called with a frequency of
642 * REDIS_HZ times per second, the following is the max amount of
643 * microseconds we can spend in this function. */
644 timelimit
= 1000000*REDIS_EXPIRELOOKUPS_TIME_PERC
/REDIS_HZ
/100;
645 if (timelimit
<= 0) timelimit
= 1;
647 for (j
= 0; j
< server
.dbnum
; j
++) {
649 redisDb
*db
= server
.db
+j
;
651 /* Continue to expire if at the end of the cycle more than 25%
652 * of the keys were expired. */
654 unsigned long num
= dictSize(db
->expires
);
655 unsigned long slots
= dictSlots(db
->expires
);
656 long long now
= mstime();
658 /* When there are less than 1% filled slots getting random
659 * keys is expensive, so stop here waiting for better times...
660 * The dictionary will be resized asap. */
661 if (num
&& slots
> DICT_HT_INITIAL_SIZE
&&
662 (num
*100/slots
< 1)) break;
664 /* The main collection cycle. Sample random keys among keys
665 * with an expire set, checking for expired ones. */
667 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
668 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
673 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
674 t
= dictGetSignedIntegerVal(de
);
676 sds key
= dictGetKey(de
);
677 robj
*keyobj
= createStringObject(key
,sdslen(key
));
679 propagateExpire(db
,keyobj
);
681 decrRefCount(keyobj
);
683 server
.stat_expiredkeys
++;
686 /* We can't block forever here even if there are many keys to
687 * expire. So after a given amount of milliseconds return to the
688 * caller waiting for the other active expire cycle. */
690 if ((iteration
& 0xf) == 0 && /* check once every 16 cycles. */
691 (ustime()-start
) > timelimit
) return;
692 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
696 void updateLRUClock(void) {
697 server
.lruclock
= (server
.unixtime
/REDIS_LRU_CLOCK_RESOLUTION
) &
702 /* Add a sample to the operations per second array of samples. */
703 void trackOperationsPerSecond(void) {
704 long long t
= mstime() - server
.ops_sec_last_sample_time
;
705 long long ops
= server
.stat_numcommands
- server
.ops_sec_last_sample_ops
;
708 ops_sec
= t
> 0 ? (ops
*1000/t
) : 0;
710 server
.ops_sec_samples
[server
.ops_sec_idx
] = ops_sec
;
711 server
.ops_sec_idx
= (server
.ops_sec_idx
+1) % REDIS_OPS_SEC_SAMPLES
;
712 server
.ops_sec_last_sample_time
= mstime();
713 server
.ops_sec_last_sample_ops
= server
.stat_numcommands
;
716 /* Return the mean of all the samples. */
717 long long getOperationsPerSecond(void) {
721 for (j
= 0; j
< REDIS_OPS_SEC_SAMPLES
; j
++)
722 sum
+= server
.ops_sec_samples
[j
];
723 return sum
/ REDIS_OPS_SEC_SAMPLES
;
726 /* Check for timeouts. Returns non-zero if the client was terminated */
727 int clientsCronHandleTimeout(redisClient
*c
) {
728 time_t now
= server
.unixtime
;
730 if (server
.maxidletime
&&
731 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
732 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
733 !(c
->flags
& REDIS_BLOCKED
) && /* no timeout for BLPOP */
734 dictSize(c
->pubsub_channels
) == 0 && /* no timeout for pubsub */
735 listLength(c
->pubsub_patterns
) == 0 &&
736 (now
- c
->lastinteraction
> server
.maxidletime
))
738 redisLog(REDIS_VERBOSE
,"Closing idle client");
741 } else if (c
->flags
& REDIS_BLOCKED
) {
742 if (c
->bpop
.timeout
!= 0 && c
->bpop
.timeout
< now
) {
743 addReply(c
,shared
.nullmultibulk
);
744 unblockClientWaitingData(c
);
750 /* The client query buffer is an sds.c string that can end with a lot of
751 * free space not used, this function reclaims space if needed.
753 * The funciton always returns 0 as it never terminates the client. */
754 int clientsCronResizeQueryBuffer(redisClient
*c
) {
755 size_t querybuf_size
= sdsAllocSize(c
->querybuf
);
756 time_t idletime
= server
.unixtime
- c
->lastinteraction
;
758 /* There are two conditions to resize the query buffer:
759 * 1) Query buffer is > BIG_ARG and too big for latest peak.
760 * 2) Client is inactive and the buffer is bigger than 1k. */
761 if (((querybuf_size
> REDIS_MBULK_BIG_ARG
) &&
762 (querybuf_size
/(c
->querybuf_peak
+1)) > 2) ||
763 (querybuf_size
> 1024 && idletime
> 2))
765 /* Only resize the query buffer if it is actually wasting space. */
766 if (sdsavail(c
->querybuf
) > 1024) {
767 c
->querybuf
= sdsRemoveFreeSpace(c
->querybuf
);
770 /* Reset the peak again to capture the peak memory usage in the next
772 c
->querybuf_peak
= 0;
776 void clientsCron(void) {
777 /* Make sure to process at least 1/(REDIS_HZ*10) of clients per call.
778 * Since this function is called REDIS_HZ times per second we are sure that
779 * in the worst case we process all the clients in 10 seconds.
780 * In normal conditions (a reasonable number of clients) we process
781 * all the clients in a shorter time. */
782 int numclients
= listLength(server
.clients
);
783 int iterations
= numclients
/(REDIS_HZ
*10);
786 iterations
= (numclients
< 50) ? numclients
: 50;
787 while(listLength(server
.clients
) && iterations
--) {
791 /* Rotate the list, take the current head, process.
792 * This way if the client must be removed from the list it's the
793 * first element and we don't incur into O(N) computation. */
794 listRotate(server
.clients
);
795 head
= listFirst(server
.clients
);
796 c
= listNodeValue(head
);
797 /* The following functions do different service checks on the client.
798 * The protocol is that they return non-zero if the client was
800 if (clientsCronHandleTimeout(c
)) continue;
801 if (clientsCronResizeQueryBuffer(c
)) continue;
805 /* This is our timer interrupt, called REDIS_HZ times per second.
806 * Here is where we do a number of things that need to be done asynchronously.
809 * - Active expired keys collection (it is also performed in a lazy way on
811 * - Software watchdong.
812 * - Update some statistic.
813 * - Incremental rehashing of the DBs hash tables.
814 * - Triggering BGSAVE / AOF rewrite, and handling of terminated children.
815 * - Clients timeout of differnet kinds.
816 * - Replication reconnection.
819 * Everything directly called here will be called REDIS_HZ times per second,
820 * so in order to throttle execution of things we want to do less frequently
821 * a macro is used: run_with_period(milliseconds) { .... }
824 int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
826 REDIS_NOTUSED(eventLoop
);
828 REDIS_NOTUSED(clientData
);
830 /* Software watchdog: deliver the SIGALRM that will reach the signal
831 * handler if we don't return here fast enough. */
832 if (server
.watchdog_period
) watchdogScheduleSignal(server
.watchdog_period
);
834 /* We take a cached value of the unix time in the global state because
835 * with virtual memory and aging there is to store the current time
836 * in objects at every object access, and accuracy is not needed.
837 * To access a global var is faster than calling time(NULL) */
838 server
.unixtime
= time(NULL
);
840 run_with_period(100) trackOperationsPerSecond();
842 /* We have just 22 bits per object for LRU information.
843 * So we use an (eventually wrapping) LRU clock with 10 seconds resolution.
844 * 2^22 bits with 10 seconds resoluton is more or less 1.5 years.
846 * Note that even if this will wrap after 1.5 years it's not a problem,
847 * everything will still work but just some object will appear younger
848 * to Redis. But for this to happen a given object should never be touched
851 * Note that you can change the resolution altering the
852 * REDIS_LRU_CLOCK_RESOLUTION define.
856 /* Record the max memory used since the server was started. */
857 if (zmalloc_used_memory() > server
.stat_peak_memory
)
858 server
.stat_peak_memory
= zmalloc_used_memory();
860 /* We received a SIGTERM, shutting down here in a safe way, as it is
861 * not ok doing so inside the signal handler. */
862 if (server
.shutdown_asap
) {
863 if (prepareForShutdown(0) == REDIS_OK
) exit(0);
864 redisLog(REDIS_WARNING
,"SIGTERM received but errors trying to shut down the server, check the logs for more information");
867 /* Show some info about non-empty databases */
868 run_with_period(5000) {
869 for (j
= 0; j
< server
.dbnum
; j
++) {
870 long long size
, used
, vkeys
;
872 size
= dictSlots(server
.db
[j
].dict
);
873 used
= dictSize(server
.db
[j
].dict
);
874 vkeys
= dictSize(server
.db
[j
].expires
);
876 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
877 /* dictPrintStats(server.dict); */
882 /* We don't want to resize the hash tables while a bacground saving
883 * is in progress: the saving child is created using fork() that is
884 * implemented with a copy-on-write semantic in most modern systems, so
885 * if we resize the HT while there is the saving child at work actually
886 * a lot of memory movements in the parent will cause a lot of pages
888 if (server
.rdb_child_pid
== -1 && server
.aof_child_pid
== -1) {
889 tryResizeHashTables();
890 if (server
.activerehashing
) incrementallyRehash();
893 /* Show information about connected clients */
894 if (!server
.sentinel_mode
) {
895 run_with_period(5000) {
896 redisLog(REDIS_VERBOSE
,
897 "%d clients connected (%d slaves), %zu bytes in use",
898 listLength(server
.clients
)-listLength(server
.slaves
),
899 listLength(server
.slaves
),
900 zmalloc_used_memory());
904 /* We need to do a few operations on clients asynchronously. */
907 /* Start a scheduled AOF rewrite if this was requested by the user while
908 * a BGSAVE was in progress. */
909 if (server
.rdb_child_pid
== -1 && server
.aof_child_pid
== -1 &&
910 server
.aof_rewrite_scheduled
)
912 rewriteAppendOnlyFileBackground();
915 /* Check if a background saving or AOF rewrite in progress terminated. */
916 if (server
.rdb_child_pid
!= -1 || server
.aof_child_pid
!= -1) {
920 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
921 int exitcode
= WEXITSTATUS(statloc
);
924 if (WIFSIGNALED(statloc
)) bysignal
= WTERMSIG(statloc
);
926 if (pid
== server
.rdb_child_pid
) {
927 backgroundSaveDoneHandler(exitcode
,bysignal
);
929 backgroundRewriteDoneHandler(exitcode
,bysignal
);
931 updateDictResizePolicy();
934 /* If there is not a background saving/rewrite in progress check if
935 * we have to save/rewrite now */
936 for (j
= 0; j
< server
.saveparamslen
; j
++) {
937 struct saveparam
*sp
= server
.saveparams
+j
;
939 if (server
.dirty
>= sp
->changes
&&
940 server
.unixtime
-server
.lastsave
> sp
->seconds
) {
941 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
942 sp
->changes
, sp
->seconds
);
943 rdbSaveBackground(server
.rdb_filename
);
948 /* Trigger an AOF rewrite if needed */
949 if (server
.rdb_child_pid
== -1 &&
950 server
.aof_child_pid
== -1 &&
951 server
.aof_rewrite_perc
&&
952 server
.aof_current_size
> server
.aof_rewrite_min_size
)
954 long long base
= server
.aof_rewrite_base_size
?
955 server
.aof_rewrite_base_size
: 1;
956 long long growth
= (server
.aof_current_size
*100/base
) - 100;
957 if (growth
>= server
.aof_rewrite_perc
) {
958 redisLog(REDIS_NOTICE
,"Starting automatic rewriting of AOF on %lld%% growth",growth
);
959 rewriteAppendOnlyFileBackground();
965 /* If we postponed an AOF buffer flush, let's try to do it every time the
966 * cron function is called. */
967 if (server
.aof_flush_postponed_start
) flushAppendOnlyFile(0);
969 /* Expire a few keys per cycle, only if this is a master.
970 * On slaves we wait for DEL operations synthesized by the master
971 * in order to guarantee a strict consistency. */
972 if (server
.masterhost
== NULL
) activeExpireCycle();
974 /* Close clients that need to be closed asynchronous */
975 freeClientsInAsyncFreeQueue();
977 /* Replication cron function -- used to reconnect to master and
978 * to detect transfer failures. */
979 run_with_period(1000) replicationCron();
981 /* Run other sub-systems specific cron jobs */
982 run_with_period(1000) {
983 if (server
.cluster_enabled
) clusterCron();
986 /* Run the sentinel timer if we are in sentinel mode. */
987 run_with_period(100) {
988 if (server
.sentinel_mode
) sentinelTimer();
992 return 1000/REDIS_HZ
;
995 /* This function gets called every time Redis is entering the
996 * main loop of the event driven library, that is, before to sleep
997 * for ready file descriptors. */
998 void beforeSleep(struct aeEventLoop
*eventLoop
) {
999 REDIS_NOTUSED(eventLoop
);
1003 /* Try to process pending commands for clients that were just unblocked. */
1004 while (listLength(server
.unblocked_clients
)) {
1005 ln
= listFirst(server
.unblocked_clients
);
1006 redisAssert(ln
!= NULL
);
1008 listDelNode(server
.unblocked_clients
,ln
);
1009 c
->flags
&= ~REDIS_UNBLOCKED
;
1011 /* Process remaining data in the input buffer. */
1012 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) {
1013 server
.current_client
= c
;
1014 processInputBuffer(c
);
1015 server
.current_client
= NULL
;
1019 /* Write the AOF buffer on disk */
1020 flushAppendOnlyFile(0);
1023 /* =========================== Server initialization ======================== */
1025 void createSharedObjects(void) {
1028 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1029 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1030 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1031 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1032 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1033 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1034 shared
.cnegone
= createObject(REDIS_STRING
,sdsnew(":-1\r\n"));
1035 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1036 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1037 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1038 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1039 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1040 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1041 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1042 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1043 "-ERR no such key\r\n"));
1044 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1045 "-ERR syntax error\r\n"));
1046 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1047 "-ERR source and destination objects are the same\r\n"));
1048 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1049 "-ERR index out of range\r\n"));
1050 shared
.noscripterr
= createObject(REDIS_STRING
,sdsnew(
1051 "-NOSCRIPT No matching script. Please use EVAL.\r\n"));
1052 shared
.loadingerr
= createObject(REDIS_STRING
,sdsnew(
1053 "-LOADING Redis is loading the dataset in memory\r\n"));
1054 shared
.slowscripterr
= createObject(REDIS_STRING
,sdsnew(
1055 "-BUSY Redis is busy running a script. You can only call SCRIPT KILL or SHUTDOWN NOSAVE.\r\n"));
1056 shared
.masterdownerr
= createObject(REDIS_STRING
,sdsnew(
1057 "-MASTERDOWN Link with MASTER is down and slave-serve-stale-data is set to 'no'.\r\n"));
1058 shared
.bgsaveerr
= createObject(REDIS_STRING
,sdsnew(
1059 "-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"));
1060 shared
.roslaveerr
= createObject(REDIS_STRING
,sdsnew(
1061 "-READONLY You can't write against a read only slave.\r\n"));
1062 shared
.oomerr
= createObject(REDIS_STRING
,sdsnew(
1063 "-OOM command not allowed when used memory > 'maxmemory'.\r\n"));
1064 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1065 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1066 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1068 for (j
= 0; j
< REDIS_SHARED_SELECT_CMDS
; j
++) {
1069 shared
.select
[j
] = createObject(REDIS_STRING
,
1070 sdscatprintf(sdsempty(),"select %d\r\n", j
));
1072 shared
.messagebulk
= createStringObject("$7\r\nmessage\r\n",13);
1073 shared
.pmessagebulk
= createStringObject("$8\r\npmessage\r\n",14);
1074 shared
.subscribebulk
= createStringObject("$9\r\nsubscribe\r\n",15);
1075 shared
.unsubscribebulk
= createStringObject("$11\r\nunsubscribe\r\n",18);
1076 shared
.psubscribebulk
= createStringObject("$10\r\npsubscribe\r\n",17);
1077 shared
.punsubscribebulk
= createStringObject("$12\r\npunsubscribe\r\n",19);
1078 shared
.del
= createStringObject("DEL",3);
1079 shared
.rpop
= createStringObject("RPOP",4);
1080 shared
.lpop
= createStringObject("LPOP",4);
1081 for (j
= 0; j
< REDIS_SHARED_INTEGERS
; j
++) {
1082 shared
.integers
[j
] = createObject(REDIS_STRING
,(void*)(long)j
);
1083 shared
.integers
[j
]->encoding
= REDIS_ENCODING_INT
;
1085 for (j
= 0; j
< REDIS_SHARED_BULKHDR_LEN
; j
++) {
1086 shared
.mbulkhdr
[j
] = createObject(REDIS_STRING
,
1087 sdscatprintf(sdsempty(),"*%d\r\n",j
));
1088 shared
.bulkhdr
[j
] = createObject(REDIS_STRING
,
1089 sdscatprintf(sdsempty(),"$%d\r\n",j
));
1093 void initServerConfig() {
1094 getRandomHexChars(server
.runid
,REDIS_RUN_ID_SIZE
);
1095 server
.runid
[REDIS_RUN_ID_SIZE
] = '\0';
1096 server
.arch_bits
= (sizeof(long) == 8) ? 64 : 32;
1097 server
.port
= REDIS_SERVERPORT
;
1098 server
.bindaddr
= NULL
;
1099 server
.unixsocket
= NULL
;
1100 server
.unixsocketperm
= 0;
1103 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1104 server
.verbosity
= REDIS_NOTICE
;
1105 server
.maxidletime
= REDIS_MAXIDLETIME
;
1106 server
.client_max_querybuf_len
= REDIS_MAX_QUERYBUF_LEN
;
1107 server
.saveparams
= NULL
;
1109 server
.logfile
= NULL
; /* NULL = log on standard output */
1110 server
.syslog_enabled
= 0;
1111 server
.syslog_ident
= zstrdup("redis");
1112 server
.syslog_facility
= LOG_LOCAL0
;
1113 server
.daemonize
= 0;
1114 server
.aof_state
= REDIS_AOF_OFF
;
1115 server
.aof_fsync
= AOF_FSYNC_EVERYSEC
;
1116 server
.aof_no_fsync_on_rewrite
= 0;
1117 server
.aof_rewrite_perc
= REDIS_AOF_REWRITE_PERC
;
1118 server
.aof_rewrite_min_size
= REDIS_AOF_REWRITE_MIN_SIZE
;
1119 server
.aof_rewrite_base_size
= 0;
1120 server
.aof_rewrite_scheduled
= 0;
1121 server
.aof_last_fsync
= time(NULL
);
1122 server
.aof_rewrite_time_last
= -1;
1123 server
.aof_rewrite_time_start
= -1;
1124 server
.aof_lastbgrewrite_status
= REDIS_OK
;
1125 server
.aof_delayed_fsync
= 0;
1127 server
.aof_selected_db
= -1; /* Make sure the first time will not match */
1128 server
.aof_flush_postponed_start
= 0;
1129 server
.pidfile
= zstrdup("/var/run/redis.pid");
1130 server
.rdb_filename
= zstrdup("dump.rdb");
1131 server
.aof_filename
= zstrdup("appendonly.aof");
1132 server
.requirepass
= NULL
;
1133 server
.rdb_compression
= 1;
1134 server
.rdb_checksum
= 1;
1135 server
.activerehashing
= 1;
1136 server
.maxclients
= REDIS_MAX_CLIENTS
;
1137 server
.bpop_blocked_clients
= 0;
1138 server
.maxmemory
= 0;
1139 server
.maxmemory_policy
= REDIS_MAXMEMORY_VOLATILE_LRU
;
1140 server
.maxmemory_samples
= 3;
1141 server
.hash_max_ziplist_entries
= REDIS_HASH_MAX_ZIPLIST_ENTRIES
;
1142 server
.hash_max_ziplist_value
= REDIS_HASH_MAX_ZIPLIST_VALUE
;
1143 server
.list_max_ziplist_entries
= REDIS_LIST_MAX_ZIPLIST_ENTRIES
;
1144 server
.list_max_ziplist_value
= REDIS_LIST_MAX_ZIPLIST_VALUE
;
1145 server
.set_max_intset_entries
= REDIS_SET_MAX_INTSET_ENTRIES
;
1146 server
.zset_max_ziplist_entries
= REDIS_ZSET_MAX_ZIPLIST_ENTRIES
;
1147 server
.zset_max_ziplist_value
= REDIS_ZSET_MAX_ZIPLIST_VALUE
;
1148 server
.shutdown_asap
= 0;
1149 server
.repl_ping_slave_period
= REDIS_REPL_PING_SLAVE_PERIOD
;
1150 server
.repl_timeout
= REDIS_REPL_TIMEOUT
;
1151 server
.cluster_enabled
= 0;
1152 server
.cluster
.configfile
= zstrdup("nodes.conf");
1153 server
.lua_caller
= NULL
;
1154 server
.lua_time_limit
= REDIS_LUA_TIME_LIMIT
;
1155 server
.lua_client
= NULL
;
1156 server
.lua_timedout
= 0;
1159 resetServerSaveParams();
1161 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1162 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1163 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1164 /* Replication related */
1165 server
.masterauth
= NULL
;
1166 server
.masterhost
= NULL
;
1167 server
.masterport
= 6379;
1168 server
.master
= NULL
;
1169 server
.repl_state
= REDIS_REPL_NONE
;
1170 server
.repl_syncio_timeout
= REDIS_REPL_SYNCIO_TIMEOUT
;
1171 server
.repl_serve_stale_data
= 1;
1172 server
.repl_slave_ro
= 1;
1173 server
.repl_down_since
= time(NULL
);
1175 /* Client output buffer limits */
1176 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_NORMAL
].hard_limit_bytes
= 0;
1177 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_NORMAL
].soft_limit_bytes
= 0;
1178 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_NORMAL
].soft_limit_seconds
= 0;
1179 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_SLAVE
].hard_limit_bytes
= 1024*1024*256;
1180 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_SLAVE
].soft_limit_bytes
= 1024*1024*64;
1181 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_SLAVE
].soft_limit_seconds
= 60;
1182 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_PUBSUB
].hard_limit_bytes
= 1024*1024*32;
1183 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_PUBSUB
].soft_limit_bytes
= 1024*1024*8;
1184 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_PUBSUB
].soft_limit_seconds
= 60;
1186 /* Double constants initialization */
1188 R_PosInf
= 1.0/R_Zero
;
1189 R_NegInf
= -1.0/R_Zero
;
1190 R_Nan
= R_Zero
/R_Zero
;
1192 /* Command table -- we intiialize it here as it is part of the
1193 * initial configuration, since command names may be changed via
1194 * redis.conf using the rename-command directive. */
1195 server
.commands
= dictCreate(&commandTableDictType
,NULL
);
1196 populateCommandTable();
1197 server
.delCommand
= lookupCommandByCString("del");
1198 server
.multiCommand
= lookupCommandByCString("multi");
1199 server
.lpushCommand
= lookupCommandByCString("lpush");
1202 server
.slowlog_log_slower_than
= REDIS_SLOWLOG_LOG_SLOWER_THAN
;
1203 server
.slowlog_max_len
= REDIS_SLOWLOG_MAX_LEN
;
1206 server
.assert_failed
= "<no assertion failed>";
1207 server
.assert_file
= "<no file>";
1208 server
.assert_line
= 0;
1209 server
.bug_report_start
= 0;
1210 server
.watchdog_period
= 0;
1213 /* This function will try to raise the max number of open files accordingly to
1214 * the configured max number of clients. It will also account for 32 additional
1215 * file descriptors as we need a few more for persistence, listening
1216 * sockets, log files and so forth.
1218 * If it will not be possible to set the limit accordingly to the configured
1219 * max number of clients, the function will do the reverse setting
1220 * server.maxclients to the value that we can actually handle. */
1221 void adjustOpenFilesLimit(void) {
1222 rlim_t maxfiles
= server
.maxclients
+32;
1223 struct rlimit limit
;
1225 if (getrlimit(RLIMIT_NOFILE
,&limit
) == -1) {
1226 redisLog(REDIS_WARNING
,"Unable to obtain the current NOFILE limit (%s), assuming 1024 and setting the max clients configuration accordingly.",
1228 server
.maxclients
= 1024-32;
1230 rlim_t oldlimit
= limit
.rlim_cur
;
1232 /* Set the max number of files if the current limit is not enough
1234 if (oldlimit
< maxfiles
) {
1238 while(f
> oldlimit
) {
1241 if (setrlimit(RLIMIT_NOFILE
,&limit
) != -1) break;
1244 if (f
< oldlimit
) f
= oldlimit
;
1245 if (f
!= maxfiles
) {
1246 server
.maxclients
= f
-32;
1247 redisLog(REDIS_WARNING
,"Unable to set the max number of files limit to %d (%s), setting the max clients configuration to %d.",
1248 (int) maxfiles
, strerror(errno
), (int) server
.maxclients
);
1250 redisLog(REDIS_NOTICE
,"Max number of open files set to %d",
1260 signal(SIGHUP
, SIG_IGN
);
1261 signal(SIGPIPE
, SIG_IGN
);
1262 setupSignalHandlers();
1264 if (server
.syslog_enabled
) {
1265 openlog(server
.syslog_ident
, LOG_PID
| LOG_NDELAY
| LOG_NOWAIT
,
1266 server
.syslog_facility
);
1269 server
.current_client
= NULL
;
1270 server
.clients
= listCreate();
1271 server
.clients_to_close
= listCreate();
1272 server
.slaves
= listCreate();
1273 server
.monitors
= listCreate();
1274 server
.unblocked_clients
= listCreate();
1276 createSharedObjects();
1277 adjustOpenFilesLimit();
1278 server
.el
= aeCreateEventLoop(server
.maxclients
+1024);
1279 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1281 if (server
.port
!= 0) {
1282 server
.ipfd
= anetTcpServer(server
.neterr
,server
.port
,server
.bindaddr
);
1283 if (server
.ipfd
== ANET_ERR
) {
1284 redisLog(REDIS_WARNING
, "Opening port %d: %s",
1285 server
.port
, server
.neterr
);
1289 if (server
.unixsocket
!= NULL
) {
1290 unlink(server
.unixsocket
); /* don't care if this fails */
1291 server
.sofd
= anetUnixServer(server
.neterr
,server
.unixsocket
,server
.unixsocketperm
);
1292 if (server
.sofd
== ANET_ERR
) {
1293 redisLog(REDIS_WARNING
, "Opening socket: %s", server
.neterr
);
1297 if (server
.ipfd
< 0 && server
.sofd
< 0) {
1298 redisLog(REDIS_WARNING
, "Configured to not listen anywhere, exiting.");
1301 for (j
= 0; j
< server
.dbnum
; j
++) {
1302 server
.db
[j
].dict
= dictCreate(&dbDictType
,NULL
);
1303 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1304 server
.db
[j
].blocking_keys
= dictCreate(&keylistDictType
,NULL
);
1305 server
.db
[j
].watched_keys
= dictCreate(&keylistDictType
,NULL
);
1306 server
.db
[j
].id
= j
;
1308 server
.pubsub_channels
= dictCreate(&keylistDictType
,NULL
);
1309 server
.pubsub_patterns
= listCreate();
1310 listSetFreeMethod(server
.pubsub_patterns
,freePubsubPattern
);
1311 listSetMatchMethod(server
.pubsub_patterns
,listMatchPubsubPattern
);
1312 server
.cronloops
= 0;
1313 server
.rdb_child_pid
= -1;
1314 server
.aof_child_pid
= -1;
1315 aofRewriteBufferReset();
1316 server
.aof_buf
= sdsempty();
1317 server
.lastsave
= time(NULL
);
1318 server
.rdb_save_time_last
= -1;
1319 server
.rdb_save_time_start
= -1;
1321 server
.stat_numcommands
= 0;
1322 server
.stat_numconnections
= 0;
1323 server
.stat_expiredkeys
= 0;
1324 server
.stat_evictedkeys
= 0;
1325 server
.stat_starttime
= time(NULL
);
1326 server
.stat_keyspace_misses
= 0;
1327 server
.stat_keyspace_hits
= 0;
1328 server
.stat_peak_memory
= 0;
1329 server
.stat_fork_time
= 0;
1330 server
.stat_rejected_conn
= 0;
1331 memset(server
.ops_sec_samples
,0,sizeof(server
.ops_sec_samples
));
1332 server
.ops_sec_idx
= 0;
1333 server
.ops_sec_last_sample_time
= mstime();
1334 server
.ops_sec_last_sample_ops
= 0;
1335 server
.unixtime
= time(NULL
);
1336 server
.lastbgsave_status
= REDIS_OK
;
1337 server
.stop_writes_on_bgsave_err
= 1;
1338 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1339 if (server
.ipfd
> 0 && aeCreateFileEvent(server
.el
,server
.ipfd
,AE_READABLE
,
1340 acceptTcpHandler
,NULL
) == AE_ERR
) oom("creating file event");
1341 if (server
.sofd
> 0 && aeCreateFileEvent(server
.el
,server
.sofd
,AE_READABLE
,
1342 acceptUnixHandler
,NULL
) == AE_ERR
) oom("creating file event");
1344 if (server
.aof_state
== REDIS_AOF_ON
) {
1345 server
.aof_fd
= open(server
.aof_filename
,
1346 O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1347 if (server
.aof_fd
== -1) {
1348 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1354 /* 32 bit instances are limited to 4GB of address space, so if there is
1355 * no explicit limit in the user provided configuration we set a limit
1356 * at 3.5GB using maxmemory with 'noeviction' policy'. This saves
1357 * useless crashes of the Redis instance. */
1358 if (server
.arch_bits
== 32 && server
.maxmemory
== 0) {
1359 redisLog(REDIS_WARNING
,"Warning: 32 bit instance detected but no memory limit set. Setting 3.5 GB maxmemory limit with 'noeviction' policy now.");
1360 server
.maxmemory
= 3584LL*(1024*1024); /* 3584 MB = 3.5 GB */
1361 server
.maxmemory_policy
= REDIS_MAXMEMORY_NO_EVICTION
;
1364 if (server
.cluster_enabled
) clusterInit();
1370 /* Populates the Redis Command Table starting from the hard coded list
1371 * we have on top of redis.c file. */
1372 void populateCommandTable(void) {
1374 int numcommands
= sizeof(redisCommandTable
)/sizeof(struct redisCommand
);
1376 for (j
= 0; j
< numcommands
; j
++) {
1377 struct redisCommand
*c
= redisCommandTable
+j
;
1378 char *f
= c
->sflags
;
1383 case 'w': c
->flags
|= REDIS_CMD_WRITE
; break;
1384 case 'r': c
->flags
|= REDIS_CMD_READONLY
; break;
1385 case 'm': c
->flags
|= REDIS_CMD_DENYOOM
; break;
1386 case 'a': c
->flags
|= REDIS_CMD_ADMIN
; break;
1387 case 'p': c
->flags
|= REDIS_CMD_PUBSUB
; break;
1388 case 'f': c
->flags
|= REDIS_CMD_FORCE_REPLICATION
; break;
1389 case 's': c
->flags
|= REDIS_CMD_NOSCRIPT
; break;
1390 case 'R': c
->flags
|= REDIS_CMD_RANDOM
; break;
1391 case 'S': c
->flags
|= REDIS_CMD_SORT_FOR_SCRIPT
; break;
1392 case 'l': c
->flags
|= REDIS_CMD_LOADING
; break;
1393 case 't': c
->flags
|= REDIS_CMD_STALE
; break;
1394 default: redisPanic("Unsupported command flag"); break;
1399 retval
= dictAdd(server
.commands
, sdsnew(c
->name
), c
);
1400 assert(retval
== DICT_OK
);
1404 void resetCommandTableStats(void) {
1405 int numcommands
= sizeof(redisCommandTable
)/sizeof(struct redisCommand
);
1408 for (j
= 0; j
< numcommands
; j
++) {
1409 struct redisCommand
*c
= redisCommandTable
+j
;
1411 c
->microseconds
= 0;
1416 /* ========================== Redis OP Array API ============================ */
1418 void redisOpArrayInit(redisOpArray
*oa
) {
1423 int redisOpArrayAppend(redisOpArray
*oa
, struct redisCommand
*cmd
, int dbid
,
1424 robj
**argv
, int argc
, int target
)
1428 oa
->ops
= zrealloc(oa
->ops
,sizeof(redisOp
)*(oa
->numops
+1));
1429 op
= oa
->ops
+oa
->numops
;
1434 op
->target
= target
;
1439 void redisOpArrayFree(redisOpArray
*oa
) {
1445 op
= oa
->ops
+oa
->numops
;
1446 for (j
= 0; j
< op
->argc
; j
++)
1447 decrRefCount(op
->argv
[j
]);
1453 /* ====================== Commands lookup and execution ===================== */
1455 struct redisCommand
*lookupCommand(sds name
) {
1456 return dictFetchValue(server
.commands
, name
);
1459 struct redisCommand
*lookupCommandByCString(char *s
) {
1460 struct redisCommand
*cmd
;
1461 sds name
= sdsnew(s
);
1463 cmd
= dictFetchValue(server
.commands
, name
);
1468 /* Propagate the specified command (in the context of the specified database id)
1469 * to AOF, Slaves and Monitors.
1471 * flags are an xor between:
1472 * + REDIS_PROPAGATE_NONE (no propagation of command at all)
1473 * + REDIS_PROPAGATE_AOF (propagate into the AOF file if is enabled)
1474 * + REDIS_PROPAGATE_REPL (propagate into the replication link)
1476 void propagate(struct redisCommand
*cmd
, int dbid
, robj
**argv
, int argc
,
1479 if (server
.aof_state
!= REDIS_AOF_OFF
&& flags
& REDIS_PROPAGATE_AOF
)
1480 feedAppendOnlyFile(cmd
,dbid
,argv
,argc
);
1481 if (flags
& REDIS_PROPAGATE_REPL
&& listLength(server
.slaves
))
1482 replicationFeedSlaves(server
.slaves
,dbid
,argv
,argc
);
1485 /* Used inside commands to schedule the propagation of additional commands
1486 * after the current command is propagated to AOF / Replication. */
1487 void alsoPropagate(struct redisCommand
*cmd
, int dbid
, robj
**argv
, int argc
,
1490 redisOpArrayAppend(&server
.also_propagate
,cmd
,dbid
,argv
,argc
,target
);
1493 /* Call() is the core of Redis execution of a command */
1494 void call(redisClient
*c
, int flags
) {
1495 long long dirty
, start
= ustime(), duration
;
1497 /* Sent the command to clients in MONITOR mode, only if the commands are
1498 * not geneated from reading an AOF. */
1499 if (listLength(server
.monitors
) && !server
.loading
)
1500 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, argments 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
);
1572 addReplyErrorFormat(c
,"unknown command '%s'",
1573 (char*)c
->argv
[0]->ptr
);
1575 } else if ((c
->cmd
->arity
> 0 && c
->cmd
->arity
!= c
->argc
) ||
1576 (c
->argc
< -c
->cmd
->arity
)) {
1577 addReplyErrorFormat(c
,"wrong number of arguments for '%s' command",
1582 /* Check if the user is authenticated */
1583 if (server
.requirepass
&& !c
->authenticated
&& c
->cmd
->proc
!= authCommand
)
1585 addReplyError(c
,"operation not permitted");
1589 /* If cluster is enabled, redirect here */
1590 if (server
.cluster_enabled
&&
1591 !(c
->cmd
->getkeys_proc
== NULL
&& c
->cmd
->firstkey
== 0)) {
1594 if (server
.cluster
.state
!= REDIS_CLUSTER_OK
) {
1595 addReplyError(c
,"The cluster is down. Check with CLUSTER INFO for more information");
1599 clusterNode
*n
= getNodeByQuery(c
,c
->cmd
,c
->argv
,c
->argc
,&hashslot
,&ask
);
1601 addReplyError(c
,"Multi keys request invalid in cluster");
1603 } else if (n
!= server
.cluster
.myself
) {
1604 addReplySds(c
,sdscatprintf(sdsempty(),
1605 "-%s %d %s:%d\r\n", ask
? "ASK" : "MOVED",
1606 hashslot
,n
->ip
,n
->port
));
1612 /* Handle the maxmemory directive.
1614 * First we try to free some memory if possible (if there are volatile
1615 * keys in the dataset). If there are not the only thing we can do
1616 * is returning an error. */
1617 if (server
.maxmemory
) {
1618 int retval
= freeMemoryIfNeeded();
1619 if ((c
->cmd
->flags
& REDIS_CMD_DENYOOM
) && retval
== REDIS_ERR
) {
1620 addReply(c
, shared
.oomerr
);
1625 /* Don't accept write commands if there are problems persisting on disk. */
1626 if (server
.stop_writes_on_bgsave_err
&&
1627 server
.saveparamslen
> 0
1628 && server
.lastbgsave_status
== REDIS_ERR
&&
1629 c
->cmd
->flags
& REDIS_CMD_WRITE
)
1631 addReply(c
, shared
.bgsaveerr
);
1635 /* Don't accept write commands if this is a read only slave. But
1636 * accept write commands if this is our master. */
1637 if (server
.masterhost
&& server
.repl_slave_ro
&&
1638 !(c
->flags
& REDIS_MASTER
) &&
1639 c
->cmd
->flags
& REDIS_CMD_WRITE
)
1641 addReply(c
, shared
.roslaveerr
);
1645 /* Only allow SUBSCRIBE and UNSUBSCRIBE in the context of Pub/Sub */
1646 if ((dictSize(c
->pubsub_channels
) > 0 || listLength(c
->pubsub_patterns
) > 0)
1648 c
->cmd
->proc
!= subscribeCommand
&&
1649 c
->cmd
->proc
!= unsubscribeCommand
&&
1650 c
->cmd
->proc
!= psubscribeCommand
&&
1651 c
->cmd
->proc
!= punsubscribeCommand
) {
1652 addReplyError(c
,"only (P)SUBSCRIBE / (P)UNSUBSCRIBE / QUIT allowed in this context");
1656 /* Only allow INFO and SLAVEOF when slave-serve-stale-data is no and
1657 * we are a slave with a broken link with master. */
1658 if (server
.masterhost
&& server
.repl_state
!= REDIS_REPL_CONNECTED
&&
1659 server
.repl_serve_stale_data
== 0 &&
1660 !(c
->cmd
->flags
& REDIS_CMD_STALE
))
1662 addReply(c
, shared
.masterdownerr
);
1666 /* Loading DB? Return an error if the command has not the
1667 * REDIS_CMD_LOADING flag. */
1668 if (server
.loading
&& !(c
->cmd
->flags
& REDIS_CMD_LOADING
)) {
1669 addReply(c
, shared
.loadingerr
);
1673 /* Lua script too slow? Only allow commands with REDIS_CMD_STALE flag. */
1674 if (server
.lua_timedout
&&
1675 !(c
->cmd
->proc
== shutdownCommand
&&
1677 tolower(((char*)c
->argv
[1]->ptr
)[0]) == 'n') &&
1678 !(c
->cmd
->proc
== scriptCommand
&&
1680 tolower(((char*)c
->argv
[1]->ptr
)[0]) == 'k'))
1682 addReply(c
, shared
.slowscripterr
);
1686 /* Exec the command */
1687 if (c
->flags
& REDIS_MULTI
&&
1688 c
->cmd
->proc
!= execCommand
&& c
->cmd
->proc
!= discardCommand
&&
1689 c
->cmd
->proc
!= multiCommand
&& c
->cmd
->proc
!= watchCommand
)
1691 queueMultiCommand(c
);
1692 addReply(c
,shared
.queued
);
1694 call(c
,REDIS_CALL_FULL
);
1699 /*================================== Shutdown =============================== */
1701 int prepareForShutdown(int flags
) {
1702 int save
= flags
& REDIS_SHUTDOWN_SAVE
;
1703 int nosave
= flags
& REDIS_SHUTDOWN_NOSAVE
;
1705 redisLog(REDIS_WARNING
,"User requested shutdown...");
1706 /* Kill the saving child if there is a background saving in progress.
1707 We want to avoid race conditions, for instance our saving child may
1708 overwrite the synchronous saving did by SHUTDOWN. */
1709 if (server
.rdb_child_pid
!= -1) {
1710 redisLog(REDIS_WARNING
,"There is a child saving an .rdb. Killing it!");
1711 kill(server
.rdb_child_pid
,SIGKILL
);
1712 rdbRemoveTempFile(server
.rdb_child_pid
);
1714 if (server
.aof_state
!= REDIS_AOF_OFF
) {
1715 /* Kill the AOF saving child as the AOF we already have may be longer
1716 * but contains the full dataset anyway. */
1717 if (server
.aof_child_pid
!= -1) {
1718 redisLog(REDIS_WARNING
,
1719 "There is a child rewriting the AOF. Killing it!");
1720 kill(server
.aof_child_pid
,SIGKILL
);
1722 /* Append only file: fsync() the AOF and exit */
1723 redisLog(REDIS_NOTICE
,"Calling fsync() on the AOF file.");
1724 aof_fsync(server
.aof_fd
);
1726 if ((server
.saveparamslen
> 0 && !nosave
) || save
) {
1727 redisLog(REDIS_NOTICE
,"Saving the final RDB snapshot before exiting.");
1728 /* Snapshotting. Perform a SYNC SAVE and exit */
1729 if (rdbSave(server
.rdb_filename
) != REDIS_OK
) {
1730 /* Ooops.. error saving! The best we can do is to continue
1731 * operating. Note that if there was a background saving process,
1732 * in the next cron() Redis will be notified that the background
1733 * saving aborted, handling special stuff like slaves pending for
1734 * synchronization... */
1735 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit.");
1739 if (server
.daemonize
) {
1740 redisLog(REDIS_NOTICE
,"Removing the pid file.");
1741 unlink(server
.pidfile
);
1743 /* Close the listening sockets. Apparently this allows faster restarts. */
1744 if (server
.ipfd
!= -1) close(server
.ipfd
);
1745 if (server
.sofd
!= -1) close(server
.sofd
);
1746 if (server
.unixsocket
) {
1747 redisLog(REDIS_NOTICE
,"Removing the unix socket file.");
1748 unlink(server
.unixsocket
); /* don't care if this fails */
1751 redisLog(REDIS_WARNING
,"Redis is now ready to exit, bye bye...");
1755 /*================================== Commands =============================== */
1757 /* Return zero if strings are the same, non-zero if they are not.
1758 * The comparison is performed in a way that prevents an attacker to obtain
1759 * information about the nature of the strings just monitoring the execution
1760 * time of the function.
1762 * Note that limiting the comparison length to strings up to 512 bytes we
1763 * can avoid leaking any information about the password length and any
1764 * possible branch misprediction related leak.
1766 int time_independent_strcmp(char *a
, char *b
) {
1767 char bufa
[REDIS_AUTHPASS_MAX_LEN
], bufb
[REDIS_AUTHPASS_MAX_LEN
];
1768 /* The above two strlen perform len(a) + len(b) operations where either
1769 * a or b are fixed (our password) length, and the difference is only
1770 * relative to the length of the user provided string, so no information
1771 * leak is possible in the following two lines of code. */
1772 int alen
= strlen(a
);
1773 int blen
= strlen(b
);
1777 /* We can't compare strings longer than our static buffers.
1778 * Note that this will never pass the first test in practical circumstances
1779 * so there is no info leak. */
1780 if (alen
> sizeof(bufa
) || blen
> sizeof(bufb
)) return 1;
1782 memset(bufa
,0,sizeof(bufa
)); /* Constant time. */
1783 memset(bufb
,0,sizeof(bufb
)); /* Constant time. */
1784 /* Again the time of the following two copies is proportional to
1785 * len(a) + len(b) so no info is leaked. */
1786 memcpy(bufa
,a
,alen
);
1787 memcpy(bufb
,b
,blen
);
1789 /* Always compare all the chars in the two buffers without
1790 * conditional expressions. */
1791 for (j
= 0; j
< sizeof(bufa
); j
++) {
1792 diff
|= (bufa
[j
] ^ bufb
[j
]);
1794 /* Length must be equal as well. */
1795 diff
|= alen
^ blen
;
1796 return diff
; /* If zero strings are the same. */
1799 void authCommand(redisClient
*c
) {
1800 if (!server
.requirepass
) {
1801 addReplyError(c
,"Client sent AUTH, but no password is set");
1802 } else if (!time_independent_strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
1803 c
->authenticated
= 1;
1804 addReply(c
,shared
.ok
);
1806 c
->authenticated
= 0;
1807 addReplyError(c
,"invalid password");
1811 void pingCommand(redisClient
*c
) {
1812 addReply(c
,shared
.pong
);
1815 void echoCommand(redisClient
*c
) {
1816 addReplyBulk(c
,c
->argv
[1]);
1819 void timeCommand(redisClient
*c
) {
1822 /* gettimeofday() can only fail if &tv is a bad addresss so we
1823 * don't check for errors. */
1824 gettimeofday(&tv
,NULL
);
1825 addReplyMultiBulkLen(c
,2);
1826 addReplyBulkLongLong(c
,tv
.tv_sec
);
1827 addReplyBulkLongLong(c
,tv
.tv_usec
);
1830 /* Convert an amount of bytes into a human readable string in the form
1831 * of 100B, 2G, 100M, 4K, and so forth. */
1832 void bytesToHuman(char *s
, unsigned long long n
) {
1837 sprintf(s
,"%lluB",n
);
1839 } else if (n
< (1024*1024)) {
1840 d
= (double)n
/(1024);
1841 sprintf(s
,"%.2fK",d
);
1842 } else if (n
< (1024LL*1024*1024)) {
1843 d
= (double)n
/(1024*1024);
1844 sprintf(s
,"%.2fM",d
);
1845 } else if (n
< (1024LL*1024*1024*1024)) {
1846 d
= (double)n
/(1024LL*1024*1024);
1847 sprintf(s
,"%.2fG",d
);
1851 /* Create the string returned by the INFO command. This is decoupled
1852 * by the INFO command itself as we need to report the same information
1853 * on memory corruption problems. */
1854 sds
genRedisInfoString(char *section
) {
1855 sds info
= sdsempty();
1856 time_t uptime
= server
.unixtime
-server
.stat_starttime
;
1858 struct rusage self_ru
, c_ru
;
1859 unsigned long lol
, bib
;
1860 int allsections
= 0, defsections
= 0;
1864 allsections
= strcasecmp(section
,"all") == 0;
1865 defsections
= strcasecmp(section
,"default") == 0;
1868 getrusage(RUSAGE_SELF
, &self_ru
);
1869 getrusage(RUSAGE_CHILDREN
, &c_ru
);
1870 getClientsMaxBuffers(&lol
,&bib
);
1873 if (allsections
|| defsections
|| !strcasecmp(section
,"server")) {
1874 struct utsname name
;
1876 if (sections
++) info
= sdscat(info
,"\r\n");
1878 info
= sdscatprintf(info
,
1880 "redis_version:%s\r\n"
1881 "redis_git_sha1:%s\r\n"
1882 "redis_git_dirty:%d\r\n"
1885 "multiplexing_api:%s\r\n"
1886 "gcc_version:%d.%d.%d\r\n"
1887 "process_id:%ld\r\n"
1890 "uptime_in_seconds:%ld\r\n"
1891 "uptime_in_days:%ld\r\n"
1892 "lru_clock:%ld\r\n",
1895 strtol(redisGitDirty(),NULL
,10) > 0,
1896 name
.sysname
, name
.release
, name
.machine
,
1900 __GNUC__
,__GNUC_MINOR__
,__GNUC_PATCHLEVEL__
,
1909 (unsigned long) server
.lruclock
);
1913 if (allsections
|| defsections
|| !strcasecmp(section
,"clients")) {
1914 if (sections
++) info
= sdscat(info
,"\r\n");
1915 info
= sdscatprintf(info
,
1917 "connected_clients:%lu\r\n"
1918 "client_longest_output_list:%lu\r\n"
1919 "client_biggest_input_buf:%lu\r\n"
1920 "blocked_clients:%d\r\n",
1921 listLength(server
.clients
)-listLength(server
.slaves
),
1923 server
.bpop_blocked_clients
);
1927 if (allsections
|| defsections
|| !strcasecmp(section
,"memory")) {
1931 bytesToHuman(hmem
,zmalloc_used_memory());
1932 bytesToHuman(peak_hmem
,server
.stat_peak_memory
);
1933 if (sections
++) info
= sdscat(info
,"\r\n");
1934 info
= sdscatprintf(info
,
1936 "used_memory:%zu\r\n"
1937 "used_memory_human:%s\r\n"
1938 "used_memory_rss:%zu\r\n"
1939 "used_memory_peak:%zu\r\n"
1940 "used_memory_peak_human:%s\r\n"
1941 "used_memory_lua:%lld\r\n"
1942 "mem_fragmentation_ratio:%.2f\r\n"
1943 "mem_allocator:%s\r\n",
1944 zmalloc_used_memory(),
1947 server
.stat_peak_memory
,
1949 ((long long)lua_gc(server
.lua
,LUA_GCCOUNT
,0))*1024LL,
1950 zmalloc_get_fragmentation_ratio(),
1956 if (allsections
|| defsections
|| !strcasecmp(section
,"persistence")) {
1957 if (sections
++) info
= sdscat(info
,"\r\n");
1958 info
= sdscatprintf(info
,
1961 "rdb_changes_since_last_save:%lld\r\n"
1962 "rdb_bgsave_in_progress:%d\r\n"
1963 "rdb_last_save_time:%ld\r\n"
1964 "rdb_last_bgsave_status:%s\r\n"
1965 "rdb_last_bgsave_time_sec:%ld\r\n"
1966 "rdb_current_bgsave_time_sec:%ld\r\n"
1967 "aof_enabled:%d\r\n"
1968 "aof_rewrite_in_progress:%d\r\n"
1969 "aof_rewrite_scheduled:%d\r\n"
1970 "aof_last_rewrite_time_sec:%ld\r\n"
1971 "aof_current_rewrite_time_sec:%ld\r\n"
1972 "aof_last_bgrewrite_status:%s\r\n",
1975 server
.rdb_child_pid
!= -1,
1977 (server
.lastbgsave_status
== REDIS_OK
) ? "ok" : "err",
1978 server
.rdb_save_time_last
,
1979 (server
.rdb_child_pid
== -1) ?
1980 -1 : time(NULL
)-server
.rdb_save_time_start
,
1981 server
.aof_state
!= REDIS_AOF_OFF
,
1982 server
.aof_child_pid
!= -1,
1983 server
.aof_rewrite_scheduled
,
1984 server
.aof_rewrite_time_last
,
1985 (server
.aof_child_pid
== -1) ?
1986 -1 : time(NULL
)-server
.aof_rewrite_time_start
,
1987 (server
.aof_lastbgrewrite_status
== REDIS_OK
) ? "ok" : "err");
1989 if (server
.aof_state
!= REDIS_AOF_OFF
) {
1990 info
= sdscatprintf(info
,
1991 "aof_current_size:%lld\r\n"
1992 "aof_base_size:%lld\r\n"
1993 "aof_pending_rewrite:%d\r\n"
1994 "aof_buffer_length:%zu\r\n"
1995 "aof_rewrite_buffer_length:%zu\r\n"
1996 "aof_pending_bio_fsync:%llu\r\n"
1997 "aof_delayed_fsync:%lu\r\n",
1998 (long long) server
.aof_current_size
,
1999 (long long) server
.aof_rewrite_base_size
,
2000 server
.aof_rewrite_scheduled
,
2001 sdslen(server
.aof_buf
),
2002 aofRewriteBufferSize(),
2003 bioPendingJobsOfType(REDIS_BIO_AOF_FSYNC
),
2004 server
.aof_delayed_fsync
);
2007 if (server
.loading
) {
2009 time_t eta
, elapsed
;
2010 off_t remaining_bytes
= server
.loading_total_bytes
-
2011 server
.loading_loaded_bytes
;
2013 perc
= ((double)server
.loading_loaded_bytes
/
2014 server
.loading_total_bytes
) * 100;
2016 elapsed
= server
.unixtime
-server
.loading_start_time
;
2018 eta
= 1; /* A fake 1 second figure if we don't have
2021 eta
= (elapsed
*remaining_bytes
)/server
.loading_loaded_bytes
;
2024 info
= sdscatprintf(info
,
2025 "loading_start_time:%ld\r\n"
2026 "loading_total_bytes:%llu\r\n"
2027 "loading_loaded_bytes:%llu\r\n"
2028 "loading_loaded_perc:%.2f\r\n"
2029 "loading_eta_seconds:%ld\r\n"
2030 ,(unsigned long) server
.loading_start_time
,
2031 (unsigned long long) server
.loading_total_bytes
,
2032 (unsigned long long) server
.loading_loaded_bytes
,
2040 if (allsections
|| defsections
|| !strcasecmp(section
,"stats")) {
2041 if (sections
++) info
= sdscat(info
,"\r\n");
2042 info
= sdscatprintf(info
,
2044 "total_connections_received:%lld\r\n"
2045 "total_commands_processed:%lld\r\n"
2046 "instantaneous_ops_per_sec:%lld\r\n"
2047 "rejected_connections:%lld\r\n"
2048 "expired_keys:%lld\r\n"
2049 "evicted_keys:%lld\r\n"
2050 "keyspace_hits:%lld\r\n"
2051 "keyspace_misses:%lld\r\n"
2052 "pubsub_channels:%ld\r\n"
2053 "pubsub_patterns:%lu\r\n"
2054 "latest_fork_usec:%lld\r\n",
2055 server
.stat_numconnections
,
2056 server
.stat_numcommands
,
2057 getOperationsPerSecond(),
2058 server
.stat_rejected_conn
,
2059 server
.stat_expiredkeys
,
2060 server
.stat_evictedkeys
,
2061 server
.stat_keyspace_hits
,
2062 server
.stat_keyspace_misses
,
2063 dictSize(server
.pubsub_channels
),
2064 listLength(server
.pubsub_patterns
),
2065 server
.stat_fork_time
);
2069 if (allsections
|| defsections
|| !strcasecmp(section
,"replication")) {
2070 if (sections
++) info
= sdscat(info
,"\r\n");
2071 info
= sdscatprintf(info
,
2074 server
.masterhost
== NULL
? "master" : "slave");
2075 if (server
.masterhost
) {
2076 info
= sdscatprintf(info
,
2077 "master_host:%s\r\n"
2078 "master_port:%d\r\n"
2079 "master_link_status:%s\r\n"
2080 "master_last_io_seconds_ago:%d\r\n"
2081 "master_sync_in_progress:%d\r\n"
2084 (server
.repl_state
== REDIS_REPL_CONNECTED
) ?
2087 ((int)(server
.unixtime
-server
.master
->lastinteraction
)) : -1,
2088 server
.repl_state
== REDIS_REPL_TRANSFER
2091 if (server
.repl_state
== REDIS_REPL_TRANSFER
) {
2092 info
= sdscatprintf(info
,
2093 "master_sync_left_bytes:%ld\r\n"
2094 "master_sync_last_io_seconds_ago:%d\r\n"
2095 ,(long)server
.repl_transfer_left
,
2096 (int)(server
.unixtime
-server
.repl_transfer_lastio
)
2100 if (server
.repl_state
!= REDIS_REPL_CONNECTED
) {
2101 info
= sdscatprintf(info
,
2102 "master_link_down_since_seconds:%ld\r\n",
2103 (long)server
.unixtime
-server
.repl_down_since
);
2106 info
= sdscatprintf(info
,
2107 "connected_slaves:%lu\r\n",
2108 listLength(server
.slaves
));
2109 if (listLength(server
.slaves
)) {
2114 listRewind(server
.slaves
,&li
);
2115 while((ln
= listNext(&li
))) {
2116 redisClient
*slave
= listNodeValue(ln
);
2121 if (anetPeerToString(slave
->fd
,ip
,&port
) == -1) continue;
2122 switch(slave
->replstate
) {
2123 case REDIS_REPL_WAIT_BGSAVE_START
:
2124 case REDIS_REPL_WAIT_BGSAVE_END
:
2125 state
= "wait_bgsave";
2127 case REDIS_REPL_SEND_BULK
:
2128 state
= "send_bulk";
2130 case REDIS_REPL_ONLINE
:
2134 if (state
== NULL
) continue;
2135 info
= sdscatprintf(info
,"slave%d:%s,%d,%s\r\n",
2136 slaveid
,ip
,slave
->slave_listening_port
,state
);
2143 if (allsections
|| defsections
|| !strcasecmp(section
,"cpu")) {
2144 if (sections
++) info
= sdscat(info
,"\r\n");
2145 info
= sdscatprintf(info
,
2147 "used_cpu_sys:%.2f\r\n"
2148 "used_cpu_user:%.2f\r\n"
2149 "used_cpu_sys_children:%.2f\r\n"
2150 "used_cpu_user_children:%.2f\r\n",
2151 (float)self_ru
.ru_stime
.tv_sec
+(float)self_ru
.ru_stime
.tv_usec
/1000000,
2152 (float)self_ru
.ru_utime
.tv_sec
+(float)self_ru
.ru_utime
.tv_usec
/1000000,
2153 (float)c_ru
.ru_stime
.tv_sec
+(float)c_ru
.ru_stime
.tv_usec
/1000000,
2154 (float)c_ru
.ru_utime
.tv_sec
+(float)c_ru
.ru_utime
.tv_usec
/1000000);
2158 if (allsections
|| !strcasecmp(section
,"commandstats")) {
2159 if (sections
++) info
= sdscat(info
,"\r\n");
2160 info
= sdscatprintf(info
, "# Commandstats\r\n");
2161 numcommands
= sizeof(redisCommandTable
)/sizeof(struct redisCommand
);
2162 for (j
= 0; j
< numcommands
; j
++) {
2163 struct redisCommand
*c
= redisCommandTable
+j
;
2165 if (!c
->calls
) continue;
2166 info
= sdscatprintf(info
,
2167 "cmdstat_%s:calls=%lld,usec=%lld,usec_per_call=%.2f\r\n",
2168 c
->name
, c
->calls
, c
->microseconds
,
2169 (c
->calls
== 0) ? 0 : ((float)c
->microseconds
/c
->calls
));
2174 if (allsections
|| defsections
|| !strcasecmp(section
,"cluster")) {
2175 if (sections
++) info
= sdscat(info
,"\r\n");
2176 info
= sdscatprintf(info
,
2178 "cluster_enabled:%d\r\n",
2179 server
.cluster_enabled
);
2183 if (allsections
|| defsections
|| !strcasecmp(section
,"keyspace")) {
2184 if (sections
++) info
= sdscat(info
,"\r\n");
2185 info
= sdscatprintf(info
, "# Keyspace\r\n");
2186 for (j
= 0; j
< server
.dbnum
; j
++) {
2187 long long keys
, vkeys
;
2189 keys
= dictSize(server
.db
[j
].dict
);
2190 vkeys
= dictSize(server
.db
[j
].expires
);
2191 if (keys
|| vkeys
) {
2192 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
2200 void infoCommand(redisClient
*c
) {
2201 char *section
= c
->argc
== 2 ? c
->argv
[1]->ptr
: "default";
2204 addReply(c
,shared
.syntaxerr
);
2207 sds info
= genRedisInfoString(section
);
2208 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
2209 (unsigned long)sdslen(info
)));
2210 addReplySds(c
,info
);
2211 addReply(c
,shared
.crlf
);
2214 void monitorCommand(redisClient
*c
) {
2215 /* ignore MONITOR if aleady slave or in monitor mode */
2216 if (c
->flags
& REDIS_SLAVE
) return;
2218 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
2220 listAddNodeTail(server
.monitors
,c
);
2221 addReply(c
,shared
.ok
);
2224 /* ============================ Maxmemory directive ======================== */
2226 /* This function gets called when 'maxmemory' is set on the config file to limit
2227 * the max memory used by the server, before processing a command.
2229 * The goal of the function is to free enough memory to keep Redis under the
2230 * configured memory limit.
2232 * The function starts calculating how many bytes should be freed to keep
2233 * Redis under the limit, and enters a loop selecting the best keys to
2234 * evict accordingly to the configured policy.
2236 * If all the bytes needed to return back under the limit were freed the
2237 * function returns REDIS_OK, otherwise REDIS_ERR is returned, and the caller
2238 * should block the execution of commands that will result in more memory
2239 * used by the server.
2241 int freeMemoryIfNeeded(void) {
2242 size_t mem_used
, mem_tofree
, mem_freed
;
2243 int slaves
= listLength(server
.slaves
);
2245 /* Remove the size of slaves output buffers and AOF buffer from the
2246 * count of used memory. */
2247 mem_used
= zmalloc_used_memory();
2252 listRewind(server
.slaves
,&li
);
2253 while((ln
= listNext(&li
))) {
2254 redisClient
*slave
= listNodeValue(ln
);
2255 unsigned long obuf_bytes
= getClientOutputBufferMemoryUsage(slave
);
2256 if (obuf_bytes
> mem_used
)
2259 mem_used
-= obuf_bytes
;
2262 if (server
.aof_state
!= REDIS_AOF_OFF
) {
2263 mem_used
-= sdslen(server
.aof_buf
);
2264 mem_used
-= aofRewriteBufferSize();
2267 /* Check if we are over the memory limit. */
2268 if (mem_used
<= server
.maxmemory
) return REDIS_OK
;
2270 if (server
.maxmemory_policy
== REDIS_MAXMEMORY_NO_EVICTION
)
2271 return REDIS_ERR
; /* We need to free memory, but policy forbids. */
2273 /* Compute how much memory we need to free. */
2274 mem_tofree
= mem_used
- server
.maxmemory
;
2276 while (mem_freed
< mem_tofree
) {
2277 int j
, k
, keys_freed
= 0;
2279 for (j
= 0; j
< server
.dbnum
; j
++) {
2280 long bestval
= 0; /* just to prevent warning */
2282 struct dictEntry
*de
;
2283 redisDb
*db
= server
.db
+j
;
2286 if (server
.maxmemory_policy
== REDIS_MAXMEMORY_ALLKEYS_LRU
||
2287 server
.maxmemory_policy
== REDIS_MAXMEMORY_ALLKEYS_RANDOM
)
2289 dict
= server
.db
[j
].dict
;
2291 dict
= server
.db
[j
].expires
;
2293 if (dictSize(dict
) == 0) continue;
2295 /* volatile-random and allkeys-random policy */
2296 if (server
.maxmemory_policy
== REDIS_MAXMEMORY_ALLKEYS_RANDOM
||
2297 server
.maxmemory_policy
== REDIS_MAXMEMORY_VOLATILE_RANDOM
)
2299 de
= dictGetRandomKey(dict
);
2300 bestkey
= dictGetKey(de
);
2303 /* volatile-lru and allkeys-lru policy */
2304 else if (server
.maxmemory_policy
== REDIS_MAXMEMORY_ALLKEYS_LRU
||
2305 server
.maxmemory_policy
== REDIS_MAXMEMORY_VOLATILE_LRU
)
2307 for (k
= 0; k
< server
.maxmemory_samples
; k
++) {
2312 de
= dictGetRandomKey(dict
);
2313 thiskey
= dictGetKey(de
);
2314 /* When policy is volatile-lru we need an additonal lookup
2315 * to locate the real key, as dict is set to db->expires. */
2316 if (server
.maxmemory_policy
== REDIS_MAXMEMORY_VOLATILE_LRU
)
2317 de
= dictFind(db
->dict
, thiskey
);
2319 thisval
= estimateObjectIdleTime(o
);
2321 /* Higher idle time is better candidate for deletion */
2322 if (bestkey
== NULL
|| thisval
> bestval
) {
2330 else if (server
.maxmemory_policy
== REDIS_MAXMEMORY_VOLATILE_TTL
) {
2331 for (k
= 0; k
< server
.maxmemory_samples
; k
++) {
2335 de
= dictGetRandomKey(dict
);
2336 thiskey
= dictGetKey(de
);
2337 thisval
= (long) dictGetVal(de
);
2339 /* Expire sooner (minor expire unix timestamp) is better
2340 * candidate for deletion */
2341 if (bestkey
== NULL
|| thisval
< bestval
) {
2348 /* Finally remove the selected key. */
2352 robj
*keyobj
= createStringObject(bestkey
,sdslen(bestkey
));
2353 propagateExpire(db
,keyobj
);
2354 /* We compute the amount of memory freed by dbDelete() alone.
2355 * It is possible that actually the memory needed to propagate
2356 * the DEL in AOF and replication link is greater than the one
2357 * we are freeing removing the key, but we can't account for
2358 * that otherwise we would never exit the loop.
2360 * AOF and Output buffer memory will be freed eventually so
2361 * we only care about memory used by the key space. */
2362 delta
= (long long) zmalloc_used_memory();
2363 dbDelete(db
,keyobj
);
2364 delta
-= (long long) zmalloc_used_memory();
2366 server
.stat_evictedkeys
++;
2367 decrRefCount(keyobj
);
2370 /* When the memory to free starts to be big enough, we may
2371 * start spending so much time here that is impossible to
2372 * deliver data to the slaves fast enough, so we force the
2373 * transmission here inside the loop. */
2374 if (slaves
) flushSlavesOutputBuffers();
2377 if (!keys_freed
) return REDIS_ERR
; /* nothing to free... */
2382 /* =================================== Main! ================================ */
2385 int linuxOvercommitMemoryValue(void) {
2386 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
2390 if (fgets(buf
,64,fp
) == NULL
) {
2399 void linuxOvercommitMemoryWarning(void) {
2400 if (linuxOvercommitMemoryValue() == 0) {
2401 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.");
2404 #endif /* __linux__ */
2406 void createPidFile(void) {
2407 /* Try to write the pid file in a best-effort way. */
2408 FILE *fp
= fopen(server
.pidfile
,"w");
2410 fprintf(fp
,"%d\n",(int)getpid());
2415 void daemonize(void) {
2418 if (fork() != 0) exit(0); /* parent exits */
2419 setsid(); /* create a new session */
2421 /* Every output goes to /dev/null. If Redis is daemonized but
2422 * the 'logfile' is set to 'stdout' in the configuration file
2423 * it will not log at all. */
2424 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
2425 dup2(fd
, STDIN_FILENO
);
2426 dup2(fd
, STDOUT_FILENO
);
2427 dup2(fd
, STDERR_FILENO
);
2428 if (fd
> STDERR_FILENO
) close(fd
);
2433 printf("Redis server v=%s sha=%s:%d malloc=%s bits=%d\n",
2436 atoi(redisGitDirty()) > 0,
2438 sizeof(long) == 4 ? 32 : 64);
2443 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf] [options]\n");
2444 fprintf(stderr
," ./redis-server - (read config from stdin)\n");
2445 fprintf(stderr
," ./redis-server -v or --version\n");
2446 fprintf(stderr
," ./redis-server -h or --help\n");
2447 fprintf(stderr
," ./redis-server --test-memory <megabytes>\n\n");
2448 fprintf(stderr
,"Examples:\n");
2449 fprintf(stderr
," ./redis-server (run the server with default conf)\n");
2450 fprintf(stderr
," ./redis-server /etc/redis/6379.conf\n");
2451 fprintf(stderr
," ./redis-server --port 7777\n");
2452 fprintf(stderr
," ./redis-server --port 7777 --slaveof 127.0.0.1 8888\n");
2453 fprintf(stderr
," ./redis-server /etc/myredis.conf --loglevel verbose\n\n");
2454 fprintf(stderr
,"Sentinel mode:\n");
2455 fprintf(stderr
," ./redis-server /etc/sentinel.conf --sentinel\n");
2459 void redisAsciiArt(void) {
2460 #include "asciilogo.h"
2461 char *buf
= zmalloc(1024*16);
2462 char *mode
= "stand alone";
2464 if (server
.cluster_enabled
) mode
= "cluster";
2465 else if (server
.sentinel_mode
) mode
= "sentinel";
2467 snprintf(buf
,1024*16,ascii_logo
,
2470 strtol(redisGitDirty(),NULL
,10) > 0,
2471 (sizeof(long) == 8) ? "64" : "32",
2475 redisLogRaw(REDIS_NOTICE
|REDIS_LOG_RAW
,buf
);
2479 static void sigtermHandler(int sig
) {
2482 redisLogFromHandler(REDIS_WARNING
,"Received SIGTERM, scheduling shutdown...");
2483 server
.shutdown_asap
= 1;
2486 void setupSignalHandlers(void) {
2487 struct sigaction act
;
2489 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction is used.
2490 * Otherwise, sa_handler is used. */
2491 sigemptyset(&act
.sa_mask
);
2493 act
.sa_handler
= sigtermHandler
;
2494 sigaction(SIGTERM
, &act
, NULL
);
2496 #ifdef HAVE_BACKTRACE
2497 sigemptyset(&act
.sa_mask
);
2498 act
.sa_flags
= SA_NODEFER
| SA_RESETHAND
| SA_SIGINFO
;
2499 act
.sa_sigaction
= sigsegvHandler
;
2500 sigaction(SIGSEGV
, &act
, NULL
);
2501 sigaction(SIGBUS
, &act
, NULL
);
2502 sigaction(SIGFPE
, &act
, NULL
);
2503 sigaction(SIGILL
, &act
, NULL
);
2508 void memtest(size_t megabytes
, int passes
);
2510 /* Returns 1 if there is --sentinel among the arguments or if
2511 * argv[0] is exactly "redis-sentinel". */
2512 int checkForSentinelMode(int argc
, char **argv
) {
2515 if (strstr(argv
[0],"redis-sentinel") != NULL
) return 1;
2516 for (j
= 1; j
< argc
; j
++)
2517 if (!strcmp(argv
[j
],"--sentinel")) return 1;
2521 /* Function called at startup to load RDB or AOF file in memory. */
2522 void loadDataFromDisk(void) {
2523 long long start
= ustime();
2524 if (server
.aof_state
== REDIS_AOF_ON
) {
2525 if (loadAppendOnlyFile(server
.aof_filename
) == REDIS_OK
)
2526 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %.3f seconds",(float)(ustime()-start
)/1000000);
2528 if (rdbLoad(server
.rdb_filename
) == REDIS_OK
) {
2529 redisLog(REDIS_NOTICE
,"DB loaded from disk: %.3f seconds",
2530 (float)(ustime()-start
)/1000000);
2531 } else if (errno
!= ENOENT
) {
2532 redisLog(REDIS_WARNING
,"Fatal error loading the DB. Exiting.");
2538 int main(int argc
, char **argv
) {
2541 /* We need to initialize our libraries, and the server configuration. */
2542 zmalloc_enable_thread_safeness();
2543 srand(time(NULL
)^getpid());
2544 gettimeofday(&tv
,NULL
);
2545 dictSetHashFunctionSeed(tv
.tv_sec
^tv
.tv_usec
^getpid());
2546 server
.sentinel_mode
= checkForSentinelMode(argc
,argv
);
2549 /* We need to init sentinel right now as parsing the configuration file
2550 * in sentinel mode will have the effect of populating the sentinel
2551 * data structures with master nodes to monitor. */
2552 if (server
.sentinel_mode
) {
2553 initSentinelConfig();
2558 int j
= 1; /* First option to parse in argv[] */
2559 sds options
= sdsempty();
2560 char *configfile
= NULL
;
2562 /* Handle special options --help and --version */
2563 if (strcmp(argv
[1], "-v") == 0 ||
2564 strcmp(argv
[1], "--version") == 0) version();
2565 if (strcmp(argv
[1], "--help") == 0 ||
2566 strcmp(argv
[1], "-h") == 0) usage();
2567 if (strcmp(argv
[1], "--test-memory") == 0) {
2569 memtest(atoi(argv
[2]),50);
2572 fprintf(stderr
,"Please specify the amount of memory to test in megabytes.\n");
2573 fprintf(stderr
,"Example: ./redis-server --test-memory 4096\n\n");
2578 /* First argument is the config file name? */
2579 if (argv
[j
][0] != '-' || argv
[j
][1] != '-')
2580 configfile
= argv
[j
++];
2581 /* All the other options are parsed and conceptually appended to the
2582 * configuration file. For instance --port 6380 will generate the
2583 * string "port 6380\n" to be parsed after the actual file name
2584 * is parsed, if any. */
2586 if (argv
[j
][0] == '-' && argv
[j
][1] == '-') {
2588 if (sdslen(options
)) options
= sdscat(options
,"\n");
2589 options
= sdscat(options
,argv
[j
]+2);
2590 options
= sdscat(options
," ");
2592 /* Option argument */
2593 options
= sdscatrepr(options
,argv
[j
],strlen(argv
[j
]));
2594 options
= sdscat(options
," ");
2598 resetServerSaveParams();
2599 loadServerConfig(configfile
,options
);
2602 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");
2604 if (server
.daemonize
) daemonize();
2606 if (server
.daemonize
) createPidFile();
2609 if (!server
.sentinel_mode
) {
2610 /* Things only needed when not runnign in Sentinel mode. */
2611 redisLog(REDIS_WARNING
,"Server started, Redis version " REDIS_VERSION
);
2613 linuxOvercommitMemoryWarning();
2616 if (server
.ipfd
> 0)
2617 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
2618 if (server
.sofd
> 0)
2619 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections at %s", server
.unixsocket
);
2622 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
2624 aeDeleteEventLoop(server
.el
);