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
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 {"cluster",clusterCommand
,-2,"ar",0,NULL
,0,0,0,0,0},
243 {"restore",restoreCommand
,4,"awm",0,NULL
,1,1,1,0,0},
244 {"migrate",migrateCommand
,6,"aw",0,NULL
,0,0,0,0,0},
245 {"asking",askingCommand
,1,"r",0,NULL
,0,0,0,0,0},
246 {"dump",dumpCommand
,2,"ar",0,NULL
,1,1,1,0,0},
247 {"object",objectCommand
,-2,"r",0,NULL
,2,2,2,0,0},
248 {"client",clientCommand
,-2,"ar",0,NULL
,0,0,0,0,0},
249 {"eval",evalCommand
,-3,"s",0,zunionInterGetKeys
,0,0,0,0,0},
250 {"evalsha",evalShaCommand
,-3,"s",0,zunionInterGetKeys
,0,0,0,0,0},
251 {"slowlog",slowlogCommand
,-2,"r",0,NULL
,0,0,0,0,0},
252 {"script",scriptCommand
,-2,"ras",0,NULL
,0,0,0,0,0},
253 {"time",timeCommand
,1,"rR",0,NULL
,0,0,0,0,0},
254 {"bitop",bitopCommand
,-4,"wm",0,NULL
,2,-1,1,0,0},
255 {"bitcount",bitcountCommand
,-2,"r",0,NULL
,1,1,1,0,0}
258 /*============================ Utility functions ============================ */
260 /* Low level logging. To use only for very big messages, otherwise
261 * redisLog() is to prefer. */
262 void redisLogRaw(int level
, const char *msg
) {
263 const int syslogLevelMap
[] = { LOG_DEBUG
, LOG_INFO
, LOG_NOTICE
, LOG_WARNING
};
264 const char *c
= ".-*#";
267 int rawmode
= (level
& REDIS_LOG_RAW
);
269 level
&= 0xff; /* clear flags */
270 if (level
< server
.verbosity
) return;
272 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
276 fprintf(fp
,"%s",msg
);
281 gettimeofday(&tv
,NULL
);
282 off
= strftime(buf
,sizeof(buf
),"%d %b %H:%M:%S.",localtime(&tv
.tv_sec
));
283 snprintf(buf
+off
,sizeof(buf
)-off
,"%03d",(int)tv
.tv_usec
/1000);
284 fprintf(fp
,"[%d] %s %c %s\n",(int)getpid(),buf
,c
[level
],msg
);
288 if (server
.logfile
) fclose(fp
);
290 if (server
.syslog_enabled
) syslog(syslogLevelMap
[level
], "%s", msg
);
293 /* Like redisLogRaw() but with printf-alike support. This is the funciton that
294 * is used across the code. The raw version is only used in order to dump
295 * the INFO output on crash. */
296 void redisLog(int level
, const char *fmt
, ...) {
298 char msg
[REDIS_MAX_LOGMSG_LEN
];
300 if ((level
&0xff) < server
.verbosity
) return;
303 vsnprintf(msg
, sizeof(msg
), fmt
, ap
);
306 redisLogRaw(level
,msg
);
309 /* Log a fixed message without printf-alike capabilities, in a way that is
310 * safe to call from a signal handler.
312 * We actually use this only for signals that are not fatal from the point
313 * of view of Redis. Signals that are going to kill the server anyway and
314 * where we need printf-alike features are served by redisLog(). */
315 void redisLogFromHandler(int level
, const char *msg
) {
319 if ((level
&0xff) < server
.verbosity
||
320 (server
.logfile
== NULL
&& server
.daemonize
)) return;
321 fd
= server
.logfile
?
322 open(server
.logfile
, O_APPEND
|O_CREAT
|O_WRONLY
, 0644) :
324 if (fd
== -1) return;
325 ll2string(buf
,sizeof(buf
),getpid());
326 if (write(fd
,"[",1) == -1) goto err
;
327 if (write(fd
,buf
,strlen(buf
)) == -1) goto err
;
328 if (write(fd
," | signal handler] (",20) == -1) goto err
;
329 ll2string(buf
,sizeof(buf
),time(NULL
));
330 if (write(fd
,buf
,strlen(buf
)) == -1) goto err
;
331 if (write(fd
,") ",2) == -1) goto err
;
332 if (write(fd
,msg
,strlen(msg
)) == -1) goto err
;
333 if (write(fd
,"\n",1) == -1) goto err
;
335 if (server
.logfile
) close(fd
);
338 /* Return the UNIX time in microseconds */
339 long long ustime(void) {
343 gettimeofday(&tv
, NULL
);
344 ust
= ((long long)tv
.tv_sec
)*1000000;
349 /* Return the UNIX time in milliseconds */
350 long long mstime(void) {
351 return ustime()/1000;
354 /* After an RDB dump or AOF rewrite we exit from children using _exit() instead of
355 * exit(), because the latter may interact with the same file objects used by
356 * the parent process. However if we are testing the coverage normal exit() is
357 * used in order to obtain the right coverage information. */
358 void exitFromChild(int retcode
) {
366 /*====================== Hash table type implementation ==================== */
368 /* This is an hash table type that uses the SDS dynamic strings libary as
369 * keys and radis objects as values (objects can hold SDS strings,
372 void dictVanillaFree(void *privdata
, void *val
)
374 DICT_NOTUSED(privdata
);
378 void dictListDestructor(void *privdata
, void *val
)
380 DICT_NOTUSED(privdata
);
381 listRelease((list
*)val
);
384 int dictSdsKeyCompare(void *privdata
, const void *key1
,
388 DICT_NOTUSED(privdata
);
390 l1
= sdslen((sds
)key1
);
391 l2
= sdslen((sds
)key2
);
392 if (l1
!= l2
) return 0;
393 return memcmp(key1
, key2
, l1
) == 0;
396 /* A case insensitive version used for the command lookup table. */
397 int dictSdsKeyCaseCompare(void *privdata
, const void *key1
,
400 DICT_NOTUSED(privdata
);
402 return strcasecmp(key1
, key2
) == 0;
405 void dictRedisObjectDestructor(void *privdata
, void *val
)
407 DICT_NOTUSED(privdata
);
409 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
413 void dictSdsDestructor(void *privdata
, void *val
)
415 DICT_NOTUSED(privdata
);
420 int dictObjKeyCompare(void *privdata
, const void *key1
,
423 const robj
*o1
= key1
, *o2
= key2
;
424 return dictSdsKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
427 unsigned int dictObjHash(const void *key
) {
429 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
432 unsigned int dictSdsHash(const void *key
) {
433 return dictGenHashFunction((unsigned char*)key
, sdslen((char*)key
));
436 unsigned int dictSdsCaseHash(const void *key
) {
437 return dictGenCaseHashFunction((unsigned char*)key
, sdslen((char*)key
));
440 int dictEncObjKeyCompare(void *privdata
, const void *key1
,
443 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
446 if (o1
->encoding
== REDIS_ENCODING_INT
&&
447 o2
->encoding
== REDIS_ENCODING_INT
)
448 return o1
->ptr
== o2
->ptr
;
450 o1
= getDecodedObject(o1
);
451 o2
= getDecodedObject(o2
);
452 cmp
= dictSdsKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
458 unsigned int dictEncObjHash(const void *key
) {
459 robj
*o
= (robj
*) key
;
461 if (o
->encoding
== REDIS_ENCODING_RAW
) {
462 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
464 if (o
->encoding
== REDIS_ENCODING_INT
) {
468 len
= ll2string(buf
,32,(long)o
->ptr
);
469 return dictGenHashFunction((unsigned char*)buf
, len
);
473 o
= getDecodedObject(o
);
474 hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
481 /* Sets type hash table */
482 dictType setDictType
= {
483 dictEncObjHash
, /* hash function */
486 dictEncObjKeyCompare
, /* key compare */
487 dictRedisObjectDestructor
, /* key destructor */
488 NULL
/* val destructor */
491 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
492 dictType zsetDictType
= {
493 dictEncObjHash
, /* hash function */
496 dictEncObjKeyCompare
, /* key compare */
497 dictRedisObjectDestructor
, /* key destructor */
498 NULL
/* val destructor */
501 /* Db->dict, keys are sds strings, vals are Redis objects. */
502 dictType dbDictType
= {
503 dictSdsHash
, /* hash function */
506 dictSdsKeyCompare
, /* key compare */
507 dictSdsDestructor
, /* key destructor */
508 dictRedisObjectDestructor
/* val destructor */
512 dictType keyptrDictType
= {
513 dictSdsHash
, /* hash function */
516 dictSdsKeyCompare
, /* key compare */
517 NULL
, /* key destructor */
518 NULL
/* val destructor */
521 /* Command table. sds string -> command struct pointer. */
522 dictType commandTableDictType
= {
523 dictSdsCaseHash
, /* hash function */
526 dictSdsKeyCaseCompare
, /* key compare */
527 dictSdsDestructor
, /* key destructor */
528 NULL
/* val destructor */
531 /* Hash type hash table (note that small hashes are represented with zimpaps) */
532 dictType hashDictType
= {
533 dictEncObjHash
, /* hash function */
536 dictEncObjKeyCompare
, /* key compare */
537 dictRedisObjectDestructor
, /* key destructor */
538 dictRedisObjectDestructor
/* val destructor */
541 /* Keylist hash table type has unencoded redis objects as keys and
542 * lists as values. It's used for blocking operations (BLPOP) and to
543 * map swapped keys to a list of clients waiting for this keys to be loaded. */
544 dictType keylistDictType
= {
545 dictObjHash
, /* hash function */
548 dictObjKeyCompare
, /* key compare */
549 dictRedisObjectDestructor
, /* key destructor */
550 dictListDestructor
/* val destructor */
553 /* Cluster nodes hash table, mapping nodes addresses 1.2.3.4:6379 to
554 * clusterNode structures. */
555 dictType clusterNodesDictType
= {
556 dictSdsHash
, /* hash function */
559 dictSdsKeyCompare
, /* key compare */
560 dictSdsDestructor
, /* key destructor */
561 NULL
/* val destructor */
564 int htNeedsResize(dict
*dict
) {
565 long long size
, used
;
567 size
= dictSlots(dict
);
568 used
= dictSize(dict
);
569 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
570 (used
*100/size
< REDIS_HT_MINFILL
));
573 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
574 * we resize the hash table to save memory */
575 void tryResizeHashTables(void) {
578 for (j
= 0; j
< server
.dbnum
; j
++) {
579 if (htNeedsResize(server
.db
[j
].dict
))
580 dictResize(server
.db
[j
].dict
);
581 if (htNeedsResize(server
.db
[j
].expires
))
582 dictResize(server
.db
[j
].expires
);
586 /* Our hash table implementation performs rehashing incrementally while
587 * we write/read from the hash table. Still if the server is idle, the hash
588 * table will use two tables for a long time. So we try to use 1 millisecond
589 * of CPU time at every serverCron() loop in order to rehash some key. */
590 void incrementallyRehash(void) {
593 for (j
= 0; j
< server
.dbnum
; j
++) {
594 /* Keys dictionary */
595 if (dictIsRehashing(server
.db
[j
].dict
)) {
596 dictRehashMilliseconds(server
.db
[j
].dict
,1);
597 break; /* already used our millisecond for this loop... */
600 if (dictIsRehashing(server
.db
[j
].expires
)) {
601 dictRehashMilliseconds(server
.db
[j
].expires
,1);
602 break; /* already used our millisecond for this loop... */
607 /* This function is called once a background process of some kind terminates,
608 * as we want to avoid resizing the hash tables when there is a child in order
609 * to play well with copy-on-write (otherwise when a resize happens lots of
610 * memory pages are copied). The goal of this function is to update the ability
611 * for dict.c to resize the hash tables accordingly to the fact we have o not
613 void updateDictResizePolicy(void) {
614 if (server
.rdb_child_pid
== -1 && server
.aof_child_pid
== -1)
620 /* ======================= Cron: called every 100 ms ======================== */
622 /* Try to expire a few timed out keys. The algorithm used is adaptive and
623 * will use few CPU cycles if there are few expiring keys, otherwise
624 * it will get more aggressive to avoid that too much memory is used by
625 * keys that can be removed from the keyspace. */
626 void activeExpireCycle(void) {
627 int j
, iteration
= 0;
628 long long start
= ustime(), timelimit
;
630 /* We can use at max REDIS_EXPIRELOOKUPS_TIME_PERC percentage of CPU time
631 * per iteration. Since this function gets called with a frequency of
632 * REDIS_HZ times per second, the following is the max amount of
633 * microseconds we can spend in this function. */
634 timelimit
= 1000000*REDIS_EXPIRELOOKUPS_TIME_PERC
/REDIS_HZ
/100;
635 if (timelimit
<= 0) timelimit
= 1;
637 for (j
= 0; j
< server
.dbnum
; j
++) {
639 redisDb
*db
= server
.db
+j
;
641 /* Continue to expire if at the end of the cycle more than 25%
642 * of the keys were expired. */
644 unsigned long num
= dictSize(db
->expires
);
645 unsigned long slots
= dictSlots(db
->expires
);
646 long long now
= mstime();
648 /* When there are less than 1% filled slots getting random
649 * keys is expensive, so stop here waiting for better times...
650 * The dictionary will be resized asap. */
651 if (num
&& slots
> DICT_HT_INITIAL_SIZE
&&
652 (num
*100/slots
< 1)) break;
654 /* The main collection cycle. Sample random keys among keys
655 * with an expire set, checking for expired ones. */
657 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
658 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
663 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
664 t
= dictGetSignedIntegerVal(de
);
666 sds key
= dictGetKey(de
);
667 robj
*keyobj
= createStringObject(key
,sdslen(key
));
669 propagateExpire(db
,keyobj
);
671 decrRefCount(keyobj
);
673 server
.stat_expiredkeys
++;
676 /* We can't block forever here even if there are many keys to
677 * expire. So after a given amount of milliseconds return to the
678 * caller waiting for the other active expire cycle. */
680 if ((iteration
& 0xf) == 0 && /* check once every 16 cycles. */
681 (ustime()-start
) > timelimit
) return;
682 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
686 void updateLRUClock(void) {
687 server
.lruclock
= (server
.unixtime
/REDIS_LRU_CLOCK_RESOLUTION
) &
692 /* Add a sample to the operations per second array of samples. */
693 void trackOperationsPerSecond(void) {
694 long long t
= mstime() - server
.ops_sec_last_sample_time
;
695 long long ops
= server
.stat_numcommands
- server
.ops_sec_last_sample_ops
;
698 ops_sec
= t
> 0 ? (ops
*1000/t
) : 0;
700 server
.ops_sec_samples
[server
.ops_sec_idx
] = ops_sec
;
701 server
.ops_sec_idx
= (server
.ops_sec_idx
+1) % REDIS_OPS_SEC_SAMPLES
;
702 server
.ops_sec_last_sample_time
= mstime();
703 server
.ops_sec_last_sample_ops
= server
.stat_numcommands
;
706 /* Return the mean of all the samples. */
707 long long getOperationsPerSecond(void) {
711 for (j
= 0; j
< REDIS_OPS_SEC_SAMPLES
; j
++)
712 sum
+= server
.ops_sec_samples
[j
];
713 return sum
/ REDIS_OPS_SEC_SAMPLES
;
716 /* Check for timeouts. Returns non-zero if the client was terminated */
717 int clientsCronHandleTimeout(redisClient
*c
) {
718 time_t now
= server
.unixtime
;
720 if (server
.maxidletime
&&
721 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
722 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
723 !(c
->flags
& REDIS_BLOCKED
) && /* no timeout for BLPOP */
724 dictSize(c
->pubsub_channels
) == 0 && /* no timeout for pubsub */
725 listLength(c
->pubsub_patterns
) == 0 &&
726 (now
- c
->lastinteraction
> server
.maxidletime
))
728 redisLog(REDIS_VERBOSE
,"Closing idle client");
731 } else if (c
->flags
& REDIS_BLOCKED
) {
732 if (c
->bpop
.timeout
!= 0 && c
->bpop
.timeout
< now
) {
733 addReply(c
,shared
.nullmultibulk
);
734 unblockClientWaitingData(c
);
740 /* The client query buffer is an sds.c string that can end with a lot of
741 * free space not used, this function reclaims space if needed.
743 * The funciton always returns 0 as it never terminates the client. */
744 int clientsCronResizeQueryBuffer(redisClient
*c
) {
745 size_t querybuf_size
= sdsAllocSize(c
->querybuf
);
746 time_t idletime
= server
.unixtime
- c
->lastinteraction
;
748 /* There are two conditions to resize the query buffer:
749 * 1) Query buffer is > BIG_ARG and too big for latest peak.
750 * 2) Client is inactive and the buffer is bigger than 1k. */
751 if (((querybuf_size
> REDIS_MBULK_BIG_ARG
) &&
752 (querybuf_size
/(c
->querybuf_peak
+1)) > 2) ||
753 (querybuf_size
> 1024 && idletime
> 2))
755 /* Only resize the query buffer if it is actually wasting space. */
756 if (sdsavail(c
->querybuf
) > 1024) {
757 c
->querybuf
= sdsRemoveFreeSpace(c
->querybuf
);
760 /* Reset the peak again to capture the peak memory usage in the next
762 c
->querybuf_peak
= 0;
766 void clientsCron(void) {
767 /* Make sure to process at least 1/(REDIS_HZ*10) of clients per call.
768 * Since this function is called REDIS_HZ times per second we are sure that
769 * in the worst case we process all the clients in 10 seconds.
770 * In normal conditions (a reasonable number of clients) we process
771 * all the clients in a shorter time. */
772 int numclients
= listLength(server
.clients
);
773 int iterations
= numclients
/(REDIS_HZ
*10);
776 iterations
= (numclients
< 50) ? numclients
: 50;
777 while(listLength(server
.clients
) && iterations
--) {
781 /* Rotate the list, take the current head, process.
782 * This way if the client must be removed from the list it's the
783 * first element and we don't incur into O(N) computation. */
784 listRotate(server
.clients
);
785 head
= listFirst(server
.clients
);
786 c
= listNodeValue(head
);
787 /* The following functions do different service checks on the client.
788 * The protocol is that they return non-zero if the client was
790 if (clientsCronHandleTimeout(c
)) continue;
791 if (clientsCronResizeQueryBuffer(c
)) continue;
795 /* This is our timer interrupt, called REDIS_HZ times per second.
796 * Here is where we do a number of things that need to be done asynchronously.
799 * - Active expired keys collection (it is also performed in a lazy way on
801 * - Software watchdong.
802 * - Update some statistic.
803 * - Incremental rehashing of the DBs hash tables.
804 * - Triggering BGSAVE / AOF rewrite, and handling of terminated children.
805 * - Clients timeout of differnet kinds.
806 * - Replication reconnection.
809 * Everything directly called here will be called REDIS_HZ times per second,
810 * so in order to throttle execution of things we want to do less frequently
811 * a macro is used: run_with_period(milliseconds) { .... }
814 int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
816 REDIS_NOTUSED(eventLoop
);
818 REDIS_NOTUSED(clientData
);
820 /* Software watchdog: deliver the SIGALRM that will reach the signal
821 * handler if we don't return here fast enough. */
822 if (server
.watchdog_period
) watchdogScheduleSignal(server
.watchdog_period
);
824 /* We take a cached value of the unix time in the global state because
825 * with virtual memory and aging there is to store the current time
826 * in objects at every object access, and accuracy is not needed.
827 * To access a global var is faster than calling time(NULL) */
828 server
.unixtime
= time(NULL
);
830 run_with_period(100) trackOperationsPerSecond();
832 /* We have just 22 bits per object for LRU information.
833 * So we use an (eventually wrapping) LRU clock with 10 seconds resolution.
834 * 2^22 bits with 10 seconds resoluton is more or less 1.5 years.
836 * Note that even if this will wrap after 1.5 years it's not a problem,
837 * everything will still work but just some object will appear younger
838 * to Redis. But for this to happen a given object should never be touched
841 * Note that you can change the resolution altering the
842 * REDIS_LRU_CLOCK_RESOLUTION define.
846 /* Record the max memory used since the server was started. */
847 if (zmalloc_used_memory() > server
.stat_peak_memory
)
848 server
.stat_peak_memory
= zmalloc_used_memory();
850 /* We received a SIGTERM, shutting down here in a safe way, as it is
851 * not ok doing so inside the signal handler. */
852 if (server
.shutdown_asap
) {
853 if (prepareForShutdown(0) == REDIS_OK
) exit(0);
854 redisLog(REDIS_WARNING
,"SIGTERM received but errors trying to shut down the server, check the logs for more information");
857 /* Show some info about non-empty databases */
858 run_with_period(5000) {
859 for (j
= 0; j
< server
.dbnum
; j
++) {
860 long long size
, used
, vkeys
;
862 size
= dictSlots(server
.db
[j
].dict
);
863 used
= dictSize(server
.db
[j
].dict
);
864 vkeys
= dictSize(server
.db
[j
].expires
);
866 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
867 /* dictPrintStats(server.dict); */
872 /* We don't want to resize the hash tables while a bacground saving
873 * is in progress: the saving child is created using fork() that is
874 * implemented with a copy-on-write semantic in most modern systems, so
875 * if we resize the HT while there is the saving child at work actually
876 * a lot of memory movements in the parent will cause a lot of pages
878 if (server
.rdb_child_pid
== -1 && server
.aof_child_pid
== -1) {
879 tryResizeHashTables();
880 if (server
.activerehashing
) incrementallyRehash();
883 /* Show information about connected clients */
884 if (!server
.sentinel_mode
) {
885 run_with_period(5000) {
886 redisLog(REDIS_VERBOSE
,
887 "%d clients connected (%d slaves), %zu bytes in use",
888 listLength(server
.clients
)-listLength(server
.slaves
),
889 listLength(server
.slaves
),
890 zmalloc_used_memory());
894 /* We need to do a few operations on clients asynchronously. */
897 /* Start a scheduled AOF rewrite if this was requested by the user while
898 * a BGSAVE was in progress. */
899 if (server
.rdb_child_pid
== -1 && server
.aof_child_pid
== -1 &&
900 server
.aof_rewrite_scheduled
)
902 rewriteAppendOnlyFileBackground();
905 /* Check if a background saving or AOF rewrite in progress terminated. */
906 if (server
.rdb_child_pid
!= -1 || server
.aof_child_pid
!= -1) {
910 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
911 int exitcode
= WEXITSTATUS(statloc
);
914 if (WIFSIGNALED(statloc
)) bysignal
= WTERMSIG(statloc
);
916 if (pid
== server
.rdb_child_pid
) {
917 backgroundSaveDoneHandler(exitcode
,bysignal
);
919 backgroundRewriteDoneHandler(exitcode
,bysignal
);
921 updateDictResizePolicy();
924 /* If there is not a background saving/rewrite in progress check if
925 * we have to save/rewrite now */
926 for (j
= 0; j
< server
.saveparamslen
; j
++) {
927 struct saveparam
*sp
= server
.saveparams
+j
;
929 if (server
.dirty
>= sp
->changes
&&
930 server
.unixtime
-server
.lastsave
> sp
->seconds
) {
931 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
932 sp
->changes
, sp
->seconds
);
933 rdbSaveBackground(server
.rdb_filename
);
938 /* Trigger an AOF rewrite if needed */
939 if (server
.rdb_child_pid
== -1 &&
940 server
.aof_child_pid
== -1 &&
941 server
.aof_rewrite_perc
&&
942 server
.aof_current_size
> server
.aof_rewrite_min_size
)
944 long long base
= server
.aof_rewrite_base_size
?
945 server
.aof_rewrite_base_size
: 1;
946 long long growth
= (server
.aof_current_size
*100/base
) - 100;
947 if (growth
>= server
.aof_rewrite_perc
) {
948 redisLog(REDIS_NOTICE
,"Starting automatic rewriting of AOF on %lld%% growth",growth
);
949 rewriteAppendOnlyFileBackground();
955 /* If we postponed an AOF buffer flush, let's try to do it every time the
956 * cron function is called. */
957 if (server
.aof_flush_postponed_start
) flushAppendOnlyFile(0);
959 /* Expire a few keys per cycle, only if this is a master.
960 * On slaves we wait for DEL operations synthesized by the master
961 * in order to guarantee a strict consistency. */
962 if (server
.masterhost
== NULL
) activeExpireCycle();
964 /* Close clients that need to be closed asynchronous */
965 freeClientsInAsyncFreeQueue();
967 /* Replication cron function -- used to reconnect to master and
968 * to detect transfer failures. */
969 run_with_period(1000) replicationCron();
971 /* Run other sub-systems specific cron jobs */
972 run_with_period(1000) {
973 if (server
.cluster_enabled
) clusterCron();
976 /* Run the sentinel timer if we are in sentinel mode. */
977 run_with_period(100) {
978 if (server
.sentinel_mode
) sentinelTimer();
982 return 1000/REDIS_HZ
;
985 /* This function gets called every time Redis is entering the
986 * main loop of the event driven library, that is, before to sleep
987 * for ready file descriptors. */
988 void beforeSleep(struct aeEventLoop
*eventLoop
) {
989 REDIS_NOTUSED(eventLoop
);
993 /* Try to process pending commands for clients that were just unblocked. */
994 while (listLength(server
.unblocked_clients
)) {
995 ln
= listFirst(server
.unblocked_clients
);
996 redisAssert(ln
!= NULL
);
998 listDelNode(server
.unblocked_clients
,ln
);
999 c
->flags
&= ~REDIS_UNBLOCKED
;
1001 /* Process remaining data in the input buffer. */
1002 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) {
1003 server
.current_client
= c
;
1004 processInputBuffer(c
);
1005 server
.current_client
= NULL
;
1009 /* Write the AOF buffer on disk */
1010 flushAppendOnlyFile(0);
1013 /* =========================== Server initialization ======================== */
1015 void createSharedObjects(void) {
1018 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1019 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1020 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1021 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1022 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1023 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1024 shared
.cnegone
= createObject(REDIS_STRING
,sdsnew(":-1\r\n"));
1025 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1026 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1027 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1028 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1029 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1030 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1031 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1032 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1033 "-ERR no such key\r\n"));
1034 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1035 "-ERR syntax error\r\n"));
1036 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1037 "-ERR source and destination objects are the same\r\n"));
1038 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1039 "-ERR index out of range\r\n"));
1040 shared
.noscripterr
= createObject(REDIS_STRING
,sdsnew(
1041 "-NOSCRIPT No matching script. Please use EVAL.\r\n"));
1042 shared
.loadingerr
= createObject(REDIS_STRING
,sdsnew(
1043 "-LOADING Redis is loading the dataset in memory\r\n"));
1044 shared
.slowscripterr
= createObject(REDIS_STRING
,sdsnew(
1045 "-BUSY Redis is busy running a script. You can only call SCRIPT KILL or SHUTDOWN NOSAVE.\r\n"));
1046 shared
.masterdownerr
= createObject(REDIS_STRING
,sdsnew(
1047 "-MASTERDOWN Link with MASTER is down and slave-serve-stale-data is set to 'no'.\r\n"));
1048 shared
.bgsaveerr
= createObject(REDIS_STRING
,sdsnew(
1049 "-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"));
1050 shared
.roslaveerr
= createObject(REDIS_STRING
,sdsnew(
1051 "-READONLY You can't write against a read only slave.\r\n"));
1052 shared
.oomerr
= createObject(REDIS_STRING
,sdsnew(
1053 "-OOM command not allowed when used memory > 'maxmemory'.\r\n"));
1054 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1055 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1056 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1058 for (j
= 0; j
< REDIS_SHARED_SELECT_CMDS
; j
++) {
1059 shared
.select
[j
] = createObject(REDIS_STRING
,
1060 sdscatprintf(sdsempty(),"select %d\r\n", j
));
1062 shared
.messagebulk
= createStringObject("$7\r\nmessage\r\n",13);
1063 shared
.pmessagebulk
= createStringObject("$8\r\npmessage\r\n",14);
1064 shared
.subscribebulk
= createStringObject("$9\r\nsubscribe\r\n",15);
1065 shared
.unsubscribebulk
= createStringObject("$11\r\nunsubscribe\r\n",18);
1066 shared
.psubscribebulk
= createStringObject("$10\r\npsubscribe\r\n",17);
1067 shared
.punsubscribebulk
= createStringObject("$12\r\npunsubscribe\r\n",19);
1068 shared
.del
= createStringObject("DEL",3);
1069 shared
.rpop
= createStringObject("RPOP",4);
1070 shared
.lpop
= createStringObject("LPOP",4);
1071 shared
.lpush
= createStringObject("LPUSH",5);
1072 for (j
= 0; j
< REDIS_SHARED_INTEGERS
; j
++) {
1073 shared
.integers
[j
] = createObject(REDIS_STRING
,(void*)(long)j
);
1074 shared
.integers
[j
]->encoding
= REDIS_ENCODING_INT
;
1076 for (j
= 0; j
< REDIS_SHARED_BULKHDR_LEN
; j
++) {
1077 shared
.mbulkhdr
[j
] = createObject(REDIS_STRING
,
1078 sdscatprintf(sdsempty(),"*%d\r\n",j
));
1079 shared
.bulkhdr
[j
] = createObject(REDIS_STRING
,
1080 sdscatprintf(sdsempty(),"$%d\r\n",j
));
1084 void initServerConfig() {
1085 getRandomHexChars(server
.runid
,REDIS_RUN_ID_SIZE
);
1086 server
.runid
[REDIS_RUN_ID_SIZE
] = '\0';
1087 server
.arch_bits
= (sizeof(long) == 8) ? 64 : 32;
1088 server
.port
= REDIS_SERVERPORT
;
1089 server
.bindaddr
= NULL
;
1090 server
.unixsocket
= NULL
;
1091 server
.unixsocketperm
= 0;
1094 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1095 server
.verbosity
= REDIS_NOTICE
;
1096 server
.maxidletime
= REDIS_MAXIDLETIME
;
1097 server
.client_max_querybuf_len
= REDIS_MAX_QUERYBUF_LEN
;
1098 server
.saveparams
= NULL
;
1100 server
.logfile
= NULL
; /* NULL = log on standard output */
1101 server
.syslog_enabled
= 0;
1102 server
.syslog_ident
= zstrdup("redis");
1103 server
.syslog_facility
= LOG_LOCAL0
;
1104 server
.daemonize
= 0;
1105 server
.aof_state
= REDIS_AOF_OFF
;
1106 server
.aof_fsync
= AOF_FSYNC_EVERYSEC
;
1107 server
.aof_no_fsync_on_rewrite
= 0;
1108 server
.aof_rewrite_perc
= REDIS_AOF_REWRITE_PERC
;
1109 server
.aof_rewrite_min_size
= REDIS_AOF_REWRITE_MIN_SIZE
;
1110 server
.aof_rewrite_base_size
= 0;
1111 server
.aof_rewrite_scheduled
= 0;
1112 server
.aof_last_fsync
= time(NULL
);
1113 server
.aof_rewrite_time_last
= -1;
1114 server
.aof_rewrite_time_start
= -1;
1115 server
.aof_lastbgrewrite_status
= REDIS_OK
;
1116 server
.aof_delayed_fsync
= 0;
1118 server
.aof_selected_db
= -1; /* Make sure the first time will not match */
1119 server
.aof_flush_postponed_start
= 0;
1120 server
.pidfile
= zstrdup("/var/run/redis.pid");
1121 server
.rdb_filename
= zstrdup("dump.rdb");
1122 server
.aof_filename
= zstrdup("appendonly.aof");
1123 server
.requirepass
= NULL
;
1124 server
.rdb_compression
= 1;
1125 server
.rdb_checksum
= 1;
1126 server
.activerehashing
= 1;
1127 server
.maxclients
= REDIS_MAX_CLIENTS
;
1128 server
.bpop_blocked_clients
= 0;
1129 server
.maxmemory
= 0;
1130 server
.maxmemory_policy
= REDIS_MAXMEMORY_VOLATILE_LRU
;
1131 server
.maxmemory_samples
= 3;
1132 server
.hash_max_ziplist_entries
= REDIS_HASH_MAX_ZIPLIST_ENTRIES
;
1133 server
.hash_max_ziplist_value
= REDIS_HASH_MAX_ZIPLIST_VALUE
;
1134 server
.list_max_ziplist_entries
= REDIS_LIST_MAX_ZIPLIST_ENTRIES
;
1135 server
.list_max_ziplist_value
= REDIS_LIST_MAX_ZIPLIST_VALUE
;
1136 server
.set_max_intset_entries
= REDIS_SET_MAX_INTSET_ENTRIES
;
1137 server
.zset_max_ziplist_entries
= REDIS_ZSET_MAX_ZIPLIST_ENTRIES
;
1138 server
.zset_max_ziplist_value
= REDIS_ZSET_MAX_ZIPLIST_VALUE
;
1139 server
.shutdown_asap
= 0;
1140 server
.repl_ping_slave_period
= REDIS_REPL_PING_SLAVE_PERIOD
;
1141 server
.repl_timeout
= REDIS_REPL_TIMEOUT
;
1142 server
.cluster_enabled
= 0;
1143 server
.cluster
.configfile
= zstrdup("nodes.conf");
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
;
1360 if (server
.cluster_enabled
) clusterInit();
1366 /* Populates the Redis Command Table starting from the hard coded list
1367 * we have on top of redis.c file. */
1368 void populateCommandTable(void) {
1370 int numcommands
= sizeof(redisCommandTable
)/sizeof(struct redisCommand
);
1372 for (j
= 0; j
< numcommands
; j
++) {
1373 struct redisCommand
*c
= redisCommandTable
+j
;
1374 char *f
= c
->sflags
;
1379 case 'w': c
->flags
|= REDIS_CMD_WRITE
; break;
1380 case 'r': c
->flags
|= REDIS_CMD_READONLY
; break;
1381 case 'm': c
->flags
|= REDIS_CMD_DENYOOM
; break;
1382 case 'a': c
->flags
|= REDIS_CMD_ADMIN
; break;
1383 case 'p': c
->flags
|= REDIS_CMD_PUBSUB
; break;
1384 case 'f': c
->flags
|= REDIS_CMD_FORCE_REPLICATION
; break;
1385 case 's': c
->flags
|= REDIS_CMD_NOSCRIPT
; break;
1386 case 'R': c
->flags
|= REDIS_CMD_RANDOM
; break;
1387 case 'S': c
->flags
|= REDIS_CMD_SORT_FOR_SCRIPT
; break;
1388 case 'l': c
->flags
|= REDIS_CMD_LOADING
; break;
1389 case 't': c
->flags
|= REDIS_CMD_STALE
; break;
1390 case 'M': c
->flags
|= REDIS_CMD_SKIP_MONITOR
; break;
1391 default: redisPanic("Unsupported command flag"); break;
1396 retval
= dictAdd(server
.commands
, sdsnew(c
->name
), c
);
1397 assert(retval
== DICT_OK
);
1401 void resetCommandTableStats(void) {
1402 int numcommands
= sizeof(redisCommandTable
)/sizeof(struct redisCommand
);
1405 for (j
= 0; j
< numcommands
; j
++) {
1406 struct redisCommand
*c
= redisCommandTable
+j
;
1408 c
->microseconds
= 0;
1413 /* ========================== Redis OP Array API ============================ */
1415 void redisOpArrayInit(redisOpArray
*oa
) {
1420 int redisOpArrayAppend(redisOpArray
*oa
, struct redisCommand
*cmd
, int dbid
,
1421 robj
**argv
, int argc
, int target
)
1425 oa
->ops
= zrealloc(oa
->ops
,sizeof(redisOp
)*(oa
->numops
+1));
1426 op
= oa
->ops
+oa
->numops
;
1431 op
->target
= target
;
1436 void redisOpArrayFree(redisOpArray
*oa
) {
1442 op
= oa
->ops
+oa
->numops
;
1443 for (j
= 0; j
< op
->argc
; j
++)
1444 decrRefCount(op
->argv
[j
]);
1450 /* ====================== Commands lookup and execution ===================== */
1452 struct redisCommand
*lookupCommand(sds name
) {
1453 return dictFetchValue(server
.commands
, name
);
1456 struct redisCommand
*lookupCommandByCString(char *s
) {
1457 struct redisCommand
*cmd
;
1458 sds name
= sdsnew(s
);
1460 cmd
= dictFetchValue(server
.commands
, name
);
1465 /* Propagate the specified command (in the context of the specified database id)
1466 * to AOF and Slaves.
1468 * flags are an xor between:
1469 * + REDIS_PROPAGATE_NONE (no propagation of command at all)
1470 * + REDIS_PROPAGATE_AOF (propagate into the AOF file if is enabled)
1471 * + REDIS_PROPAGATE_REPL (propagate into the replication link)
1473 void propagate(struct redisCommand
*cmd
, int dbid
, robj
**argv
, int argc
,
1476 if (server
.aof_state
!= REDIS_AOF_OFF
&& flags
& REDIS_PROPAGATE_AOF
)
1477 feedAppendOnlyFile(cmd
,dbid
,argv
,argc
);
1478 if (flags
& REDIS_PROPAGATE_REPL
&& listLength(server
.slaves
))
1479 replicationFeedSlaves(server
.slaves
,dbid
,argv
,argc
);
1482 /* Used inside commands to schedule the propagation of additional commands
1483 * after the current command is propagated to AOF / Replication. */
1484 void alsoPropagate(struct redisCommand
*cmd
, int dbid
, robj
**argv
, int argc
,
1487 redisOpArrayAppend(&server
.also_propagate
,cmd
,dbid
,argv
,argc
,target
);
1490 /* Call() is the core of Redis execution of a command */
1491 void call(redisClient
*c
, int flags
) {
1492 long long dirty
, start
= ustime(), duration
;
1494 /* Sent the command to clients in MONITOR mode, only if the commands are
1495 * not geneated from reading an AOF. */
1496 if (listLength(server
.monitors
) &&
1498 !(c
->cmd
->flags
& REDIS_CMD_SKIP_MONITOR
))
1500 replicationFeedMonitors(c
,server
.monitors
,c
->db
->id
,c
->argv
,c
->argc
);
1503 /* Call the command. */
1504 redisOpArrayInit(&server
.also_propagate
);
1505 dirty
= server
.dirty
;
1507 dirty
= server
.dirty
-dirty
;
1508 duration
= ustime()-start
;
1510 /* When EVAL is called loading the AOF we don't want commands called
1511 * from Lua to go into the slowlog or to populate statistics. */
1512 if (server
.loading
&& c
->flags
& REDIS_LUA_CLIENT
)
1513 flags
&= ~(REDIS_CALL_SLOWLOG
| REDIS_CALL_STATS
);
1515 /* Log the command into the Slow log if needed, and populate the
1516 * per-command statistics that we show in INFO commandstats. */
1517 if (flags
& REDIS_CALL_SLOWLOG
)
1518 slowlogPushEntryIfNeeded(c
->argv
,c
->argc
,duration
);
1519 if (flags
& REDIS_CALL_STATS
) {
1520 c
->cmd
->microseconds
+= duration
;
1524 /* Propagate the command into the AOF and replication link */
1525 if (flags
& REDIS_CALL_PROPAGATE
) {
1526 int flags
= REDIS_PROPAGATE_NONE
;
1528 if (c
->cmd
->flags
& REDIS_CMD_FORCE_REPLICATION
)
1529 flags
|= REDIS_PROPAGATE_REPL
;
1531 flags
|= (REDIS_PROPAGATE_REPL
| REDIS_PROPAGATE_AOF
);
1532 if (flags
!= REDIS_PROPAGATE_NONE
)
1533 propagate(c
->cmd
,c
->db
->id
,c
->argv
,c
->argc
,flags
);
1535 /* Commands such as LPUSH or BRPOPLPUSH may propagate an additional
1537 if (server
.also_propagate
.numops
) {
1541 for (j
= 0; j
< server
.also_propagate
.numops
; j
++) {
1542 rop
= &server
.also_propagate
.ops
[j
];
1543 propagate(rop
->cmd
, rop
->dbid
, rop
->argv
, rop
->argc
, rop
->target
);
1545 redisOpArrayFree(&server
.also_propagate
);
1547 server
.stat_numcommands
++;
1550 /* If this function gets called we already read a whole
1551 * command, argments are in the client argv/argc fields.
1552 * processCommand() execute the command or prepare the
1553 * server for a bulk read from the client.
1555 * If 1 is returned the client is still alive and valid and
1556 * and other operations can be performed by the caller. Otherwise
1557 * if 0 is returned the client was destroied (i.e. after QUIT). */
1558 int processCommand(redisClient
*c
) {
1559 /* The QUIT command is handled separately. Normal command procs will
1560 * go through checking for replication and QUIT will cause trouble
1561 * when FORCE_REPLICATION is enabled and would be implemented in
1562 * a regular command proc. */
1563 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
1564 addReply(c
,shared
.ok
);
1565 c
->flags
|= REDIS_CLOSE_AFTER_REPLY
;
1569 /* Now lookup the command and check ASAP about trivial error conditions
1570 * such as wrong arity, bad command name and so forth. */
1571 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
)) {
1578 addReplyErrorFormat(c
,"wrong number of arguments for '%s' command",
1583 /* Check if the user is authenticated */
1584 if (server
.requirepass
&& !c
->authenticated
&& c
->cmd
->proc
!= authCommand
)
1586 addReplyError(c
,"operation not permitted");
1590 /* If cluster is enabled, redirect here */
1591 if (server
.cluster_enabled
&&
1592 !(c
->cmd
->getkeys_proc
== NULL
&& c
->cmd
->firstkey
== 0)) {
1595 if (server
.cluster
.state
!= REDIS_CLUSTER_OK
) {
1596 addReplyError(c
,"The cluster is down. Check with CLUSTER INFO for more information");
1600 clusterNode
*n
= getNodeByQuery(c
,c
->cmd
,c
->argv
,c
->argc
,&hashslot
,&ask
);
1602 addReplyError(c
,"Multi keys request invalid in cluster");
1604 } else if (n
!= server
.cluster
.myself
) {
1605 addReplySds(c
,sdscatprintf(sdsempty(),
1606 "-%s %d %s:%d\r\n", ask
? "ASK" : "MOVED",
1607 hashslot
,n
->ip
,n
->port
));
1613 /* Handle the maxmemory directive.
1615 * First we try to free some memory if possible (if there are volatile
1616 * keys in the dataset). If there are not the only thing we can do
1617 * is returning an error. */
1618 if (server
.maxmemory
) {
1619 int retval
= freeMemoryIfNeeded();
1620 if ((c
->cmd
->flags
& REDIS_CMD_DENYOOM
) && retval
== REDIS_ERR
) {
1621 addReply(c
, shared
.oomerr
);
1626 /* Don't accept write commands if there are problems persisting on disk. */
1627 if (server
.stop_writes_on_bgsave_err
&&
1628 server
.saveparamslen
> 0
1629 && server
.lastbgsave_status
== REDIS_ERR
&&
1630 c
->cmd
->flags
& REDIS_CMD_WRITE
)
1632 addReply(c
, shared
.bgsaveerr
);
1636 /* Don't accept write commands if this is a read only slave. But
1637 * accept write commands if this is our master. */
1638 if (server
.masterhost
&& server
.repl_slave_ro
&&
1639 !(c
->flags
& REDIS_MASTER
) &&
1640 c
->cmd
->flags
& REDIS_CMD_WRITE
)
1642 addReply(c
, shared
.roslaveerr
);
1646 /* Only allow SUBSCRIBE and UNSUBSCRIBE in the context of Pub/Sub */
1647 if ((dictSize(c
->pubsub_channels
) > 0 || listLength(c
->pubsub_patterns
) > 0)
1649 c
->cmd
->proc
!= subscribeCommand
&&
1650 c
->cmd
->proc
!= unsubscribeCommand
&&
1651 c
->cmd
->proc
!= psubscribeCommand
&&
1652 c
->cmd
->proc
!= punsubscribeCommand
) {
1653 addReplyError(c
,"only (P)SUBSCRIBE / (P)UNSUBSCRIBE / QUIT allowed in this context");
1657 /* Only allow INFO and SLAVEOF when slave-serve-stale-data is no and
1658 * we are a slave with a broken link with master. */
1659 if (server
.masterhost
&& server
.repl_state
!= REDIS_REPL_CONNECTED
&&
1660 server
.repl_serve_stale_data
== 0 &&
1661 !(c
->cmd
->flags
& REDIS_CMD_STALE
))
1663 addReply(c
, shared
.masterdownerr
);
1667 /* Loading DB? Return an error if the command has not the
1668 * REDIS_CMD_LOADING flag. */
1669 if (server
.loading
&& !(c
->cmd
->flags
& REDIS_CMD_LOADING
)) {
1670 addReply(c
, shared
.loadingerr
);
1674 /* Lua script too slow? Only allow commands with REDIS_CMD_STALE flag. */
1675 if (server
.lua_timedout
&&
1676 c
->cmd
->proc
!= authCommand
&&
1677 !(c
->cmd
->proc
== shutdownCommand
&&
1679 tolower(((char*)c
->argv
[1]->ptr
)[0]) == 'n') &&
1680 !(c
->cmd
->proc
== scriptCommand
&&
1682 tolower(((char*)c
->argv
[1]->ptr
)[0]) == 'k'))
1684 addReply(c
, shared
.slowscripterr
);
1688 /* Exec the command */
1689 if (c
->flags
& REDIS_MULTI
&&
1690 c
->cmd
->proc
!= execCommand
&& c
->cmd
->proc
!= discardCommand
&&
1691 c
->cmd
->proc
!= multiCommand
&& c
->cmd
->proc
!= watchCommand
)
1693 queueMultiCommand(c
);
1694 addReply(c
,shared
.queued
);
1696 call(c
,REDIS_CALL_FULL
);
1697 if (listLength(server
.ready_keys
))
1698 handleClientsBlockedOnLists();
1703 /*================================== Shutdown =============================== */
1705 int prepareForShutdown(int flags
) {
1706 int save
= flags
& REDIS_SHUTDOWN_SAVE
;
1707 int nosave
= flags
& REDIS_SHUTDOWN_NOSAVE
;
1709 redisLog(REDIS_WARNING
,"User requested shutdown...");
1710 /* Kill the saving child if there is a background saving in progress.
1711 We want to avoid race conditions, for instance our saving child may
1712 overwrite the synchronous saving did by SHUTDOWN. */
1713 if (server
.rdb_child_pid
!= -1) {
1714 redisLog(REDIS_WARNING
,"There is a child saving an .rdb. Killing it!");
1715 kill(server
.rdb_child_pid
,SIGKILL
);
1716 rdbRemoveTempFile(server
.rdb_child_pid
);
1718 if (server
.aof_state
!= REDIS_AOF_OFF
) {
1719 /* Kill the AOF saving child as the AOF we already have may be longer
1720 * but contains the full dataset anyway. */
1721 if (server
.aof_child_pid
!= -1) {
1722 redisLog(REDIS_WARNING
,
1723 "There is a child rewriting the AOF. Killing it!");
1724 kill(server
.aof_child_pid
,SIGKILL
);
1726 /* Append only file: fsync() the AOF and exit */
1727 redisLog(REDIS_NOTICE
,"Calling fsync() on the AOF file.");
1728 aof_fsync(server
.aof_fd
);
1730 if ((server
.saveparamslen
> 0 && !nosave
) || save
) {
1731 redisLog(REDIS_NOTICE
,"Saving the final RDB snapshot before exiting.");
1732 /* Snapshotting. Perform a SYNC SAVE and exit */
1733 if (rdbSave(server
.rdb_filename
) != REDIS_OK
) {
1734 /* Ooops.. error saving! The best we can do is to continue
1735 * operating. Note that if there was a background saving process,
1736 * in the next cron() Redis will be notified that the background
1737 * saving aborted, handling special stuff like slaves pending for
1738 * synchronization... */
1739 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit.");
1743 if (server
.daemonize
) {
1744 redisLog(REDIS_NOTICE
,"Removing the pid file.");
1745 unlink(server
.pidfile
);
1747 /* Close the listening sockets. Apparently this allows faster restarts. */
1748 if (server
.ipfd
!= -1) close(server
.ipfd
);
1749 if (server
.sofd
!= -1) close(server
.sofd
);
1750 if (server
.unixsocket
) {
1751 redisLog(REDIS_NOTICE
,"Removing the unix socket file.");
1752 unlink(server
.unixsocket
); /* don't care if this fails */
1755 redisLog(REDIS_WARNING
,"Redis is now ready to exit, bye bye...");
1759 /*================================== Commands =============================== */
1761 /* Return zero if strings are the same, non-zero if they are not.
1762 * The comparison is performed in a way that prevents an attacker to obtain
1763 * information about the nature of the strings just monitoring the execution
1764 * time of the function.
1766 * Note that limiting the comparison length to strings up to 512 bytes we
1767 * can avoid leaking any information about the password length and any
1768 * possible branch misprediction related leak.
1770 int time_independent_strcmp(char *a
, char *b
) {
1771 char bufa
[REDIS_AUTHPASS_MAX_LEN
], bufb
[REDIS_AUTHPASS_MAX_LEN
];
1772 /* The above two strlen perform len(a) + len(b) operations where either
1773 * a or b are fixed (our password) length, and the difference is only
1774 * relative to the length of the user provided string, so no information
1775 * leak is possible in the following two lines of code. */
1776 int alen
= strlen(a
);
1777 int blen
= strlen(b
);
1781 /* We can't compare strings longer than our static buffers.
1782 * Note that this will never pass the first test in practical circumstances
1783 * so there is no info leak. */
1784 if (alen
> sizeof(bufa
) || blen
> sizeof(bufb
)) return 1;
1786 memset(bufa
,0,sizeof(bufa
)); /* Constant time. */
1787 memset(bufb
,0,sizeof(bufb
)); /* Constant time. */
1788 /* Again the time of the following two copies is proportional to
1789 * len(a) + len(b) so no info is leaked. */
1790 memcpy(bufa
,a
,alen
);
1791 memcpy(bufb
,b
,blen
);
1793 /* Always compare all the chars in the two buffers without
1794 * conditional expressions. */
1795 for (j
= 0; j
< sizeof(bufa
); j
++) {
1796 diff
|= (bufa
[j
] ^ bufb
[j
]);
1798 /* Length must be equal as well. */
1799 diff
|= alen
^ blen
;
1800 return diff
; /* If zero strings are the same. */
1803 void authCommand(redisClient
*c
) {
1804 if (!server
.requirepass
) {
1805 addReplyError(c
,"Client sent AUTH, but no password is set");
1806 } else if (!time_independent_strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
1807 c
->authenticated
= 1;
1808 addReply(c
,shared
.ok
);
1810 c
->authenticated
= 0;
1811 addReplyError(c
,"invalid password");
1815 void pingCommand(redisClient
*c
) {
1816 addReply(c
,shared
.pong
);
1819 void echoCommand(redisClient
*c
) {
1820 addReplyBulk(c
,c
->argv
[1]);
1823 void timeCommand(redisClient
*c
) {
1826 /* gettimeofday() can only fail if &tv is a bad addresss so we
1827 * don't check for errors. */
1828 gettimeofday(&tv
,NULL
);
1829 addReplyMultiBulkLen(c
,2);
1830 addReplyBulkLongLong(c
,tv
.tv_sec
);
1831 addReplyBulkLongLong(c
,tv
.tv_usec
);
1834 /* Convert an amount of bytes into a human readable string in the form
1835 * of 100B, 2G, 100M, 4K, and so forth. */
1836 void bytesToHuman(char *s
, unsigned long long n
) {
1841 sprintf(s
,"%lluB",n
);
1843 } else if (n
< (1024*1024)) {
1844 d
= (double)n
/(1024);
1845 sprintf(s
,"%.2fK",d
);
1846 } else if (n
< (1024LL*1024*1024)) {
1847 d
= (double)n
/(1024*1024);
1848 sprintf(s
,"%.2fM",d
);
1849 } else if (n
< (1024LL*1024*1024*1024)) {
1850 d
= (double)n
/(1024LL*1024*1024);
1851 sprintf(s
,"%.2fG",d
);
1855 /* Create the string returned by the INFO command. This is decoupled
1856 * by the INFO command itself as we need to report the same information
1857 * on memory corruption problems. */
1858 sds
genRedisInfoString(char *section
) {
1859 sds info
= sdsempty();
1860 time_t uptime
= server
.unixtime
-server
.stat_starttime
;
1862 struct rusage self_ru
, c_ru
;
1863 unsigned long lol
, bib
;
1864 int allsections
= 0, defsections
= 0;
1868 allsections
= strcasecmp(section
,"all") == 0;
1869 defsections
= strcasecmp(section
,"default") == 0;
1872 getrusage(RUSAGE_SELF
, &self_ru
);
1873 getrusage(RUSAGE_CHILDREN
, &c_ru
);
1874 getClientsMaxBuffers(&lol
,&bib
);
1877 if (allsections
|| defsections
|| !strcasecmp(section
,"server")) {
1878 struct utsname name
;
1881 if (server
.cluster_enabled
) mode
= "cluster";
1882 else if (server
.sentinel_mode
) mode
= "sentinel";
1883 else mode
= "standalone";
1885 if (sections
++) info
= sdscat(info
,"\r\n");
1887 info
= sdscatprintf(info
,
1889 "redis_version:%s\r\n"
1890 "redis_git_sha1:%s\r\n"
1891 "redis_git_dirty:%d\r\n"
1895 "multiplexing_api:%s\r\n"
1896 "gcc_version:%d.%d.%d\r\n"
1897 "process_id:%ld\r\n"
1900 "uptime_in_seconds:%ld\r\n"
1901 "uptime_in_days:%ld\r\n"
1902 "lru_clock:%ld\r\n",
1905 strtol(redisGitDirty(),NULL
,10) > 0,
1907 name
.sysname
, name
.release
, name
.machine
,
1911 __GNUC__
,__GNUC_MINOR__
,__GNUC_PATCHLEVEL__
,
1920 (unsigned long) server
.lruclock
);
1924 if (allsections
|| defsections
|| !strcasecmp(section
,"clients")) {
1925 if (sections
++) info
= sdscat(info
,"\r\n");
1926 info
= sdscatprintf(info
,
1928 "connected_clients:%lu\r\n"
1929 "client_longest_output_list:%lu\r\n"
1930 "client_biggest_input_buf:%lu\r\n"
1931 "blocked_clients:%d\r\n",
1932 listLength(server
.clients
)-listLength(server
.slaves
),
1934 server
.bpop_blocked_clients
);
1938 if (allsections
|| defsections
|| !strcasecmp(section
,"memory")) {
1942 bytesToHuman(hmem
,zmalloc_used_memory());
1943 bytesToHuman(peak_hmem
,server
.stat_peak_memory
);
1944 if (sections
++) info
= sdscat(info
,"\r\n");
1945 info
= sdscatprintf(info
,
1947 "used_memory:%zu\r\n"
1948 "used_memory_human:%s\r\n"
1949 "used_memory_rss:%zu\r\n"
1950 "used_memory_peak:%zu\r\n"
1951 "used_memory_peak_human:%s\r\n"
1952 "used_memory_lua:%lld\r\n"
1953 "mem_fragmentation_ratio:%.2f\r\n"
1954 "mem_allocator:%s\r\n",
1955 zmalloc_used_memory(),
1958 server
.stat_peak_memory
,
1960 ((long long)lua_gc(server
.lua
,LUA_GCCOUNT
,0))*1024LL,
1961 zmalloc_get_fragmentation_ratio(),
1967 if (allsections
|| defsections
|| !strcasecmp(section
,"persistence")) {
1968 if (sections
++) info
= sdscat(info
,"\r\n");
1969 info
= sdscatprintf(info
,
1972 "rdb_changes_since_last_save:%lld\r\n"
1973 "rdb_bgsave_in_progress:%d\r\n"
1974 "rdb_last_save_time:%ld\r\n"
1975 "rdb_last_bgsave_status:%s\r\n"
1976 "rdb_last_bgsave_time_sec:%ld\r\n"
1977 "rdb_current_bgsave_time_sec:%ld\r\n"
1978 "aof_enabled:%d\r\n"
1979 "aof_rewrite_in_progress:%d\r\n"
1980 "aof_rewrite_scheduled:%d\r\n"
1981 "aof_last_rewrite_time_sec:%ld\r\n"
1982 "aof_current_rewrite_time_sec:%ld\r\n"
1983 "aof_last_bgrewrite_status:%s\r\n",
1986 server
.rdb_child_pid
!= -1,
1988 (server
.lastbgsave_status
== REDIS_OK
) ? "ok" : "err",
1989 server
.rdb_save_time_last
,
1990 (server
.rdb_child_pid
== -1) ?
1991 -1 : time(NULL
)-server
.rdb_save_time_start
,
1992 server
.aof_state
!= REDIS_AOF_OFF
,
1993 server
.aof_child_pid
!= -1,
1994 server
.aof_rewrite_scheduled
,
1995 server
.aof_rewrite_time_last
,
1996 (server
.aof_child_pid
== -1) ?
1997 -1 : time(NULL
)-server
.aof_rewrite_time_start
,
1998 (server
.aof_lastbgrewrite_status
== REDIS_OK
) ? "ok" : "err");
2000 if (server
.aof_state
!= REDIS_AOF_OFF
) {
2001 info
= sdscatprintf(info
,
2002 "aof_current_size:%lld\r\n"
2003 "aof_base_size:%lld\r\n"
2004 "aof_pending_rewrite:%d\r\n"
2005 "aof_buffer_length:%zu\r\n"
2006 "aof_rewrite_buffer_length:%lu\r\n"
2007 "aof_pending_bio_fsync:%llu\r\n"
2008 "aof_delayed_fsync:%lu\r\n",
2009 (long long) server
.aof_current_size
,
2010 (long long) server
.aof_rewrite_base_size
,
2011 server
.aof_rewrite_scheduled
,
2012 sdslen(server
.aof_buf
),
2013 aofRewriteBufferSize(),
2014 bioPendingJobsOfType(REDIS_BIO_AOF_FSYNC
),
2015 server
.aof_delayed_fsync
);
2018 if (server
.loading
) {
2020 time_t eta
, elapsed
;
2021 off_t remaining_bytes
= server
.loading_total_bytes
-
2022 server
.loading_loaded_bytes
;
2024 perc
= ((double)server
.loading_loaded_bytes
/
2025 server
.loading_total_bytes
) * 100;
2027 elapsed
= server
.unixtime
-server
.loading_start_time
;
2029 eta
= 1; /* A fake 1 second figure if we don't have
2032 eta
= (elapsed
*remaining_bytes
)/server
.loading_loaded_bytes
;
2035 info
= sdscatprintf(info
,
2036 "loading_start_time:%ld\r\n"
2037 "loading_total_bytes:%llu\r\n"
2038 "loading_loaded_bytes:%llu\r\n"
2039 "loading_loaded_perc:%.2f\r\n"
2040 "loading_eta_seconds:%ld\r\n"
2041 ,(unsigned long) server
.loading_start_time
,
2042 (unsigned long long) server
.loading_total_bytes
,
2043 (unsigned long long) server
.loading_loaded_bytes
,
2051 if (allsections
|| defsections
|| !strcasecmp(section
,"stats")) {
2052 if (sections
++) info
= sdscat(info
,"\r\n");
2053 info
= sdscatprintf(info
,
2055 "total_connections_received:%lld\r\n"
2056 "total_commands_processed:%lld\r\n"
2057 "instantaneous_ops_per_sec:%lld\r\n"
2058 "rejected_connections:%lld\r\n"
2059 "expired_keys:%lld\r\n"
2060 "evicted_keys:%lld\r\n"
2061 "keyspace_hits:%lld\r\n"
2062 "keyspace_misses:%lld\r\n"
2063 "pubsub_channels:%ld\r\n"
2064 "pubsub_patterns:%lu\r\n"
2065 "latest_fork_usec:%lld\r\n",
2066 server
.stat_numconnections
,
2067 server
.stat_numcommands
,
2068 getOperationsPerSecond(),
2069 server
.stat_rejected_conn
,
2070 server
.stat_expiredkeys
,
2071 server
.stat_evictedkeys
,
2072 server
.stat_keyspace_hits
,
2073 server
.stat_keyspace_misses
,
2074 dictSize(server
.pubsub_channels
),
2075 listLength(server
.pubsub_patterns
),
2076 server
.stat_fork_time
);
2080 if (allsections
|| defsections
|| !strcasecmp(section
,"replication")) {
2081 if (sections
++) info
= sdscat(info
,"\r\n");
2082 info
= sdscatprintf(info
,
2085 server
.masterhost
== NULL
? "master" : "slave");
2086 if (server
.masterhost
) {
2087 info
= sdscatprintf(info
,
2088 "master_host:%s\r\n"
2089 "master_port:%d\r\n"
2090 "master_link_status:%s\r\n"
2091 "master_last_io_seconds_ago:%d\r\n"
2092 "master_sync_in_progress:%d\r\n"
2095 (server
.repl_state
== REDIS_REPL_CONNECTED
) ?
2098 ((int)(server
.unixtime
-server
.master
->lastinteraction
)) : -1,
2099 server
.repl_state
== REDIS_REPL_TRANSFER
2102 if (server
.repl_state
== REDIS_REPL_TRANSFER
) {
2103 info
= sdscatprintf(info
,
2104 "master_sync_left_bytes:%lld\r\n"
2105 "master_sync_last_io_seconds_ago:%d\r\n"
2107 (server
.repl_transfer_size
- server
.repl_transfer_read
),
2108 (int)(server
.unixtime
-server
.repl_transfer_lastio
)
2112 if (server
.repl_state
!= REDIS_REPL_CONNECTED
) {
2113 info
= sdscatprintf(info
,
2114 "master_link_down_since_seconds:%ld\r\n",
2115 (long)server
.unixtime
-server
.repl_down_since
);
2117 info
= sdscatprintf(info
,
2118 "slave_priority:%d\r\n"
2119 "slave_read_only:%d\r\n",
2120 server
.slave_priority
,
2121 server
.repl_slave_ro
);
2123 info
= sdscatprintf(info
,
2124 "connected_slaves:%lu\r\n",
2125 listLength(server
.slaves
));
2126 if (listLength(server
.slaves
)) {
2131 listRewind(server
.slaves
,&li
);
2132 while((ln
= listNext(&li
))) {
2133 redisClient
*slave
= listNodeValue(ln
);
2138 if (anetPeerToString(slave
->fd
,ip
,&port
) == -1) continue;
2139 switch(slave
->replstate
) {
2140 case REDIS_REPL_WAIT_BGSAVE_START
:
2141 case REDIS_REPL_WAIT_BGSAVE_END
:
2142 state
= "wait_bgsave";
2144 case REDIS_REPL_SEND_BULK
:
2145 state
= "send_bulk";
2147 case REDIS_REPL_ONLINE
:
2151 if (state
== NULL
) continue;
2152 info
= sdscatprintf(info
,"slave%d:%s,%d,%s\r\n",
2153 slaveid
,ip
,slave
->slave_listening_port
,state
);
2160 if (allsections
|| defsections
|| !strcasecmp(section
,"cpu")) {
2161 if (sections
++) info
= sdscat(info
,"\r\n");
2162 info
= sdscatprintf(info
,
2164 "used_cpu_sys:%.2f\r\n"
2165 "used_cpu_user:%.2f\r\n"
2166 "used_cpu_sys_children:%.2f\r\n"
2167 "used_cpu_user_children:%.2f\r\n",
2168 (float)self_ru
.ru_stime
.tv_sec
+(float)self_ru
.ru_stime
.tv_usec
/1000000,
2169 (float)self_ru
.ru_utime
.tv_sec
+(float)self_ru
.ru_utime
.tv_usec
/1000000,
2170 (float)c_ru
.ru_stime
.tv_sec
+(float)c_ru
.ru_stime
.tv_usec
/1000000,
2171 (float)c_ru
.ru_utime
.tv_sec
+(float)c_ru
.ru_utime
.tv_usec
/1000000);
2175 if (allsections
|| !strcasecmp(section
,"commandstats")) {
2176 if (sections
++) info
= sdscat(info
,"\r\n");
2177 info
= sdscatprintf(info
, "# Commandstats\r\n");
2178 numcommands
= sizeof(redisCommandTable
)/sizeof(struct redisCommand
);
2179 for (j
= 0; j
< numcommands
; j
++) {
2180 struct redisCommand
*c
= redisCommandTable
+j
;
2182 if (!c
->calls
) continue;
2183 info
= sdscatprintf(info
,
2184 "cmdstat_%s:calls=%lld,usec=%lld,usec_per_call=%.2f\r\n",
2185 c
->name
, c
->calls
, c
->microseconds
,
2186 (c
->calls
== 0) ? 0 : ((float)c
->microseconds
/c
->calls
));
2191 if (allsections
|| defsections
|| !strcasecmp(section
,"cluster")) {
2192 if (sections
++) info
= sdscat(info
,"\r\n");
2193 info
= sdscatprintf(info
,
2195 "cluster_enabled:%d\r\n",
2196 server
.cluster_enabled
);
2200 if (allsections
|| defsections
|| !strcasecmp(section
,"keyspace")) {
2201 if (sections
++) info
= sdscat(info
,"\r\n");
2202 info
= sdscatprintf(info
, "# Keyspace\r\n");
2203 for (j
= 0; j
< server
.dbnum
; j
++) {
2204 long long keys
, vkeys
;
2206 keys
= dictSize(server
.db
[j
].dict
);
2207 vkeys
= dictSize(server
.db
[j
].expires
);
2208 if (keys
|| vkeys
) {
2209 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
2217 void infoCommand(redisClient
*c
) {
2218 char *section
= c
->argc
== 2 ? c
->argv
[1]->ptr
: "default";
2221 addReply(c
,shared
.syntaxerr
);
2224 sds info
= genRedisInfoString(section
);
2225 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
2226 (unsigned long)sdslen(info
)));
2227 addReplySds(c
,info
);
2228 addReply(c
,shared
.crlf
);
2231 void monitorCommand(redisClient
*c
) {
2232 /* ignore MONITOR if aleady slave or in monitor mode */
2233 if (c
->flags
& REDIS_SLAVE
) return;
2235 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
2237 listAddNodeTail(server
.monitors
,c
);
2238 addReply(c
,shared
.ok
);
2241 /* ============================ Maxmemory directive ======================== */
2243 /* This function gets called when 'maxmemory' is set on the config file to limit
2244 * the max memory used by the server, before processing a command.
2246 * The goal of the function is to free enough memory to keep Redis under the
2247 * configured memory limit.
2249 * The function starts calculating how many bytes should be freed to keep
2250 * Redis under the limit, and enters a loop selecting the best keys to
2251 * evict accordingly to the configured policy.
2253 * If all the bytes needed to return back under the limit were freed the
2254 * function returns REDIS_OK, otherwise REDIS_ERR is returned, and the caller
2255 * should block the execution of commands that will result in more memory
2256 * used by the server.
2258 int freeMemoryIfNeeded(void) {
2259 size_t mem_used
, mem_tofree
, mem_freed
;
2260 int slaves
= listLength(server
.slaves
);
2262 /* Remove the size of slaves output buffers and AOF buffer from the
2263 * count of used memory. */
2264 mem_used
= zmalloc_used_memory();
2269 listRewind(server
.slaves
,&li
);
2270 while((ln
= listNext(&li
))) {
2271 redisClient
*slave
= listNodeValue(ln
);
2272 unsigned long obuf_bytes
= getClientOutputBufferMemoryUsage(slave
);
2273 if (obuf_bytes
> mem_used
)
2276 mem_used
-= obuf_bytes
;
2279 if (server
.aof_state
!= REDIS_AOF_OFF
) {
2280 mem_used
-= sdslen(server
.aof_buf
);
2281 mem_used
-= aofRewriteBufferSize();
2284 /* Check if we are over the memory limit. */
2285 if (mem_used
<= server
.maxmemory
) return REDIS_OK
;
2287 if (server
.maxmemory_policy
== REDIS_MAXMEMORY_NO_EVICTION
)
2288 return REDIS_ERR
; /* We need to free memory, but policy forbids. */
2290 /* Compute how much memory we need to free. */
2291 mem_tofree
= mem_used
- server
.maxmemory
;
2293 while (mem_freed
< mem_tofree
) {
2294 int j
, k
, keys_freed
= 0;
2296 for (j
= 0; j
< server
.dbnum
; j
++) {
2297 long bestval
= 0; /* just to prevent warning */
2299 struct dictEntry
*de
;
2300 redisDb
*db
= server
.db
+j
;
2303 if (server
.maxmemory_policy
== REDIS_MAXMEMORY_ALLKEYS_LRU
||
2304 server
.maxmemory_policy
== REDIS_MAXMEMORY_ALLKEYS_RANDOM
)
2306 dict
= server
.db
[j
].dict
;
2308 dict
= server
.db
[j
].expires
;
2310 if (dictSize(dict
) == 0) continue;
2312 /* volatile-random and allkeys-random policy */
2313 if (server
.maxmemory_policy
== REDIS_MAXMEMORY_ALLKEYS_RANDOM
||
2314 server
.maxmemory_policy
== REDIS_MAXMEMORY_VOLATILE_RANDOM
)
2316 de
= dictGetRandomKey(dict
);
2317 bestkey
= dictGetKey(de
);
2320 /* volatile-lru and allkeys-lru policy */
2321 else if (server
.maxmemory_policy
== REDIS_MAXMEMORY_ALLKEYS_LRU
||
2322 server
.maxmemory_policy
== REDIS_MAXMEMORY_VOLATILE_LRU
)
2324 for (k
= 0; k
< server
.maxmemory_samples
; k
++) {
2329 de
= dictGetRandomKey(dict
);
2330 thiskey
= dictGetKey(de
);
2331 /* When policy is volatile-lru we need an additonal lookup
2332 * to locate the real key, as dict is set to db->expires. */
2333 if (server
.maxmemory_policy
== REDIS_MAXMEMORY_VOLATILE_LRU
)
2334 de
= dictFind(db
->dict
, thiskey
);
2336 thisval
= estimateObjectIdleTime(o
);
2338 /* Higher idle time is better candidate for deletion */
2339 if (bestkey
== NULL
|| thisval
> bestval
) {
2347 else if (server
.maxmemory_policy
== REDIS_MAXMEMORY_VOLATILE_TTL
) {
2348 for (k
= 0; k
< server
.maxmemory_samples
; k
++) {
2352 de
= dictGetRandomKey(dict
);
2353 thiskey
= dictGetKey(de
);
2354 thisval
= (long) dictGetVal(de
);
2356 /* Expire sooner (minor expire unix timestamp) is better
2357 * candidate for deletion */
2358 if (bestkey
== NULL
|| thisval
< bestval
) {
2365 /* Finally remove the selected key. */
2369 robj
*keyobj
= createStringObject(bestkey
,sdslen(bestkey
));
2370 propagateExpire(db
,keyobj
);
2371 /* We compute the amount of memory freed by dbDelete() alone.
2372 * It is possible that actually the memory needed to propagate
2373 * the DEL in AOF and replication link is greater than the one
2374 * we are freeing removing the key, but we can't account for
2375 * that otherwise we would never exit the loop.
2377 * AOF and Output buffer memory will be freed eventually so
2378 * we only care about memory used by the key space. */
2379 delta
= (long long) zmalloc_used_memory();
2380 dbDelete(db
,keyobj
);
2381 delta
-= (long long) zmalloc_used_memory();
2383 server
.stat_evictedkeys
++;
2384 decrRefCount(keyobj
);
2387 /* When the memory to free starts to be big enough, we may
2388 * start spending so much time here that is impossible to
2389 * deliver data to the slaves fast enough, so we force the
2390 * transmission here inside the loop. */
2391 if (slaves
) flushSlavesOutputBuffers();
2394 if (!keys_freed
) return REDIS_ERR
; /* nothing to free... */
2399 /* =================================== Main! ================================ */
2402 int linuxOvercommitMemoryValue(void) {
2403 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
2407 if (fgets(buf
,64,fp
) == NULL
) {
2416 void linuxOvercommitMemoryWarning(void) {
2417 if (linuxOvercommitMemoryValue() == 0) {
2418 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.");
2421 #endif /* __linux__ */
2423 void createPidFile(void) {
2424 /* Try to write the pid file in a best-effort way. */
2425 FILE *fp
= fopen(server
.pidfile
,"w");
2427 fprintf(fp
,"%d\n",(int)getpid());
2432 void daemonize(void) {
2435 if (fork() != 0) exit(0); /* parent exits */
2436 setsid(); /* create a new session */
2438 /* Every output goes to /dev/null. If Redis is daemonized but
2439 * the 'logfile' is set to 'stdout' in the configuration file
2440 * it will not log at all. */
2441 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
2442 dup2(fd
, STDIN_FILENO
);
2443 dup2(fd
, STDOUT_FILENO
);
2444 dup2(fd
, STDERR_FILENO
);
2445 if (fd
> STDERR_FILENO
) close(fd
);
2450 printf("Redis server v=%s sha=%s:%d malloc=%s bits=%d\n",
2453 atoi(redisGitDirty()) > 0,
2455 sizeof(long) == 4 ? 32 : 64);
2460 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf] [options]\n");
2461 fprintf(stderr
," ./redis-server - (read config from stdin)\n");
2462 fprintf(stderr
," ./redis-server -v or --version\n");
2463 fprintf(stderr
," ./redis-server -h or --help\n");
2464 fprintf(stderr
," ./redis-server --test-memory <megabytes>\n\n");
2465 fprintf(stderr
,"Examples:\n");
2466 fprintf(stderr
," ./redis-server (run the server with default conf)\n");
2467 fprintf(stderr
," ./redis-server /etc/redis/6379.conf\n");
2468 fprintf(stderr
," ./redis-server --port 7777\n");
2469 fprintf(stderr
," ./redis-server --port 7777 --slaveof 127.0.0.1 8888\n");
2470 fprintf(stderr
," ./redis-server /etc/myredis.conf --loglevel verbose\n\n");
2471 fprintf(stderr
,"Sentinel mode:\n");
2472 fprintf(stderr
," ./redis-server /etc/sentinel.conf --sentinel\n");
2476 void redisAsciiArt(void) {
2477 #include "asciilogo.h"
2478 char *buf
= zmalloc(1024*16);
2479 char *mode
= "stand alone";
2481 if (server
.cluster_enabled
) mode
= "cluster";
2482 else if (server
.sentinel_mode
) mode
= "sentinel";
2484 snprintf(buf
,1024*16,ascii_logo
,
2487 strtol(redisGitDirty(),NULL
,10) > 0,
2488 (sizeof(long) == 8) ? "64" : "32",
2492 redisLogRaw(REDIS_NOTICE
|REDIS_LOG_RAW
,buf
);
2496 static void sigtermHandler(int sig
) {
2499 redisLogFromHandler(REDIS_WARNING
,"Received SIGTERM, scheduling shutdown...");
2500 server
.shutdown_asap
= 1;
2503 void setupSignalHandlers(void) {
2504 struct sigaction act
;
2506 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction is used.
2507 * Otherwise, sa_handler is used. */
2508 sigemptyset(&act
.sa_mask
);
2510 act
.sa_handler
= sigtermHandler
;
2511 sigaction(SIGTERM
, &act
, NULL
);
2513 #ifdef HAVE_BACKTRACE
2514 sigemptyset(&act
.sa_mask
);
2515 act
.sa_flags
= SA_NODEFER
| SA_RESETHAND
| SA_SIGINFO
;
2516 act
.sa_sigaction
= sigsegvHandler
;
2517 sigaction(SIGSEGV
, &act
, NULL
);
2518 sigaction(SIGBUS
, &act
, NULL
);
2519 sigaction(SIGFPE
, &act
, NULL
);
2520 sigaction(SIGILL
, &act
, NULL
);
2525 void memtest(size_t megabytes
, int passes
);
2527 /* Returns 1 if there is --sentinel among the arguments or if
2528 * argv[0] is exactly "redis-sentinel". */
2529 int checkForSentinelMode(int argc
, char **argv
) {
2532 if (strstr(argv
[0],"redis-sentinel") != NULL
) return 1;
2533 for (j
= 1; j
< argc
; j
++)
2534 if (!strcmp(argv
[j
],"--sentinel")) return 1;
2538 /* Function called at startup to load RDB or AOF file in memory. */
2539 void loadDataFromDisk(void) {
2540 long long start
= ustime();
2541 if (server
.aof_state
== REDIS_AOF_ON
) {
2542 if (loadAppendOnlyFile(server
.aof_filename
) == REDIS_OK
)
2543 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %.3f seconds",(float)(ustime()-start
)/1000000);
2545 if (rdbLoad(server
.rdb_filename
) == REDIS_OK
) {
2546 redisLog(REDIS_NOTICE
,"DB loaded from disk: %.3f seconds",
2547 (float)(ustime()-start
)/1000000);
2548 } else if (errno
!= ENOENT
) {
2549 redisLog(REDIS_WARNING
,"Fatal error loading the DB. Exiting.");
2555 void redisOutOfMemoryHandler(size_t allocation_size
) {
2556 redisLog(REDIS_WARNING
,"Out Of Memory allocating %zu bytes!",
2561 int main(int argc
, char **argv
) {
2564 /* We need to initialize our libraries, and the server configuration. */
2565 zmalloc_enable_thread_safeness();
2566 zmalloc_set_oom_handler(redisOutOfMemoryHandler
);
2567 srand(time(NULL
)^getpid());
2568 gettimeofday(&tv
,NULL
);
2569 dictSetHashFunctionSeed(tv
.tv_sec
^tv
.tv_usec
^getpid());
2570 server
.sentinel_mode
= checkForSentinelMode(argc
,argv
);
2573 /* We need to init sentinel right now as parsing the configuration file
2574 * in sentinel mode will have the effect of populating the sentinel
2575 * data structures with master nodes to monitor. */
2576 if (server
.sentinel_mode
) {
2577 initSentinelConfig();
2582 int j
= 1; /* First option to parse in argv[] */
2583 sds options
= sdsempty();
2584 char *configfile
= NULL
;
2586 /* Handle special options --help and --version */
2587 if (strcmp(argv
[1], "-v") == 0 ||
2588 strcmp(argv
[1], "--version") == 0) version();
2589 if (strcmp(argv
[1], "--help") == 0 ||
2590 strcmp(argv
[1], "-h") == 0) usage();
2591 if (strcmp(argv
[1], "--test-memory") == 0) {
2593 memtest(atoi(argv
[2]),50);
2596 fprintf(stderr
,"Please specify the amount of memory to test in megabytes.\n");
2597 fprintf(stderr
,"Example: ./redis-server --test-memory 4096\n\n");
2602 /* First argument is the config file name? */
2603 if (argv
[j
][0] != '-' || argv
[j
][1] != '-')
2604 configfile
= argv
[j
++];
2605 /* All the other options are parsed and conceptually appended to the
2606 * configuration file. For instance --port 6380 will generate the
2607 * string "port 6380\n" to be parsed after the actual file name
2608 * is parsed, if any. */
2610 if (argv
[j
][0] == '-' && argv
[j
][1] == '-') {
2612 if (sdslen(options
)) options
= sdscat(options
,"\n");
2613 options
= sdscat(options
,argv
[j
]+2);
2614 options
= sdscat(options
," ");
2616 /* Option argument */
2617 options
= sdscatrepr(options
,argv
[j
],strlen(argv
[j
]));
2618 options
= sdscat(options
," ");
2622 resetServerSaveParams();
2623 loadServerConfig(configfile
,options
);
2626 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");
2628 if (server
.daemonize
) daemonize();
2630 if (server
.daemonize
) createPidFile();
2633 if (!server
.sentinel_mode
) {
2634 /* Things only needed when not runnign in Sentinel mode. */
2635 redisLog(REDIS_WARNING
,"Server started, Redis version " REDIS_VERSION
);
2637 linuxOvercommitMemoryWarning();
2640 if (server
.ipfd
> 0)
2641 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
2642 if (server
.sofd
> 0)
2643 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections at %s", server
.unixsocket
);
2646 /* Warning the user about suspicious maxmemory setting. */
2647 if (server
.maxmemory
> 0 && server
.maxmemory
< 1024*1024) {
2648 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
);
2651 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
2653 aeDeleteEventLoop(server
.el
);