2 * Copyright (c) 2009-2012, Salvatore Sanfilippo <antirez at gmail dot com>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
8 * * Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * * Neither the name of Redis nor the names of its contributors may be used
14 * to endorse or promote products derived from this software without
15 * specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 * POSSIBILITY OF SUCH DAMAGE.
41 #include <arpa/inet.h>
45 #include <sys/resource.h>
50 #include <sys/resource.h>
51 #include <sys/utsname.h>
53 /* Our shared "common" objects */
55 struct sharedObjectsStruct shared
;
57 /* Global vars that are actually used as constants. The following double
58 * values are used for double on-disk serialization, and are initialized
59 * at runtime to avoid strange compiler optimizations. */
61 double R_Zero
, R_PosInf
, R_NegInf
, R_Nan
;
63 /*================================= Globals ================================= */
66 struct redisServer server
; /* server global state */
67 struct redisCommand
*commandTable
;
71 * Every entry is composed of the following fields:
73 * name: a string representing the command name.
74 * function: pointer to the C function implementing the command.
75 * arity: number of arguments, it is possible to use -N to say >= N
76 * sflags: command flags as string. See below for a table of flags.
77 * flags: flags as bitmask. Computed by Redis using the 'sflags' field.
78 * get_keys_proc: an optional function to get key arguments from a command.
79 * This is only used when the following three fields are not
80 * enough to specify what arguments are keys.
81 * first_key_index: first argument that is a key
82 * last_key_index: last argument that is a key
83 * key_step: step to get all the keys from first to last argument. For instance
84 * in MSET the step is two since arguments are key,val,key,val,...
85 * microseconds: microseconds of total execution time for this command.
86 * calls: total number of calls of this command.
88 * The flags, microseconds and calls fields are computed by Redis and should
89 * always be set to zero.
91 * Command flags are expressed using strings where every character represents
92 * a flag. Later the populateCommandTable() function will take care of
93 * populating the real 'flags' field using this characters.
95 * This is the meaning of the flags:
97 * w: write command (may modify the key space).
98 * r: read command (will never modify the key space).
99 * m: may increase memory usage once called. Don't allow if out of memory.
100 * a: admin command, like SAVE or SHUTDOWN.
101 * p: Pub/Sub related command.
102 * f: force replication of this command, regarless of server.dirty.
103 * s: command not allowed in scripts.
104 * R: random command. Command is not deterministic, that is, the same command
105 * with the same arguments, with the same key space, may have different
106 * results. For instance SPOP and RANDOMKEY are two random commands.
107 * S: Sort command output array if called from script, so that the output
109 * l: Allow command while loading the database.
110 * t: Allow command while a slave has stale data but is not allowed to
111 * server this data. Normally no command is accepted in this condition
113 * M: Do not automatically propagate the command on MONITOR.
115 struct redisCommand redisCommandTable
[] = {
116 {"get",getCommand
,2,"r",0,NULL
,1,1,1,0,0},
117 {"set",setCommand
,3,"wm",0,noPreloadGetKeys
,1,1,1,0,0},
118 {"setnx",setnxCommand
,3,"wm",0,noPreloadGetKeys
,1,1,1,0,0},
119 {"setex",setexCommand
,4,"wm",0,noPreloadGetKeys
,1,1,1,0,0},
120 {"psetex",psetexCommand
,4,"wm",0,noPreloadGetKeys
,1,1,1,0,0},
121 {"append",appendCommand
,3,"wm",0,NULL
,1,1,1,0,0},
122 {"strlen",strlenCommand
,2,"r",0,NULL
,1,1,1,0,0},
123 {"del",delCommand
,-2,"w",0,noPreloadGetKeys
,1,-1,1,0,0},
124 {"exists",existsCommand
,2,"r",0,NULL
,1,1,1,0,0},
125 {"setbit",setbitCommand
,4,"wm",0,NULL
,1,1,1,0,0},
126 {"getbit",getbitCommand
,3,"r",0,NULL
,1,1,1,0,0},
127 {"setrange",setrangeCommand
,4,"wm",0,NULL
,1,1,1,0,0},
128 {"getrange",getrangeCommand
,4,"r",0,NULL
,1,1,1,0,0},
129 {"substr",getrangeCommand
,4,"r",0,NULL
,1,1,1,0,0},
130 {"incr",incrCommand
,2,"wm",0,NULL
,1,1,1,0,0},
131 {"decr",decrCommand
,2,"wm",0,NULL
,1,1,1,0,0},
132 {"mget",mgetCommand
,-2,"r",0,NULL
,1,-1,1,0,0},
133 {"rpush",rpushCommand
,-3,"wm",0,NULL
,1,1,1,0,0},
134 {"lpush",lpushCommand
,-3,"wm",0,NULL
,1,1,1,0,0},
135 {"rpushx",rpushxCommand
,3,"wm",0,NULL
,1,1,1,0,0},
136 {"lpushx",lpushxCommand
,3,"wm",0,NULL
,1,1,1,0,0},
137 {"linsert",linsertCommand
,5,"wm",0,NULL
,1,1,1,0,0},
138 {"rpop",rpopCommand
,2,"w",0,NULL
,1,1,1,0,0},
139 {"lpop",lpopCommand
,2,"w",0,NULL
,1,1,1,0,0},
140 {"brpop",brpopCommand
,-3,"ws",0,NULL
,1,1,1,0,0},
141 {"brpoplpush",brpoplpushCommand
,4,"wms",0,NULL
,1,2,1,0,0},
142 {"blpop",blpopCommand
,-3,"ws",0,NULL
,1,-2,1,0,0},
143 {"llen",llenCommand
,2,"r",0,NULL
,1,1,1,0,0},
144 {"lindex",lindexCommand
,3,"r",0,NULL
,1,1,1,0,0},
145 {"lset",lsetCommand
,4,"wm",0,NULL
,1,1,1,0,0},
146 {"lrange",lrangeCommand
,4,"r",0,NULL
,1,1,1,0,0},
147 {"ltrim",ltrimCommand
,4,"w",0,NULL
,1,1,1,0,0},
148 {"lrem",lremCommand
,4,"w",0,NULL
,1,1,1,0,0},
149 {"rpoplpush",rpoplpushCommand
,3,"wm",0,NULL
,1,2,1,0,0},
150 {"sadd",saddCommand
,-3,"wm",0,NULL
,1,1,1,0,0},
151 {"srem",sremCommand
,-3,"w",0,NULL
,1,1,1,0,0},
152 {"smove",smoveCommand
,4,"w",0,NULL
,1,2,1,0,0},
153 {"sismember",sismemberCommand
,3,"r",0,NULL
,1,1,1,0,0},
154 {"scard",scardCommand
,2,"r",0,NULL
,1,1,1,0,0},
155 {"spop",spopCommand
,2,"wRs",0,NULL
,1,1,1,0,0},
156 {"srandmember",srandmemberCommand
,-2,"rR",0,NULL
,1,1,1,0,0},
157 {"sinter",sinterCommand
,-2,"rS",0,NULL
,1,-1,1,0,0},
158 {"sinterstore",sinterstoreCommand
,-3,"wm",0,NULL
,1,-1,1,0,0},
159 {"sunion",sunionCommand
,-2,"rS",0,NULL
,1,-1,1,0,0},
160 {"sunionstore",sunionstoreCommand
,-3,"wm",0,NULL
,1,-1,1,0,0},
161 {"sdiff",sdiffCommand
,-2,"rS",0,NULL
,1,-1,1,0,0},
162 {"sdiffstore",sdiffstoreCommand
,-3,"wm",0,NULL
,1,-1,1,0,0},
163 {"smembers",sinterCommand
,2,"rS",0,NULL
,1,1,1,0,0},
164 {"zadd",zaddCommand
,-4,"wm",0,NULL
,1,1,1,0,0},
165 {"zincrby",zincrbyCommand
,4,"wm",0,NULL
,1,1,1,0,0},
166 {"zrem",zremCommand
,-3,"w",0,NULL
,1,1,1,0,0},
167 {"zremrangebyscore",zremrangebyscoreCommand
,4,"w",0,NULL
,1,1,1,0,0},
168 {"zremrangebyrank",zremrangebyrankCommand
,4,"w",0,NULL
,1,1,1,0,0},
169 {"zunionstore",zunionstoreCommand
,-4,"wm",0,zunionInterGetKeys
,0,0,0,0,0},
170 {"zinterstore",zinterstoreCommand
,-4,"wm",0,zunionInterGetKeys
,0,0,0,0,0},
171 {"zrange",zrangeCommand
,-4,"r",0,NULL
,1,1,1,0,0},
172 {"zrangebyscore",zrangebyscoreCommand
,-4,"r",0,NULL
,1,1,1,0,0},
173 {"zrevrangebyscore",zrevrangebyscoreCommand
,-4,"r",0,NULL
,1,1,1,0,0},
174 {"zcount",zcountCommand
,4,"r",0,NULL
,1,1,1,0,0},
175 {"zrevrange",zrevrangeCommand
,-4,"r",0,NULL
,1,1,1,0,0},
176 {"zcard",zcardCommand
,2,"r",0,NULL
,1,1,1,0,0},
177 {"zscore",zscoreCommand
,3,"r",0,NULL
,1,1,1,0,0},
178 {"zrank",zrankCommand
,3,"r",0,NULL
,1,1,1,0,0},
179 {"zrevrank",zrevrankCommand
,3,"r",0,NULL
,1,1,1,0,0},
180 {"hset",hsetCommand
,4,"wm",0,NULL
,1,1,1,0,0},
181 {"hsetnx",hsetnxCommand
,4,"wm",0,NULL
,1,1,1,0,0},
182 {"hget",hgetCommand
,3,"r",0,NULL
,1,1,1,0,0},
183 {"hmset",hmsetCommand
,-4,"wm",0,NULL
,1,1,1,0,0},
184 {"hmget",hmgetCommand
,-3,"r",0,NULL
,1,1,1,0,0},
185 {"hincrby",hincrbyCommand
,4,"wm",0,NULL
,1,1,1,0,0},
186 {"hincrbyfloat",hincrbyfloatCommand
,4,"wm",0,NULL
,1,1,1,0,0},
187 {"hdel",hdelCommand
,-3,"w",0,NULL
,1,1,1,0,0},
188 {"hlen",hlenCommand
,2,"r",0,NULL
,1,1,1,0,0},
189 {"hkeys",hkeysCommand
,2,"rS",0,NULL
,1,1,1,0,0},
190 {"hvals",hvalsCommand
,2,"rS",0,NULL
,1,1,1,0,0},
191 {"hgetall",hgetallCommand
,2,"r",0,NULL
,1,1,1,0,0},
192 {"hexists",hexistsCommand
,3,"r",0,NULL
,1,1,1,0,0},
193 {"incrby",incrbyCommand
,3,"wm",0,NULL
,1,1,1,0,0},
194 {"decrby",decrbyCommand
,3,"wm",0,NULL
,1,1,1,0,0},
195 {"incrbyfloat",incrbyfloatCommand
,3,"wm",0,NULL
,1,1,1,0,0},
196 {"getset",getsetCommand
,3,"wm",0,NULL
,1,1,1,0,0},
197 {"mset",msetCommand
,-3,"wm",0,NULL
,1,-1,2,0,0},
198 {"msetnx",msetnxCommand
,-3,"wm",0,NULL
,1,-1,2,0,0},
199 {"randomkey",randomkeyCommand
,1,"rR",0,NULL
,0,0,0,0,0},
200 {"select",selectCommand
,2,"r",0,NULL
,0,0,0,0,0},
201 {"move",moveCommand
,3,"w",0,NULL
,1,1,1,0,0},
202 {"rename",renameCommand
,3,"w",0,renameGetKeys
,1,2,1,0,0},
203 {"renamenx",renamenxCommand
,3,"w",0,renameGetKeys
,1,2,1,0,0},
204 {"expire",expireCommand
,3,"w",0,NULL
,1,1,1,0,0},
205 {"expireat",expireatCommand
,3,"w",0,NULL
,1,1,1,0,0},
206 {"pexpire",pexpireCommand
,3,"w",0,NULL
,1,1,1,0,0},
207 {"pexpireat",pexpireatCommand
,3,"w",0,NULL
,1,1,1,0,0},
208 {"keys",keysCommand
,2,"rS",0,NULL
,0,0,0,0,0},
209 {"dbsize",dbsizeCommand
,1,"r",0,NULL
,0,0,0,0,0},
210 {"auth",authCommand
,2,"rs",0,NULL
,0,0,0,0,0},
211 {"ping",pingCommand
,1,"r",0,NULL
,0,0,0,0,0},
212 {"echo",echoCommand
,2,"r",0,NULL
,0,0,0,0,0},
213 {"save",saveCommand
,1,"ars",0,NULL
,0,0,0,0,0},
214 {"bgsave",bgsaveCommand
,1,"ar",0,NULL
,0,0,0,0,0},
215 {"bgrewriteaof",bgrewriteaofCommand
,1,"ar",0,NULL
,0,0,0,0,0},
216 {"shutdown",shutdownCommand
,-1,"ar",0,NULL
,0,0,0,0,0},
217 {"lastsave",lastsaveCommand
,1,"r",0,NULL
,0,0,0,0,0},
218 {"type",typeCommand
,2,"r",0,NULL
,1,1,1,0,0},
219 {"multi",multiCommand
,1,"rs",0,NULL
,0,0,0,0,0},
220 {"exec",execCommand
,1,"sM",0,NULL
,0,0,0,0,0},
221 {"discard",discardCommand
,1,"rs",0,NULL
,0,0,0,0,0},
222 {"sync",syncCommand
,1,"ars",0,NULL
,0,0,0,0,0},
223 {"replconf",replconfCommand
,-1,"ars",0,NULL
,0,0,0,0,0},
224 {"flushdb",flushdbCommand
,1,"w",0,NULL
,0,0,0,0,0},
225 {"flushall",flushallCommand
,1,"w",0,NULL
,0,0,0,0,0},
226 {"sort",sortCommand
,-2,"wm",0,NULL
,1,1,1,0,0},
227 {"info",infoCommand
,-1,"rlt",0,NULL
,0,0,0,0,0},
228 {"monitor",monitorCommand
,1,"ars",0,NULL
,0,0,0,0,0},
229 {"ttl",ttlCommand
,2,"r",0,NULL
,1,1,1,0,0},
230 {"pttl",pttlCommand
,2,"r",0,NULL
,1,1,1,0,0},
231 {"persist",persistCommand
,2,"w",0,NULL
,1,1,1,0,0},
232 {"slaveof",slaveofCommand
,3,"ast",0,NULL
,0,0,0,0,0},
233 {"debug",debugCommand
,-2,"as",0,NULL
,0,0,0,0,0},
234 {"config",configCommand
,-2,"ar",0,NULL
,0,0,0,0,0},
235 {"subscribe",subscribeCommand
,-2,"rpslt",0,NULL
,0,0,0,0,0},
236 {"unsubscribe",unsubscribeCommand
,-1,"rpslt",0,NULL
,0,0,0,0,0},
237 {"psubscribe",psubscribeCommand
,-2,"rpslt",0,NULL
,0,0,0,0,0},
238 {"punsubscribe",punsubscribeCommand
,-1,"rpslt",0,NULL
,0,0,0,0,0},
239 {"publish",publishCommand
,3,"pflt",0,NULL
,0,0,0,0,0},
240 {"watch",watchCommand
,-2,"rs",0,noPreloadGetKeys
,1,-1,1,0,0},
241 {"unwatch",unwatchCommand
,1,"rs",0,NULL
,0,0,0,0,0},
242 {"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 and other
397 * places where case insensitive non binary-safe comparison is needed. */
398 int dictSdsKeyCaseCompare(void *privdata
, const void *key1
,
401 DICT_NOTUSED(privdata
);
403 return strcasecmp(key1
, key2
) == 0;
406 void dictRedisObjectDestructor(void *privdata
, void *val
)
408 DICT_NOTUSED(privdata
);
410 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
414 void dictSdsDestructor(void *privdata
, void *val
)
416 DICT_NOTUSED(privdata
);
421 int dictObjKeyCompare(void *privdata
, const void *key1
,
424 const robj
*o1
= key1
, *o2
= key2
;
425 return dictSdsKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
428 unsigned int dictObjHash(const void *key
) {
430 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
433 unsigned int dictSdsHash(const void *key
) {
434 return dictGenHashFunction((unsigned char*)key
, sdslen((char*)key
));
437 unsigned int dictSdsCaseHash(const void *key
) {
438 return dictGenCaseHashFunction((unsigned char*)key
, sdslen((char*)key
));
441 int dictEncObjKeyCompare(void *privdata
, const void *key1
,
444 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
447 if (o1
->encoding
== REDIS_ENCODING_INT
&&
448 o2
->encoding
== REDIS_ENCODING_INT
)
449 return o1
->ptr
== o2
->ptr
;
451 o1
= getDecodedObject(o1
);
452 o2
= getDecodedObject(o2
);
453 cmp
= dictSdsKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
459 unsigned int dictEncObjHash(const void *key
) {
460 robj
*o
= (robj
*) key
;
462 if (o
->encoding
== REDIS_ENCODING_RAW
) {
463 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
465 if (o
->encoding
== REDIS_ENCODING_INT
) {
469 len
= ll2string(buf
,32,(long)o
->ptr
);
470 return dictGenHashFunction((unsigned char*)buf
, len
);
474 o
= getDecodedObject(o
);
475 hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
482 /* Sets type hash table */
483 dictType setDictType
= {
484 dictEncObjHash
, /* hash function */
487 dictEncObjKeyCompare
, /* key compare */
488 dictRedisObjectDestructor
, /* key destructor */
489 NULL
/* val destructor */
492 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
493 dictType zsetDictType
= {
494 dictEncObjHash
, /* hash function */
497 dictEncObjKeyCompare
, /* key compare */
498 dictRedisObjectDestructor
, /* key destructor */
499 NULL
/* val destructor */
502 /* Db->dict, keys are sds strings, vals are Redis objects. */
503 dictType dbDictType
= {
504 dictSdsHash
, /* hash function */
507 dictSdsKeyCompare
, /* key compare */
508 dictSdsDestructor
, /* key destructor */
509 dictRedisObjectDestructor
/* val destructor */
512 /* server.lua_scripts sha (as sds string) -> scripts (as robj) cache. */
513 dictType shaScriptObjectDictType
= {
514 dictSdsCaseHash
, /* hash function */
517 dictSdsKeyCaseCompare
, /* key compare */
518 dictSdsDestructor
, /* key destructor */
519 dictRedisObjectDestructor
/* val destructor */
523 dictType keyptrDictType
= {
524 dictSdsHash
, /* hash function */
527 dictSdsKeyCompare
, /* key compare */
528 NULL
, /* key destructor */
529 NULL
/* val destructor */
532 /* Command table. sds string -> command struct pointer. */
533 dictType commandTableDictType
= {
534 dictSdsCaseHash
, /* hash function */
537 dictSdsKeyCaseCompare
, /* key compare */
538 dictSdsDestructor
, /* key destructor */
539 NULL
/* val destructor */
542 /* Hash type hash table (note that small hashes are represented with zimpaps) */
543 dictType hashDictType
= {
544 dictEncObjHash
, /* hash function */
547 dictEncObjKeyCompare
, /* key compare */
548 dictRedisObjectDestructor
, /* key destructor */
549 dictRedisObjectDestructor
/* val destructor */
552 /* Keylist hash table type has unencoded redis objects as keys and
553 * lists as values. It's used for blocking operations (BLPOP) and to
554 * map swapped keys to a list of clients waiting for this keys to be loaded. */
555 dictType keylistDictType
= {
556 dictObjHash
, /* hash function */
559 dictObjKeyCompare
, /* key compare */
560 dictRedisObjectDestructor
, /* key destructor */
561 dictListDestructor
/* val destructor */
564 /* Cluster nodes hash table, mapping nodes addresses 1.2.3.4:6379 to
565 * clusterNode structures. */
566 dictType clusterNodesDictType
= {
567 dictSdsHash
, /* hash function */
570 dictSdsKeyCompare
, /* key compare */
571 dictSdsDestructor
, /* key destructor */
572 NULL
/* val destructor */
575 /* Migrate cache dict type. */
576 dictType migrateCacheDictType
= {
577 dictSdsHash
, /* hash function */
580 dictSdsKeyCompare
, /* key compare */
581 dictSdsDestructor
, /* key destructor */
582 NULL
/* val destructor */
585 int htNeedsResize(dict
*dict
) {
586 long long size
, used
;
588 size
= dictSlots(dict
);
589 used
= dictSize(dict
);
590 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
591 (used
*100/size
< REDIS_HT_MINFILL
));
594 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
595 * we resize the hash table to save memory */
596 void tryResizeHashTables(void) {
599 for (j
= 0; j
< server
.dbnum
; j
++) {
600 if (htNeedsResize(server
.db
[j
].dict
))
601 dictResize(server
.db
[j
].dict
);
602 if (htNeedsResize(server
.db
[j
].expires
))
603 dictResize(server
.db
[j
].expires
);
607 /* Our hash table implementation performs rehashing incrementally while
608 * we write/read from the hash table. Still if the server is idle, the hash
609 * table will use two tables for a long time. So we try to use 1 millisecond
610 * of CPU time at every serverCron() loop in order to rehash some key. */
611 void incrementallyRehash(void) {
614 for (j
= 0; j
< server
.dbnum
; j
++) {
615 /* Keys dictionary */
616 if (dictIsRehashing(server
.db
[j
].dict
)) {
617 dictRehashMilliseconds(server
.db
[j
].dict
,1);
618 break; /* already used our millisecond for this loop... */
621 if (dictIsRehashing(server
.db
[j
].expires
)) {
622 dictRehashMilliseconds(server
.db
[j
].expires
,1);
623 break; /* already used our millisecond for this loop... */
628 /* This function is called once a background process of some kind terminates,
629 * as we want to avoid resizing the hash tables when there is a child in order
630 * to play well with copy-on-write (otherwise when a resize happens lots of
631 * memory pages are copied). The goal of this function is to update the ability
632 * for dict.c to resize the hash tables accordingly to the fact we have o not
634 void updateDictResizePolicy(void) {
635 if (server
.rdb_child_pid
== -1 && server
.aof_child_pid
== -1)
641 /* ======================= Cron: called every 100 ms ======================== */
643 /* Try to expire a few timed out keys. The algorithm used is adaptive and
644 * will use few CPU cycles if there are few expiring keys, otherwise
645 * it will get more aggressive to avoid that too much memory is used by
646 * keys that can be removed from the keyspace. */
647 void activeExpireCycle(void) {
648 int j
, iteration
= 0;
649 long long start
= ustime(), timelimit
;
651 /* We can use at max REDIS_EXPIRELOOKUPS_TIME_PERC percentage of CPU time
652 * per iteration. Since this function gets called with a frequency of
653 * REDIS_HZ times per second, the following is the max amount of
654 * microseconds we can spend in this function. */
655 timelimit
= 1000000*REDIS_EXPIRELOOKUPS_TIME_PERC
/REDIS_HZ
/100;
656 if (timelimit
<= 0) timelimit
= 1;
658 for (j
= 0; j
< server
.dbnum
; j
++) {
660 redisDb
*db
= server
.db
+j
;
662 /* Continue to expire if at the end of the cycle more than 25%
663 * of the keys were expired. */
665 unsigned long num
= dictSize(db
->expires
);
666 unsigned long slots
= dictSlots(db
->expires
);
667 long long now
= mstime();
669 /* When there are less than 1% filled slots getting random
670 * keys is expensive, so stop here waiting for better times...
671 * The dictionary will be resized asap. */
672 if (num
&& slots
> DICT_HT_INITIAL_SIZE
&&
673 (num
*100/slots
< 1)) break;
675 /* The main collection cycle. Sample random keys among keys
676 * with an expire set, checking for expired ones. */
678 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
679 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
684 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
685 t
= dictGetSignedIntegerVal(de
);
687 sds key
= dictGetKey(de
);
688 robj
*keyobj
= createStringObject(key
,sdslen(key
));
690 propagateExpire(db
,keyobj
);
692 decrRefCount(keyobj
);
694 server
.stat_expiredkeys
++;
697 /* We can't block forever here even if there are many keys to
698 * expire. So after a given amount of milliseconds return to the
699 * caller waiting for the other active expire cycle. */
701 if ((iteration
& 0xf) == 0 && /* check once every 16 cycles. */
702 (ustime()-start
) > timelimit
) return;
703 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
707 void updateLRUClock(void) {
708 server
.lruclock
= (server
.unixtime
/REDIS_LRU_CLOCK_RESOLUTION
) &
713 /* Add a sample to the operations per second array of samples. */
714 void trackOperationsPerSecond(void) {
715 long long t
= mstime() - server
.ops_sec_last_sample_time
;
716 long long ops
= server
.stat_numcommands
- server
.ops_sec_last_sample_ops
;
719 ops_sec
= t
> 0 ? (ops
*1000/t
) : 0;
721 server
.ops_sec_samples
[server
.ops_sec_idx
] = ops_sec
;
722 server
.ops_sec_idx
= (server
.ops_sec_idx
+1) % REDIS_OPS_SEC_SAMPLES
;
723 server
.ops_sec_last_sample_time
= mstime();
724 server
.ops_sec_last_sample_ops
= server
.stat_numcommands
;
727 /* Return the mean of all the samples. */
728 long long getOperationsPerSecond(void) {
732 for (j
= 0; j
< REDIS_OPS_SEC_SAMPLES
; j
++)
733 sum
+= server
.ops_sec_samples
[j
];
734 return sum
/ REDIS_OPS_SEC_SAMPLES
;
737 /* Check for timeouts. Returns non-zero if the client was terminated */
738 int clientsCronHandleTimeout(redisClient
*c
) {
739 time_t now
= server
.unixtime
;
741 if (server
.maxidletime
&&
742 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
743 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
744 !(c
->flags
& REDIS_BLOCKED
) && /* no timeout for BLPOP */
745 dictSize(c
->pubsub_channels
) == 0 && /* no timeout for pubsub */
746 listLength(c
->pubsub_patterns
) == 0 &&
747 (now
- c
->lastinteraction
> server
.maxidletime
))
749 redisLog(REDIS_VERBOSE
,"Closing idle client");
752 } else if (c
->flags
& REDIS_BLOCKED
) {
753 if (c
->bpop
.timeout
!= 0 && c
->bpop
.timeout
< now
) {
754 addReply(c
,shared
.nullmultibulk
);
755 unblockClientWaitingData(c
);
761 /* The client query buffer is an sds.c string that can end with a lot of
762 * free space not used, this function reclaims space if needed.
764 * The funciton always returns 0 as it never terminates the client. */
765 int clientsCronResizeQueryBuffer(redisClient
*c
) {
766 size_t querybuf_size
= sdsAllocSize(c
->querybuf
);
767 time_t idletime
= server
.unixtime
- c
->lastinteraction
;
769 /* There are two conditions to resize the query buffer:
770 * 1) Query buffer is > BIG_ARG and too big for latest peak.
771 * 2) Client is inactive and the buffer is bigger than 1k. */
772 if (((querybuf_size
> REDIS_MBULK_BIG_ARG
) &&
773 (querybuf_size
/(c
->querybuf_peak
+1)) > 2) ||
774 (querybuf_size
> 1024 && idletime
> 2))
776 /* Only resize the query buffer if it is actually wasting space. */
777 if (sdsavail(c
->querybuf
) > 1024) {
778 c
->querybuf
= sdsRemoveFreeSpace(c
->querybuf
);
781 /* Reset the peak again to capture the peak memory usage in the next
783 c
->querybuf_peak
= 0;
787 void clientsCron(void) {
788 /* Make sure to process at least 1/(REDIS_HZ*10) of clients per call.
789 * Since this function is called REDIS_HZ times per second we are sure that
790 * in the worst case we process all the clients in 10 seconds.
791 * In normal conditions (a reasonable number of clients) we process
792 * all the clients in a shorter time. */
793 int numclients
= listLength(server
.clients
);
794 int iterations
= numclients
/(REDIS_HZ
*10);
797 iterations
= (numclients
< 50) ? numclients
: 50;
798 while(listLength(server
.clients
) && iterations
--) {
802 /* Rotate the list, take the current head, process.
803 * This way if the client must be removed from the list it's the
804 * first element and we don't incur into O(N) computation. */
805 listRotate(server
.clients
);
806 head
= listFirst(server
.clients
);
807 c
= listNodeValue(head
);
808 /* The following functions do different service checks on the client.
809 * The protocol is that they return non-zero if the client was
811 if (clientsCronHandleTimeout(c
)) continue;
812 if (clientsCronResizeQueryBuffer(c
)) continue;
816 /* This is our timer interrupt, called REDIS_HZ times per second.
817 * Here is where we do a number of things that need to be done asynchronously.
820 * - Active expired keys collection (it is also performed in a lazy way on
822 * - Software watchdong.
823 * - Update some statistic.
824 * - Incremental rehashing of the DBs hash tables.
825 * - Triggering BGSAVE / AOF rewrite, and handling of terminated children.
826 * - Clients timeout of differnet kinds.
827 * - Replication reconnection.
830 * Everything directly called here will be called REDIS_HZ times per second,
831 * so in order to throttle execution of things we want to do less frequently
832 * a macro is used: run_with_period(milliseconds) { .... }
835 int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
837 REDIS_NOTUSED(eventLoop
);
839 REDIS_NOTUSED(clientData
);
841 /* Software watchdog: deliver the SIGALRM that will reach the signal
842 * handler if we don't return here fast enough. */
843 if (server
.watchdog_period
) watchdogScheduleSignal(server
.watchdog_period
);
845 /* We take a cached value of the unix time in the global state because
846 * with virtual memory and aging there is to store the current time
847 * in objects at every object access, and accuracy is not needed.
848 * To access a global var is faster than calling time(NULL) */
849 server
.unixtime
= time(NULL
);
851 run_with_period(100) trackOperationsPerSecond();
853 /* We have just 22 bits per object for LRU information.
854 * So we use an (eventually wrapping) LRU clock with 10 seconds resolution.
855 * 2^22 bits with 10 seconds resoluton is more or less 1.5 years.
857 * Note that even if this will wrap after 1.5 years it's not a problem,
858 * everything will still work but just some object will appear younger
859 * to Redis. But for this to happen a given object should never be touched
862 * Note that you can change the resolution altering the
863 * REDIS_LRU_CLOCK_RESOLUTION define.
867 /* Record the max memory used since the server was started. */
868 if (zmalloc_used_memory() > server
.stat_peak_memory
)
869 server
.stat_peak_memory
= zmalloc_used_memory();
871 /* We received a SIGTERM, shutting down here in a safe way, as it is
872 * not ok doing so inside the signal handler. */
873 if (server
.shutdown_asap
) {
874 if (prepareForShutdown(0) == REDIS_OK
) exit(0);
875 redisLog(REDIS_WARNING
,"SIGTERM received but errors trying to shut down the server, check the logs for more information");
878 /* Show some info about non-empty databases */
879 run_with_period(5000) {
880 for (j
= 0; j
< server
.dbnum
; j
++) {
881 long long size
, used
, vkeys
;
883 size
= dictSlots(server
.db
[j
].dict
);
884 used
= dictSize(server
.db
[j
].dict
);
885 vkeys
= dictSize(server
.db
[j
].expires
);
887 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
888 /* dictPrintStats(server.dict); */
893 /* We don't want to resize the hash tables while a bacground saving
894 * is in progress: the saving child is created using fork() that is
895 * implemented with a copy-on-write semantic in most modern systems, so
896 * if we resize the HT while there is the saving child at work actually
897 * a lot of memory movements in the parent will cause a lot of pages
899 if (server
.rdb_child_pid
== -1 && server
.aof_child_pid
== -1) {
900 tryResizeHashTables();
901 if (server
.activerehashing
) incrementallyRehash();
904 /* Show information about connected clients */
905 if (!server
.sentinel_mode
) {
906 run_with_period(5000) {
907 redisLog(REDIS_VERBOSE
,
908 "%d clients connected (%d slaves), %zu bytes in use",
909 listLength(server
.clients
)-listLength(server
.slaves
),
910 listLength(server
.slaves
),
911 zmalloc_used_memory());
915 /* We need to do a few operations on clients asynchronously. */
918 /* Start a scheduled AOF rewrite if this was requested by the user while
919 * a BGSAVE was in progress. */
920 if (server
.rdb_child_pid
== -1 && server
.aof_child_pid
== -1 &&
921 server
.aof_rewrite_scheduled
)
923 rewriteAppendOnlyFileBackground();
926 /* Check if a background saving or AOF rewrite in progress terminated. */
927 if (server
.rdb_child_pid
!= -1 || server
.aof_child_pid
!= -1) {
931 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
932 int exitcode
= WEXITSTATUS(statloc
);
935 if (WIFSIGNALED(statloc
)) bysignal
= WTERMSIG(statloc
);
937 if (pid
== server
.rdb_child_pid
) {
938 backgroundSaveDoneHandler(exitcode
,bysignal
);
939 } else if (pid
== server
.aof_child_pid
) {
940 backgroundRewriteDoneHandler(exitcode
,bysignal
);
942 redisLog(REDIS_WARNING
,
943 "Warning, detected child with unmatched pid: %ld",
946 updateDictResizePolicy();
949 /* If there is not a background saving/rewrite in progress check if
950 * we have to save/rewrite now */
951 for (j
= 0; j
< server
.saveparamslen
; j
++) {
952 struct saveparam
*sp
= server
.saveparams
+j
;
954 if (server
.dirty
>= sp
->changes
&&
955 server
.unixtime
-server
.lastsave
> sp
->seconds
) {
956 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
957 sp
->changes
, sp
->seconds
);
958 rdbSaveBackground(server
.rdb_filename
);
963 /* Trigger an AOF rewrite if needed */
964 if (server
.rdb_child_pid
== -1 &&
965 server
.aof_child_pid
== -1 &&
966 server
.aof_rewrite_perc
&&
967 server
.aof_current_size
> server
.aof_rewrite_min_size
)
969 long long base
= server
.aof_rewrite_base_size
?
970 server
.aof_rewrite_base_size
: 1;
971 long long growth
= (server
.aof_current_size
*100/base
) - 100;
972 if (growth
>= server
.aof_rewrite_perc
) {
973 redisLog(REDIS_NOTICE
,"Starting automatic rewriting of AOF on %lld%% growth",growth
);
974 rewriteAppendOnlyFileBackground();
980 /* If we postponed an AOF buffer flush, let's try to do it every time the
981 * cron function is called. */
982 if (server
.aof_flush_postponed_start
) flushAppendOnlyFile(0);
984 /* Expire a few keys per cycle, only if this is a master.
985 * On slaves we wait for DEL operations synthesized by the master
986 * in order to guarantee a strict consistency. */
987 if (server
.masterhost
== NULL
) activeExpireCycle();
989 /* Close clients that need to be closed asynchronous */
990 freeClientsInAsyncFreeQueue();
992 /* Replication cron function -- used to reconnect to master and
993 * to detect transfer failures. */
994 run_with_period(1000) replicationCron();
996 /* Run the Redis Cluster cron. */
997 run_with_period(1000) {
998 if (server
.cluster_enabled
) clusterCron();
1001 /* Run the Sentinel timer if we are in sentinel mode. */
1002 run_with_period(100) {
1003 if (server
.sentinel_mode
) sentinelTimer();
1006 /* Cleanup expired MIGRATE cached sockets. */
1007 run_with_period(1000) {
1008 migrateCloseTimedoutSockets();
1012 return 1000/REDIS_HZ
;
1015 /* This function gets called every time Redis is entering the
1016 * main loop of the event driven library, that is, before to sleep
1017 * for ready file descriptors. */
1018 void beforeSleep(struct aeEventLoop
*eventLoop
) {
1019 REDIS_NOTUSED(eventLoop
);
1023 /* Try to process pending commands for clients that were just unblocked. */
1024 while (listLength(server
.unblocked_clients
)) {
1025 ln
= listFirst(server
.unblocked_clients
);
1026 redisAssert(ln
!= NULL
);
1028 listDelNode(server
.unblocked_clients
,ln
);
1029 c
->flags
&= ~REDIS_UNBLOCKED
;
1031 /* Process remaining data in the input buffer. */
1032 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) {
1033 server
.current_client
= c
;
1034 processInputBuffer(c
);
1035 server
.current_client
= NULL
;
1039 /* Write the AOF buffer on disk */
1040 flushAppendOnlyFile(0);
1043 /* =========================== Server initialization ======================== */
1045 void createSharedObjects(void) {
1048 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1049 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1050 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1051 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1052 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1053 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1054 shared
.cnegone
= createObject(REDIS_STRING
,sdsnew(":-1\r\n"));
1055 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1056 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1057 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1058 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1059 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1060 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1061 "-WRONGTYPE Operation against a key holding the wrong kind of value\r\n"));
1062 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1063 "-ERR no such key\r\n"));
1064 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1065 "-ERR syntax error\r\n"));
1066 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1067 "-ERR source and destination objects are the same\r\n"));
1068 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1069 "-ERR index out of range\r\n"));
1070 shared
.noscripterr
= createObject(REDIS_STRING
,sdsnew(
1071 "-NOSCRIPT No matching script. Please use EVAL.\r\n"));
1072 shared
.loadingerr
= createObject(REDIS_STRING
,sdsnew(
1073 "-LOADING Redis is loading the dataset in memory\r\n"));
1074 shared
.slowscripterr
= createObject(REDIS_STRING
,sdsnew(
1075 "-BUSY Redis is busy running a script. You can only call SCRIPT KILL or SHUTDOWN NOSAVE.\r\n"));
1076 shared
.masterdownerr
= createObject(REDIS_STRING
,sdsnew(
1077 "-MASTERDOWN Link with MASTER is down and slave-serve-stale-data is set to 'no'.\r\n"));
1078 shared
.bgsaveerr
= createObject(REDIS_STRING
,sdsnew(
1079 "-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"));
1080 shared
.roslaveerr
= createObject(REDIS_STRING
,sdsnew(
1081 "-READONLY You can't write against a read only slave.\r\n"));
1082 shared
.oomerr
= createObject(REDIS_STRING
,sdsnew(
1083 "-OOM command not allowed when used memory > 'maxmemory'.\r\n"));
1084 shared
.execaborterr
= createObject(REDIS_STRING
,sdsnew(
1085 "-EXECABORT Transaction discarded because of previous errors.\r\n"));
1086 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1087 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1088 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1090 for (j
= 0; j
< REDIS_SHARED_SELECT_CMDS
; j
++) {
1091 shared
.select
[j
] = createObject(REDIS_STRING
,
1092 sdscatprintf(sdsempty(),"select %d\r\n", j
));
1094 shared
.messagebulk
= createStringObject("$7\r\nmessage\r\n",13);
1095 shared
.pmessagebulk
= createStringObject("$8\r\npmessage\r\n",14);
1096 shared
.subscribebulk
= createStringObject("$9\r\nsubscribe\r\n",15);
1097 shared
.unsubscribebulk
= createStringObject("$11\r\nunsubscribe\r\n",18);
1098 shared
.psubscribebulk
= createStringObject("$10\r\npsubscribe\r\n",17);
1099 shared
.punsubscribebulk
= createStringObject("$12\r\npunsubscribe\r\n",19);
1100 shared
.del
= createStringObject("DEL",3);
1101 shared
.rpop
= createStringObject("RPOP",4);
1102 shared
.lpop
= createStringObject("LPOP",4);
1103 shared
.lpush
= createStringObject("LPUSH",5);
1104 for (j
= 0; j
< REDIS_SHARED_INTEGERS
; j
++) {
1105 shared
.integers
[j
] = createObject(REDIS_STRING
,(void*)(long)j
);
1106 shared
.integers
[j
]->encoding
= REDIS_ENCODING_INT
;
1108 for (j
= 0; j
< REDIS_SHARED_BULKHDR_LEN
; j
++) {
1109 shared
.mbulkhdr
[j
] = createObject(REDIS_STRING
,
1110 sdscatprintf(sdsempty(),"*%d\r\n",j
));
1111 shared
.bulkhdr
[j
] = createObject(REDIS_STRING
,
1112 sdscatprintf(sdsempty(),"$%d\r\n",j
));
1116 void initServerConfig() {
1117 getRandomHexChars(server
.runid
,REDIS_RUN_ID_SIZE
);
1118 server
.runid
[REDIS_RUN_ID_SIZE
] = '\0';
1119 server
.arch_bits
= (sizeof(long) == 8) ? 64 : 32;
1120 server
.port
= REDIS_SERVERPORT
;
1121 server
.bindaddr
= NULL
;
1122 server
.unixsocket
= NULL
;
1123 server
.unixsocketperm
= 0;
1126 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1127 server
.verbosity
= REDIS_NOTICE
;
1128 server
.maxidletime
= REDIS_MAXIDLETIME
;
1129 server
.client_max_querybuf_len
= REDIS_MAX_QUERYBUF_LEN
;
1130 server
.saveparams
= NULL
;
1132 server
.logfile
= NULL
; /* NULL = log on standard output */
1133 server
.syslog_enabled
= 0;
1134 server
.syslog_ident
= zstrdup("redis");
1135 server
.syslog_facility
= LOG_LOCAL0
;
1136 server
.daemonize
= 0;
1137 server
.aof_state
= REDIS_AOF_OFF
;
1138 server
.aof_fsync
= AOF_FSYNC_EVERYSEC
;
1139 server
.aof_no_fsync_on_rewrite
= 0;
1140 server
.aof_rewrite_perc
= REDIS_AOF_REWRITE_PERC
;
1141 server
.aof_rewrite_min_size
= REDIS_AOF_REWRITE_MIN_SIZE
;
1142 server
.aof_rewrite_base_size
= 0;
1143 server
.aof_rewrite_scheduled
= 0;
1144 server
.aof_last_fsync
= time(NULL
);
1145 server
.aof_rewrite_time_last
= -1;
1146 server
.aof_rewrite_time_start
= -1;
1147 server
.aof_lastbgrewrite_status
= REDIS_OK
;
1148 server
.aof_delayed_fsync
= 0;
1150 server
.aof_selected_db
= -1; /* Make sure the first time will not match */
1151 server
.aof_flush_postponed_start
= 0;
1152 server
.pidfile
= zstrdup("/var/run/redis.pid");
1153 server
.rdb_filename
= zstrdup("dump.rdb");
1154 server
.aof_filename
= zstrdup("appendonly.aof");
1155 server
.requirepass
= NULL
;
1156 server
.rdb_compression
= 1;
1157 server
.rdb_checksum
= 1;
1158 server
.activerehashing
= 1;
1159 server
.maxclients
= REDIS_MAX_CLIENTS
;
1160 server
.bpop_blocked_clients
= 0;
1161 server
.maxmemory
= 0;
1162 server
.maxmemory_policy
= REDIS_MAXMEMORY_VOLATILE_LRU
;
1163 server
.maxmemory_samples
= 3;
1164 server
.hash_max_ziplist_entries
= REDIS_HASH_MAX_ZIPLIST_ENTRIES
;
1165 server
.hash_max_ziplist_value
= REDIS_HASH_MAX_ZIPLIST_VALUE
;
1166 server
.list_max_ziplist_entries
= REDIS_LIST_MAX_ZIPLIST_ENTRIES
;
1167 server
.list_max_ziplist_value
= REDIS_LIST_MAX_ZIPLIST_VALUE
;
1168 server
.set_max_intset_entries
= REDIS_SET_MAX_INTSET_ENTRIES
;
1169 server
.zset_max_ziplist_entries
= REDIS_ZSET_MAX_ZIPLIST_ENTRIES
;
1170 server
.zset_max_ziplist_value
= REDIS_ZSET_MAX_ZIPLIST_VALUE
;
1171 server
.shutdown_asap
= 0;
1172 server
.repl_ping_slave_period
= REDIS_REPL_PING_SLAVE_PERIOD
;
1173 server
.repl_timeout
= REDIS_REPL_TIMEOUT
;
1174 server
.cluster_enabled
= 0;
1175 server
.cluster
.configfile
= zstrdup("nodes.conf");
1176 server
.lua_caller
= NULL
;
1177 server
.lua_time_limit
= REDIS_LUA_TIME_LIMIT
;
1178 server
.lua_client
= NULL
;
1179 server
.lua_timedout
= 0;
1180 server
.migrate_cached_sockets
= dictCreate(&migrateCacheDictType
,NULL
);
1183 resetServerSaveParams();
1185 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1186 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1187 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1188 /* Replication related */
1189 server
.masterauth
= NULL
;
1190 server
.masterhost
= NULL
;
1191 server
.masterport
= 6379;
1192 server
.master
= NULL
;
1193 server
.repl_state
= REDIS_REPL_NONE
;
1194 server
.repl_syncio_timeout
= REDIS_REPL_SYNCIO_TIMEOUT
;
1195 server
.repl_serve_stale_data
= 1;
1196 server
.repl_slave_ro
= 1;
1197 server
.repl_down_since
= time(NULL
);
1198 server
.slave_priority
= REDIS_DEFAULT_SLAVE_PRIORITY
;
1200 /* Client output buffer limits */
1201 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_NORMAL
].hard_limit_bytes
= 0;
1202 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_NORMAL
].soft_limit_bytes
= 0;
1203 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_NORMAL
].soft_limit_seconds
= 0;
1204 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_SLAVE
].hard_limit_bytes
= 1024*1024*256;
1205 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_SLAVE
].soft_limit_bytes
= 1024*1024*64;
1206 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_SLAVE
].soft_limit_seconds
= 60;
1207 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_PUBSUB
].hard_limit_bytes
= 1024*1024*32;
1208 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_PUBSUB
].soft_limit_bytes
= 1024*1024*8;
1209 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_PUBSUB
].soft_limit_seconds
= 60;
1211 /* Double constants initialization */
1213 R_PosInf
= 1.0/R_Zero
;
1214 R_NegInf
= -1.0/R_Zero
;
1215 R_Nan
= R_Zero
/R_Zero
;
1217 /* Command table -- we intiialize it here as it is part of the
1218 * initial configuration, since command names may be changed via
1219 * redis.conf using the rename-command directive. */
1220 server
.commands
= dictCreate(&commandTableDictType
,NULL
);
1221 populateCommandTable();
1222 server
.delCommand
= lookupCommandByCString("del");
1223 server
.multiCommand
= lookupCommandByCString("multi");
1224 server
.lpushCommand
= lookupCommandByCString("lpush");
1225 server
.lpopCommand
= lookupCommandByCString("lpop");
1226 server
.rpopCommand
= lookupCommandByCString("rpop");
1229 server
.slowlog_log_slower_than
= REDIS_SLOWLOG_LOG_SLOWER_THAN
;
1230 server
.slowlog_max_len
= REDIS_SLOWLOG_MAX_LEN
;
1233 server
.assert_failed
= "<no assertion failed>";
1234 server
.assert_file
= "<no file>";
1235 server
.assert_line
= 0;
1236 server
.bug_report_start
= 0;
1237 server
.watchdog_period
= 0;
1240 /* This function will try to raise the max number of open files accordingly to
1241 * the configured max number of clients. It will also account for 32 additional
1242 * file descriptors as we need a few more for persistence, listening
1243 * sockets, log files and so forth.
1245 * If it will not be possible to set the limit accordingly to the configured
1246 * max number of clients, the function will do the reverse setting
1247 * server.maxclients to the value that we can actually handle. */
1248 void adjustOpenFilesLimit(void) {
1249 rlim_t maxfiles
= server
.maxclients
+32;
1250 struct rlimit limit
;
1252 if (getrlimit(RLIMIT_NOFILE
,&limit
) == -1) {
1253 redisLog(REDIS_WARNING
,"Unable to obtain the current NOFILE limit (%s), assuming 1024 and setting the max clients configuration accordingly.",
1255 server
.maxclients
= 1024-32;
1257 rlim_t oldlimit
= limit
.rlim_cur
;
1259 /* Set the max number of files if the current limit is not enough
1261 if (oldlimit
< maxfiles
) {
1265 while(f
> oldlimit
) {
1268 if (setrlimit(RLIMIT_NOFILE
,&limit
) != -1) break;
1271 if (f
< oldlimit
) f
= oldlimit
;
1272 if (f
!= maxfiles
) {
1273 server
.maxclients
= f
-32;
1274 redisLog(REDIS_WARNING
,"Unable to set the max number of files limit to %d (%s), setting the max clients configuration to %d.",
1275 (int) maxfiles
, strerror(errno
), (int) server
.maxclients
);
1277 redisLog(REDIS_NOTICE
,"Max number of open files set to %d",
1287 signal(SIGHUP
, SIG_IGN
);
1288 signal(SIGPIPE
, SIG_IGN
);
1289 setupSignalHandlers();
1291 if (server
.syslog_enabled
) {
1292 openlog(server
.syslog_ident
, LOG_PID
| LOG_NDELAY
| LOG_NOWAIT
,
1293 server
.syslog_facility
);
1296 server
.current_client
= NULL
;
1297 server
.clients
= listCreate();
1298 server
.clients_to_close
= listCreate();
1299 server
.slaves
= listCreate();
1300 server
.monitors
= listCreate();
1301 server
.unblocked_clients
= listCreate();
1302 server
.ready_keys
= listCreate();
1304 createSharedObjects();
1305 adjustOpenFilesLimit();
1306 server
.el
= aeCreateEventLoop(server
.maxclients
+1024);
1307 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1309 if (server
.port
!= 0) {
1310 server
.ipfd
= anetTcpServer(server
.neterr
,server
.port
,server
.bindaddr
);
1311 if (server
.ipfd
== ANET_ERR
) {
1312 redisLog(REDIS_WARNING
, "Opening port %d: %s",
1313 server
.port
, server
.neterr
);
1317 if (server
.unixsocket
!= NULL
) {
1318 unlink(server
.unixsocket
); /* don't care if this fails */
1319 server
.sofd
= anetUnixServer(server
.neterr
,server
.unixsocket
,server
.unixsocketperm
);
1320 if (server
.sofd
== ANET_ERR
) {
1321 redisLog(REDIS_WARNING
, "Opening socket: %s", server
.neterr
);
1325 if (server
.ipfd
< 0 && server
.sofd
< 0) {
1326 redisLog(REDIS_WARNING
, "Configured to not listen anywhere, exiting.");
1329 for (j
= 0; j
< server
.dbnum
; j
++) {
1330 server
.db
[j
].dict
= dictCreate(&dbDictType
,NULL
);
1331 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1332 server
.db
[j
].blocking_keys
= dictCreate(&keylistDictType
,NULL
);
1333 server
.db
[j
].ready_keys
= dictCreate(&setDictType
,NULL
);
1334 server
.db
[j
].watched_keys
= dictCreate(&keylistDictType
,NULL
);
1335 server
.db
[j
].id
= j
;
1337 server
.pubsub_channels
= dictCreate(&keylistDictType
,NULL
);
1338 server
.pubsub_patterns
= listCreate();
1339 listSetFreeMethod(server
.pubsub_patterns
,freePubsubPattern
);
1340 listSetMatchMethod(server
.pubsub_patterns
,listMatchPubsubPattern
);
1341 server
.cronloops
= 0;
1342 server
.rdb_child_pid
= -1;
1343 server
.aof_child_pid
= -1;
1344 aofRewriteBufferReset();
1345 server
.aof_buf
= sdsempty();
1346 server
.lastsave
= time(NULL
);
1347 server
.rdb_save_time_last
= -1;
1348 server
.rdb_save_time_start
= -1;
1350 server
.stat_numcommands
= 0;
1351 server
.stat_numconnections
= 0;
1352 server
.stat_expiredkeys
= 0;
1353 server
.stat_evictedkeys
= 0;
1354 server
.stat_starttime
= time(NULL
);
1355 server
.stat_keyspace_misses
= 0;
1356 server
.stat_keyspace_hits
= 0;
1357 server
.stat_peak_memory
= 0;
1358 server
.stat_fork_time
= 0;
1359 server
.stat_rejected_conn
= 0;
1360 memset(server
.ops_sec_samples
,0,sizeof(server
.ops_sec_samples
));
1361 server
.ops_sec_idx
= 0;
1362 server
.ops_sec_last_sample_time
= mstime();
1363 server
.ops_sec_last_sample_ops
= 0;
1364 server
.unixtime
= time(NULL
);
1365 server
.lastbgsave_status
= REDIS_OK
;
1366 server
.stop_writes_on_bgsave_err
= 1;
1367 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1368 if (server
.ipfd
> 0 && aeCreateFileEvent(server
.el
,server
.ipfd
,AE_READABLE
,
1369 acceptTcpHandler
,NULL
) == AE_ERR
) redisPanic("Unrecoverable error creating server.ipfd file event.");
1370 if (server
.sofd
> 0 && aeCreateFileEvent(server
.el
,server
.sofd
,AE_READABLE
,
1371 acceptUnixHandler
,NULL
) == AE_ERR
) redisPanic("Unrecoverable error creating server.sofd file event.");
1373 if (server
.aof_state
== REDIS_AOF_ON
) {
1374 server
.aof_fd
= open(server
.aof_filename
,
1375 O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1376 if (server
.aof_fd
== -1) {
1377 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1383 /* 32 bit instances are limited to 4GB of address space, so if there is
1384 * no explicit limit in the user provided configuration we set a limit
1385 * at 3 GB using maxmemory with 'noeviction' policy'. This avoids
1386 * useless crashes of the Redis instance for out of memory. */
1387 if (server
.arch_bits
== 32 && server
.maxmemory
== 0) {
1388 redisLog(REDIS_WARNING
,"Warning: 32 bit instance detected but no memory limit set. Setting 3 GB maxmemory limit with 'noeviction' policy now.");
1389 server
.maxmemory
= 3072LL*(1024*1024); /* 3 GB */
1390 server
.maxmemory_policy
= REDIS_MAXMEMORY_NO_EVICTION
;
1393 if (server
.cluster_enabled
) clusterInit();
1399 /* Populates the Redis Command Table starting from the hard coded list
1400 * we have on top of redis.c file. */
1401 void populateCommandTable(void) {
1403 int numcommands
= sizeof(redisCommandTable
)/sizeof(struct redisCommand
);
1405 for (j
= 0; j
< numcommands
; j
++) {
1406 struct redisCommand
*c
= redisCommandTable
+j
;
1407 char *f
= c
->sflags
;
1412 case 'w': c
->flags
|= REDIS_CMD_WRITE
; break;
1413 case 'r': c
->flags
|= REDIS_CMD_READONLY
; break;
1414 case 'm': c
->flags
|= REDIS_CMD_DENYOOM
; break;
1415 case 'a': c
->flags
|= REDIS_CMD_ADMIN
; break;
1416 case 'p': c
->flags
|= REDIS_CMD_PUBSUB
; break;
1417 case 'f': c
->flags
|= REDIS_CMD_FORCE_REPLICATION
; break;
1418 case 's': c
->flags
|= REDIS_CMD_NOSCRIPT
; break;
1419 case 'R': c
->flags
|= REDIS_CMD_RANDOM
; break;
1420 case 'S': c
->flags
|= REDIS_CMD_SORT_FOR_SCRIPT
; break;
1421 case 'l': c
->flags
|= REDIS_CMD_LOADING
; break;
1422 case 't': c
->flags
|= REDIS_CMD_STALE
; break;
1423 case 'M': c
->flags
|= REDIS_CMD_SKIP_MONITOR
; break;
1424 default: redisPanic("Unsupported command flag"); break;
1429 retval
= dictAdd(server
.commands
, sdsnew(c
->name
), c
);
1430 assert(retval
== DICT_OK
);
1434 void resetCommandTableStats(void) {
1435 int numcommands
= sizeof(redisCommandTable
)/sizeof(struct redisCommand
);
1438 for (j
= 0; j
< numcommands
; j
++) {
1439 struct redisCommand
*c
= redisCommandTable
+j
;
1441 c
->microseconds
= 0;
1446 /* ========================== Redis OP Array API ============================ */
1448 void redisOpArrayInit(redisOpArray
*oa
) {
1453 int redisOpArrayAppend(redisOpArray
*oa
, struct redisCommand
*cmd
, int dbid
,
1454 robj
**argv
, int argc
, int target
)
1458 oa
->ops
= zrealloc(oa
->ops
,sizeof(redisOp
)*(oa
->numops
+1));
1459 op
= oa
->ops
+oa
->numops
;
1464 op
->target
= target
;
1469 void redisOpArrayFree(redisOpArray
*oa
) {
1475 op
= oa
->ops
+oa
->numops
;
1476 for (j
= 0; j
< op
->argc
; j
++)
1477 decrRefCount(op
->argv
[j
]);
1483 /* ====================== Commands lookup and execution ===================== */
1485 struct redisCommand
*lookupCommand(sds name
) {
1486 return dictFetchValue(server
.commands
, name
);
1489 struct redisCommand
*lookupCommandByCString(char *s
) {
1490 struct redisCommand
*cmd
;
1491 sds name
= sdsnew(s
);
1493 cmd
= dictFetchValue(server
.commands
, name
);
1498 /* Propagate the specified command (in the context of the specified database id)
1499 * to AOF and Slaves.
1501 * flags are an xor between:
1502 * + REDIS_PROPAGATE_NONE (no propagation of command at all)
1503 * + REDIS_PROPAGATE_AOF (propagate into the AOF file if is enabled)
1504 * + REDIS_PROPAGATE_REPL (propagate into the replication link)
1506 void propagate(struct redisCommand
*cmd
, int dbid
, robj
**argv
, int argc
,
1509 if (server
.aof_state
!= REDIS_AOF_OFF
&& flags
& REDIS_PROPAGATE_AOF
)
1510 feedAppendOnlyFile(cmd
,dbid
,argv
,argc
);
1511 if (flags
& REDIS_PROPAGATE_REPL
&& listLength(server
.slaves
))
1512 replicationFeedSlaves(server
.slaves
,dbid
,argv
,argc
);
1515 /* Used inside commands to schedule the propagation of additional commands
1516 * after the current command is propagated to AOF / Replication. */
1517 void alsoPropagate(struct redisCommand
*cmd
, int dbid
, robj
**argv
, int argc
,
1520 redisOpArrayAppend(&server
.also_propagate
,cmd
,dbid
,argv
,argc
,target
);
1523 /* Call() is the core of Redis execution of a command */
1524 void call(redisClient
*c
, int flags
) {
1525 long long dirty
, start
= ustime(), duration
;
1527 /* Sent the command to clients in MONITOR mode, only if the commands are
1528 * not geneated from reading an AOF. */
1529 if (listLength(server
.monitors
) &&
1531 !(c
->cmd
->flags
& REDIS_CMD_SKIP_MONITOR
))
1533 replicationFeedMonitors(c
,server
.monitors
,c
->db
->id
,c
->argv
,c
->argc
);
1536 /* Call the command. */
1537 redisOpArrayInit(&server
.also_propagate
);
1538 dirty
= server
.dirty
;
1540 dirty
= server
.dirty
-dirty
;
1541 duration
= ustime()-start
;
1543 /* When EVAL is called loading the AOF we don't want commands called
1544 * from Lua to go into the slowlog or to populate statistics. */
1545 if (server
.loading
&& c
->flags
& REDIS_LUA_CLIENT
)
1546 flags
&= ~(REDIS_CALL_SLOWLOG
| REDIS_CALL_STATS
);
1548 /* Log the command into the Slow log if needed, and populate the
1549 * per-command statistics that we show in INFO commandstats. */
1550 if (flags
& REDIS_CALL_SLOWLOG
)
1551 slowlogPushEntryIfNeeded(c
->argv
,c
->argc
,duration
);
1552 if (flags
& REDIS_CALL_STATS
) {
1553 c
->cmd
->microseconds
+= duration
;
1557 /* Propagate the command into the AOF and replication link */
1558 if (flags
& REDIS_CALL_PROPAGATE
) {
1559 int flags
= REDIS_PROPAGATE_NONE
;
1561 if (c
->cmd
->flags
& REDIS_CMD_FORCE_REPLICATION
)
1562 flags
|= REDIS_PROPAGATE_REPL
;
1564 flags
|= (REDIS_PROPAGATE_REPL
| REDIS_PROPAGATE_AOF
);
1565 if (flags
!= REDIS_PROPAGATE_NONE
)
1566 propagate(c
->cmd
,c
->db
->id
,c
->argv
,c
->argc
,flags
);
1568 /* Commands such as LPUSH or BRPOPLPUSH may propagate an additional
1570 if (server
.also_propagate
.numops
) {
1574 for (j
= 0; j
< server
.also_propagate
.numops
; j
++) {
1575 rop
= &server
.also_propagate
.ops
[j
];
1576 propagate(rop
->cmd
, rop
->dbid
, rop
->argv
, rop
->argc
, rop
->target
);
1578 redisOpArrayFree(&server
.also_propagate
);
1580 server
.stat_numcommands
++;
1583 /* If this function gets called we already read a whole
1584 * command, arguments are in the client argv/argc fields.
1585 * processCommand() execute the command or prepare the
1586 * server for a bulk read from the client.
1588 * If 1 is returned the client is still alive and valid and
1589 * and other operations can be performed by the caller. Otherwise
1590 * if 0 is returned the client was destroied (i.e. after QUIT). */
1591 int processCommand(redisClient
*c
) {
1592 /* The QUIT command is handled separately. Normal command procs will
1593 * go through checking for replication and QUIT will cause trouble
1594 * when FORCE_REPLICATION is enabled and would be implemented in
1595 * a regular command proc. */
1596 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
1597 addReply(c
,shared
.ok
);
1598 c
->flags
|= REDIS_CLOSE_AFTER_REPLY
;
1602 /* Now lookup the command and check ASAP about trivial error conditions
1603 * such as wrong arity, bad command name and so forth. */
1604 c
->cmd
= c
->lastcmd
= lookupCommand(c
->argv
[0]->ptr
);
1607 addReplyErrorFormat(c
,"unknown command '%s'",
1608 (char*)c
->argv
[0]->ptr
);
1610 } else if ((c
->cmd
->arity
> 0 && c
->cmd
->arity
!= c
->argc
) ||
1611 (c
->argc
< -c
->cmd
->arity
)) {
1613 addReplyErrorFormat(c
,"wrong number of arguments for '%s' command",
1618 /* Check if the user is authenticated */
1619 if (server
.requirepass
&& !c
->authenticated
&& c
->cmd
->proc
!= authCommand
)
1622 addReplyError(c
,"operation not permitted");
1626 /* If cluster is enabled, redirect here */
1627 if (server
.cluster_enabled
&&
1628 !(c
->cmd
->getkeys_proc
== NULL
&& c
->cmd
->firstkey
== 0)) {
1631 if (server
.cluster
.state
!= REDIS_CLUSTER_OK
) {
1632 addReplyError(c
,"The cluster is down. Check with CLUSTER INFO for more information");
1636 clusterNode
*n
= getNodeByQuery(c
,c
->cmd
,c
->argv
,c
->argc
,&hashslot
,&ask
);
1638 addReplyError(c
,"Multi keys request invalid in cluster");
1640 } else if (n
!= server
.cluster
.myself
) {
1641 addReplySds(c
,sdscatprintf(sdsempty(),
1642 "-%s %d %s:%d\r\n", ask
? "ASK" : "MOVED",
1643 hashslot
,n
->ip
,n
->port
));
1649 /* Handle the maxmemory directive.
1651 * First we try to free some memory if possible (if there are volatile
1652 * keys in the dataset). If there are not the only thing we can do
1653 * is returning an error. */
1654 if (server
.maxmemory
) {
1655 int retval
= freeMemoryIfNeeded();
1656 if ((c
->cmd
->flags
& REDIS_CMD_DENYOOM
) && retval
== REDIS_ERR
) {
1658 addReply(c
, shared
.oomerr
);
1663 /* Don't accept write commands if there are problems persisting on disk. */
1664 if (server
.stop_writes_on_bgsave_err
&&
1665 server
.saveparamslen
> 0
1666 && server
.lastbgsave_status
== REDIS_ERR
&&
1667 c
->cmd
->flags
& REDIS_CMD_WRITE
)
1670 addReply(c
, shared
.bgsaveerr
);
1674 /* Don't accept write commands if this is a read only slave. But
1675 * accept write commands if this is our master. */
1676 if (server
.masterhost
&& server
.repl_slave_ro
&&
1677 !(c
->flags
& REDIS_MASTER
) &&
1678 c
->cmd
->flags
& REDIS_CMD_WRITE
)
1680 addReply(c
, shared
.roslaveerr
);
1684 /* Only allow SUBSCRIBE and UNSUBSCRIBE in the context of Pub/Sub */
1685 if ((dictSize(c
->pubsub_channels
) > 0 || listLength(c
->pubsub_patterns
) > 0)
1687 c
->cmd
->proc
!= subscribeCommand
&&
1688 c
->cmd
->proc
!= unsubscribeCommand
&&
1689 c
->cmd
->proc
!= psubscribeCommand
&&
1690 c
->cmd
->proc
!= punsubscribeCommand
) {
1691 addReplyError(c
,"only (P)SUBSCRIBE / (P)UNSUBSCRIBE / QUIT allowed in this context");
1695 /* Only allow INFO and SLAVEOF when slave-serve-stale-data is no and
1696 * we are a slave with a broken link with master. */
1697 if (server
.masterhost
&& server
.repl_state
!= REDIS_REPL_CONNECTED
&&
1698 server
.repl_serve_stale_data
== 0 &&
1699 !(c
->cmd
->flags
& REDIS_CMD_STALE
))
1702 addReply(c
, shared
.masterdownerr
);
1706 /* Loading DB? Return an error if the command has not the
1707 * REDIS_CMD_LOADING flag. */
1708 if (server
.loading
&& !(c
->cmd
->flags
& REDIS_CMD_LOADING
)) {
1709 addReply(c
, shared
.loadingerr
);
1713 /* Lua script too slow? Only allow commands with REDIS_CMD_STALE flag. */
1714 if (server
.lua_timedout
&&
1715 c
->cmd
->proc
!= authCommand
&&
1716 !(c
->cmd
->proc
== shutdownCommand
&&
1718 tolower(((char*)c
->argv
[1]->ptr
)[0]) == 'n') &&
1719 !(c
->cmd
->proc
== scriptCommand
&&
1721 tolower(((char*)c
->argv
[1]->ptr
)[0]) == 'k'))
1724 addReply(c
, shared
.slowscripterr
);
1728 /* Exec the command */
1729 if (c
->flags
& REDIS_MULTI
&&
1730 c
->cmd
->proc
!= execCommand
&& c
->cmd
->proc
!= discardCommand
&&
1731 c
->cmd
->proc
!= multiCommand
&& c
->cmd
->proc
!= watchCommand
)
1733 queueMultiCommand(c
);
1734 addReply(c
,shared
.queued
);
1736 call(c
,REDIS_CALL_FULL
);
1737 if (listLength(server
.ready_keys
))
1738 handleClientsBlockedOnLists();
1743 /*================================== Shutdown =============================== */
1745 int prepareForShutdown(int flags
) {
1746 int save
= flags
& REDIS_SHUTDOWN_SAVE
;
1747 int nosave
= flags
& REDIS_SHUTDOWN_NOSAVE
;
1749 redisLog(REDIS_WARNING
,"User requested shutdown...");
1750 /* Kill the saving child if there is a background saving in progress.
1751 We want to avoid race conditions, for instance our saving child may
1752 overwrite the synchronous saving did by SHUTDOWN. */
1753 if (server
.rdb_child_pid
!= -1) {
1754 redisLog(REDIS_WARNING
,"There is a child saving an .rdb. Killing it!");
1755 kill(server
.rdb_child_pid
,SIGKILL
);
1756 rdbRemoveTempFile(server
.rdb_child_pid
);
1758 if (server
.aof_state
!= REDIS_AOF_OFF
) {
1759 /* Kill the AOF saving child as the AOF we already have may be longer
1760 * but contains the full dataset anyway. */
1761 if (server
.aof_child_pid
!= -1) {
1762 redisLog(REDIS_WARNING
,
1763 "There is a child rewriting the AOF. Killing it!");
1764 kill(server
.aof_child_pid
,SIGKILL
);
1766 /* Append only file: fsync() the AOF and exit */
1767 redisLog(REDIS_NOTICE
,"Calling fsync() on the AOF file.");
1768 aof_fsync(server
.aof_fd
);
1770 if ((server
.saveparamslen
> 0 && !nosave
) || save
) {
1771 redisLog(REDIS_NOTICE
,"Saving the final RDB snapshot before exiting.");
1772 /* Snapshotting. Perform a SYNC SAVE and exit */
1773 if (rdbSave(server
.rdb_filename
) != REDIS_OK
) {
1774 /* Ooops.. error saving! The best we can do is to continue
1775 * operating. Note that if there was a background saving process,
1776 * in the next cron() Redis will be notified that the background
1777 * saving aborted, handling special stuff like slaves pending for
1778 * synchronization... */
1779 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit.");
1783 if (server
.daemonize
) {
1784 redisLog(REDIS_NOTICE
,"Removing the pid file.");
1785 unlink(server
.pidfile
);
1787 /* Close the listening sockets. Apparently this allows faster restarts. */
1788 if (server
.ipfd
!= -1) close(server
.ipfd
);
1789 if (server
.sofd
!= -1) close(server
.sofd
);
1790 if (server
.unixsocket
) {
1791 redisLog(REDIS_NOTICE
,"Removing the unix socket file.");
1792 unlink(server
.unixsocket
); /* don't care if this fails */
1795 redisLog(REDIS_WARNING
,"Redis is now ready to exit, bye bye...");
1799 /*================================== Commands =============================== */
1801 /* Return zero if strings are the same, non-zero if they are not.
1802 * The comparison is performed in a way that prevents an attacker to obtain
1803 * information about the nature of the strings just monitoring the execution
1804 * time of the function.
1806 * Note that limiting the comparison length to strings up to 512 bytes we
1807 * can avoid leaking any information about the password length and any
1808 * possible branch misprediction related leak.
1810 int time_independent_strcmp(char *a
, char *b
) {
1811 char bufa
[REDIS_AUTHPASS_MAX_LEN
], bufb
[REDIS_AUTHPASS_MAX_LEN
];
1812 /* The above two strlen perform len(a) + len(b) operations where either
1813 * a or b are fixed (our password) length, and the difference is only
1814 * relative to the length of the user provided string, so no information
1815 * leak is possible in the following two lines of code. */
1816 int alen
= strlen(a
);
1817 int blen
= strlen(b
);
1821 /* We can't compare strings longer than our static buffers.
1822 * Note that this will never pass the first test in practical circumstances
1823 * so there is no info leak. */
1824 if (alen
> sizeof(bufa
) || blen
> sizeof(bufb
)) return 1;
1826 memset(bufa
,0,sizeof(bufa
)); /* Constant time. */
1827 memset(bufb
,0,sizeof(bufb
)); /* Constant time. */
1828 /* Again the time of the following two copies is proportional to
1829 * len(a) + len(b) so no info is leaked. */
1830 memcpy(bufa
,a
,alen
);
1831 memcpy(bufb
,b
,blen
);
1833 /* Always compare all the chars in the two buffers without
1834 * conditional expressions. */
1835 for (j
= 0; j
< sizeof(bufa
); j
++) {
1836 diff
|= (bufa
[j
] ^ bufb
[j
]);
1838 /* Length must be equal as well. */
1839 diff
|= alen
^ blen
;
1840 return diff
; /* If zero strings are the same. */
1843 void authCommand(redisClient
*c
) {
1844 if (!server
.requirepass
) {
1845 addReplyError(c
,"Client sent AUTH, but no password is set");
1846 } else if (!time_independent_strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
1847 c
->authenticated
= 1;
1848 addReply(c
,shared
.ok
);
1850 c
->authenticated
= 0;
1851 addReplyError(c
,"invalid password");
1855 void pingCommand(redisClient
*c
) {
1856 addReply(c
,shared
.pong
);
1859 void echoCommand(redisClient
*c
) {
1860 addReplyBulk(c
,c
->argv
[1]);
1863 void timeCommand(redisClient
*c
) {
1866 /* gettimeofday() can only fail if &tv is a bad addresss so we
1867 * don't check for errors. */
1868 gettimeofday(&tv
,NULL
);
1869 addReplyMultiBulkLen(c
,2);
1870 addReplyBulkLongLong(c
,tv
.tv_sec
);
1871 addReplyBulkLongLong(c
,tv
.tv_usec
);
1874 /* Convert an amount of bytes into a human readable string in the form
1875 * of 100B, 2G, 100M, 4K, and so forth. */
1876 void bytesToHuman(char *s
, unsigned long long n
) {
1881 sprintf(s
,"%lluB",n
);
1883 } else if (n
< (1024*1024)) {
1884 d
= (double)n
/(1024);
1885 sprintf(s
,"%.2fK",d
);
1886 } else if (n
< (1024LL*1024*1024)) {
1887 d
= (double)n
/(1024*1024);
1888 sprintf(s
,"%.2fM",d
);
1889 } else if (n
< (1024LL*1024*1024*1024)) {
1890 d
= (double)n
/(1024LL*1024*1024);
1891 sprintf(s
,"%.2fG",d
);
1895 /* Create the string returned by the INFO command. This is decoupled
1896 * by the INFO command itself as we need to report the same information
1897 * on memory corruption problems. */
1898 sds
genRedisInfoString(char *section
) {
1899 sds info
= sdsempty();
1900 time_t uptime
= server
.unixtime
-server
.stat_starttime
;
1902 struct rusage self_ru
, c_ru
;
1903 unsigned long lol
, bib
;
1904 int allsections
= 0, defsections
= 0;
1908 allsections
= strcasecmp(section
,"all") == 0;
1909 defsections
= strcasecmp(section
,"default") == 0;
1912 getrusage(RUSAGE_SELF
, &self_ru
);
1913 getrusage(RUSAGE_CHILDREN
, &c_ru
);
1914 getClientsMaxBuffers(&lol
,&bib
);
1917 if (allsections
|| defsections
|| !strcasecmp(section
,"server")) {
1918 struct utsname name
;
1921 if (server
.cluster_enabled
) mode
= "cluster";
1922 else if (server
.sentinel_mode
) mode
= "sentinel";
1923 else mode
= "standalone";
1925 if (sections
++) info
= sdscat(info
,"\r\n");
1927 info
= sdscatprintf(info
,
1929 "redis_version:%s\r\n"
1930 "redis_git_sha1:%s\r\n"
1931 "redis_git_dirty:%d\r\n"
1935 "multiplexing_api:%s\r\n"
1936 "gcc_version:%d.%d.%d\r\n"
1937 "process_id:%ld\r\n"
1940 "uptime_in_seconds:%ld\r\n"
1941 "uptime_in_days:%ld\r\n"
1942 "lru_clock:%ld\r\n",
1945 strtol(redisGitDirty(),NULL
,10) > 0,
1947 name
.sysname
, name
.release
, name
.machine
,
1951 __GNUC__
,__GNUC_MINOR__
,__GNUC_PATCHLEVEL__
,
1960 (unsigned long) server
.lruclock
);
1964 if (allsections
|| defsections
|| !strcasecmp(section
,"clients")) {
1965 if (sections
++) info
= sdscat(info
,"\r\n");
1966 info
= sdscatprintf(info
,
1968 "connected_clients:%lu\r\n"
1969 "client_longest_output_list:%lu\r\n"
1970 "client_biggest_input_buf:%lu\r\n"
1971 "blocked_clients:%d\r\n",
1972 listLength(server
.clients
)-listLength(server
.slaves
),
1974 server
.bpop_blocked_clients
);
1978 if (allsections
|| defsections
|| !strcasecmp(section
,"memory")) {
1982 bytesToHuman(hmem
,zmalloc_used_memory());
1983 bytesToHuman(peak_hmem
,server
.stat_peak_memory
);
1984 if (sections
++) info
= sdscat(info
,"\r\n");
1985 info
= sdscatprintf(info
,
1987 "used_memory:%zu\r\n"
1988 "used_memory_human:%s\r\n"
1989 "used_memory_rss:%zu\r\n"
1990 "used_memory_peak:%zu\r\n"
1991 "used_memory_peak_human:%s\r\n"
1992 "used_memory_lua:%lld\r\n"
1993 "mem_fragmentation_ratio:%.2f\r\n"
1994 "mem_allocator:%s\r\n",
1995 zmalloc_used_memory(),
1998 server
.stat_peak_memory
,
2000 ((long long)lua_gc(server
.lua
,LUA_GCCOUNT
,0))*1024LL,
2001 zmalloc_get_fragmentation_ratio(),
2007 if (allsections
|| defsections
|| !strcasecmp(section
,"persistence")) {
2008 if (sections
++) info
= sdscat(info
,"\r\n");
2009 info
= sdscatprintf(info
,
2012 "rdb_changes_since_last_save:%lld\r\n"
2013 "rdb_bgsave_in_progress:%d\r\n"
2014 "rdb_last_save_time:%ld\r\n"
2015 "rdb_last_bgsave_status:%s\r\n"
2016 "rdb_last_bgsave_time_sec:%ld\r\n"
2017 "rdb_current_bgsave_time_sec:%ld\r\n"
2018 "aof_enabled:%d\r\n"
2019 "aof_rewrite_in_progress:%d\r\n"
2020 "aof_rewrite_scheduled:%d\r\n"
2021 "aof_last_rewrite_time_sec:%ld\r\n"
2022 "aof_current_rewrite_time_sec:%ld\r\n"
2023 "aof_last_bgrewrite_status:%s\r\n",
2026 server
.rdb_child_pid
!= -1,
2028 (server
.lastbgsave_status
== REDIS_OK
) ? "ok" : "err",
2029 server
.rdb_save_time_last
,
2030 (server
.rdb_child_pid
== -1) ?
2031 -1 : time(NULL
)-server
.rdb_save_time_start
,
2032 server
.aof_state
!= REDIS_AOF_OFF
,
2033 server
.aof_child_pid
!= -1,
2034 server
.aof_rewrite_scheduled
,
2035 server
.aof_rewrite_time_last
,
2036 (server
.aof_child_pid
== -1) ?
2037 -1 : time(NULL
)-server
.aof_rewrite_time_start
,
2038 (server
.aof_lastbgrewrite_status
== REDIS_OK
) ? "ok" : "err");
2040 if (server
.aof_state
!= REDIS_AOF_OFF
) {
2041 info
= sdscatprintf(info
,
2042 "aof_current_size:%lld\r\n"
2043 "aof_base_size:%lld\r\n"
2044 "aof_pending_rewrite:%d\r\n"
2045 "aof_buffer_length:%zu\r\n"
2046 "aof_rewrite_buffer_length:%lu\r\n"
2047 "aof_pending_bio_fsync:%llu\r\n"
2048 "aof_delayed_fsync:%lu\r\n",
2049 (long long) server
.aof_current_size
,
2050 (long long) server
.aof_rewrite_base_size
,
2051 server
.aof_rewrite_scheduled
,
2052 sdslen(server
.aof_buf
),
2053 aofRewriteBufferSize(),
2054 bioPendingJobsOfType(REDIS_BIO_AOF_FSYNC
),
2055 server
.aof_delayed_fsync
);
2058 if (server
.loading
) {
2060 time_t eta
, elapsed
;
2061 off_t remaining_bytes
= server
.loading_total_bytes
-
2062 server
.loading_loaded_bytes
;
2064 perc
= ((double)server
.loading_loaded_bytes
/
2065 server
.loading_total_bytes
) * 100;
2067 elapsed
= server
.unixtime
-server
.loading_start_time
;
2069 eta
= 1; /* A fake 1 second figure if we don't have
2072 eta
= (elapsed
*remaining_bytes
)/server
.loading_loaded_bytes
;
2075 info
= sdscatprintf(info
,
2076 "loading_start_time:%ld\r\n"
2077 "loading_total_bytes:%llu\r\n"
2078 "loading_loaded_bytes:%llu\r\n"
2079 "loading_loaded_perc:%.2f\r\n"
2080 "loading_eta_seconds:%ld\r\n"
2081 ,(unsigned long) server
.loading_start_time
,
2082 (unsigned long long) server
.loading_total_bytes
,
2083 (unsigned long long) server
.loading_loaded_bytes
,
2091 if (allsections
|| defsections
|| !strcasecmp(section
,"stats")) {
2092 if (sections
++) info
= sdscat(info
,"\r\n");
2093 info
= sdscatprintf(info
,
2095 "total_connections_received:%lld\r\n"
2096 "total_commands_processed:%lld\r\n"
2097 "instantaneous_ops_per_sec:%lld\r\n"
2098 "rejected_connections:%lld\r\n"
2099 "expired_keys:%lld\r\n"
2100 "evicted_keys:%lld\r\n"
2101 "keyspace_hits:%lld\r\n"
2102 "keyspace_misses:%lld\r\n"
2103 "pubsub_channels:%ld\r\n"
2104 "pubsub_patterns:%lu\r\n"
2105 "latest_fork_usec:%lld\r\n"
2106 "migrate_cached_sockets:%ld\r\n",
2107 server
.stat_numconnections
,
2108 server
.stat_numcommands
,
2109 getOperationsPerSecond(),
2110 server
.stat_rejected_conn
,
2111 server
.stat_expiredkeys
,
2112 server
.stat_evictedkeys
,
2113 server
.stat_keyspace_hits
,
2114 server
.stat_keyspace_misses
,
2115 dictSize(server
.pubsub_channels
),
2116 listLength(server
.pubsub_patterns
),
2117 server
.stat_fork_time
,
2118 dictSize(server
.migrate_cached_sockets
));
2122 if (allsections
|| defsections
|| !strcasecmp(section
,"replication")) {
2123 if (sections
++) info
= sdscat(info
,"\r\n");
2124 info
= sdscatprintf(info
,
2127 server
.masterhost
== NULL
? "master" : "slave");
2128 if (server
.masterhost
) {
2129 info
= sdscatprintf(info
,
2130 "master_host:%s\r\n"
2131 "master_port:%d\r\n"
2132 "master_link_status:%s\r\n"
2133 "master_last_io_seconds_ago:%d\r\n"
2134 "master_sync_in_progress:%d\r\n"
2137 (server
.repl_state
== REDIS_REPL_CONNECTED
) ?
2140 ((int)(server
.unixtime
-server
.master
->lastinteraction
)) : -1,
2141 server
.repl_state
== REDIS_REPL_TRANSFER
2144 if (server
.repl_state
== REDIS_REPL_TRANSFER
) {
2145 info
= sdscatprintf(info
,
2146 "master_sync_left_bytes:%lld\r\n"
2147 "master_sync_last_io_seconds_ago:%d\r\n"
2149 (server
.repl_transfer_size
- server
.repl_transfer_read
),
2150 (int)(server
.unixtime
-server
.repl_transfer_lastio
)
2154 if (server
.repl_state
!= REDIS_REPL_CONNECTED
) {
2155 info
= sdscatprintf(info
,
2156 "master_link_down_since_seconds:%ld\r\n",
2157 (long)server
.unixtime
-server
.repl_down_since
);
2159 info
= sdscatprintf(info
,
2160 "slave_priority:%d\r\n"
2161 "slave_read_only:%d\r\n",
2162 server
.slave_priority
,
2163 server
.repl_slave_ro
);
2165 info
= sdscatprintf(info
,
2166 "connected_slaves:%lu\r\n",
2167 listLength(server
.slaves
));
2168 if (listLength(server
.slaves
)) {
2173 listRewind(server
.slaves
,&li
);
2174 while((ln
= listNext(&li
))) {
2175 redisClient
*slave
= listNodeValue(ln
);
2180 if (anetPeerToString(slave
->fd
,ip
,&port
) == -1) continue;
2181 switch(slave
->replstate
) {
2182 case REDIS_REPL_WAIT_BGSAVE_START
:
2183 case REDIS_REPL_WAIT_BGSAVE_END
:
2184 state
= "wait_bgsave";
2186 case REDIS_REPL_SEND_BULK
:
2187 state
= "send_bulk";
2189 case REDIS_REPL_ONLINE
:
2193 if (state
== NULL
) continue;
2194 info
= sdscatprintf(info
,"slave%d:%s,%d,%s\r\n",
2195 slaveid
,ip
,slave
->slave_listening_port
,state
);
2202 if (allsections
|| defsections
|| !strcasecmp(section
,"cpu")) {
2203 if (sections
++) info
= sdscat(info
,"\r\n");
2204 info
= sdscatprintf(info
,
2206 "used_cpu_sys:%.2f\r\n"
2207 "used_cpu_user:%.2f\r\n"
2208 "used_cpu_sys_children:%.2f\r\n"
2209 "used_cpu_user_children:%.2f\r\n",
2210 (float)self_ru
.ru_stime
.tv_sec
+(float)self_ru
.ru_stime
.tv_usec
/1000000,
2211 (float)self_ru
.ru_utime
.tv_sec
+(float)self_ru
.ru_utime
.tv_usec
/1000000,
2212 (float)c_ru
.ru_stime
.tv_sec
+(float)c_ru
.ru_stime
.tv_usec
/1000000,
2213 (float)c_ru
.ru_utime
.tv_sec
+(float)c_ru
.ru_utime
.tv_usec
/1000000);
2217 if (allsections
|| !strcasecmp(section
,"commandstats")) {
2218 if (sections
++) info
= sdscat(info
,"\r\n");
2219 info
= sdscatprintf(info
, "# Commandstats\r\n");
2220 numcommands
= sizeof(redisCommandTable
)/sizeof(struct redisCommand
);
2221 for (j
= 0; j
< numcommands
; j
++) {
2222 struct redisCommand
*c
= redisCommandTable
+j
;
2224 if (!c
->calls
) continue;
2225 info
= sdscatprintf(info
,
2226 "cmdstat_%s:calls=%lld,usec=%lld,usec_per_call=%.2f\r\n",
2227 c
->name
, c
->calls
, c
->microseconds
,
2228 (c
->calls
== 0) ? 0 : ((float)c
->microseconds
/c
->calls
));
2233 if (allsections
|| defsections
|| !strcasecmp(section
,"cluster")) {
2234 if (sections
++) info
= sdscat(info
,"\r\n");
2235 info
= sdscatprintf(info
,
2237 "cluster_enabled:%d\r\n",
2238 server
.cluster_enabled
);
2242 if (allsections
|| defsections
|| !strcasecmp(section
,"keyspace")) {
2243 if (sections
++) info
= sdscat(info
,"\r\n");
2244 info
= sdscatprintf(info
, "# Keyspace\r\n");
2245 for (j
= 0; j
< server
.dbnum
; j
++) {
2246 long long keys
, vkeys
;
2248 keys
= dictSize(server
.db
[j
].dict
);
2249 vkeys
= dictSize(server
.db
[j
].expires
);
2250 if (keys
|| vkeys
) {
2251 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
2259 void infoCommand(redisClient
*c
) {
2260 char *section
= c
->argc
== 2 ? c
->argv
[1]->ptr
: "default";
2263 addReply(c
,shared
.syntaxerr
);
2266 sds info
= genRedisInfoString(section
);
2267 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
2268 (unsigned long)sdslen(info
)));
2269 addReplySds(c
,info
);
2270 addReply(c
,shared
.crlf
);
2273 void monitorCommand(redisClient
*c
) {
2274 /* ignore MONITOR if already slave or in monitor mode */
2275 if (c
->flags
& REDIS_SLAVE
) return;
2277 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
2279 listAddNodeTail(server
.monitors
,c
);
2280 addReply(c
,shared
.ok
);
2283 /* ============================ Maxmemory directive ======================== */
2285 /* This function gets called when 'maxmemory' is set on the config file to limit
2286 * the max memory used by the server, before processing a command.
2288 * The goal of the function is to free enough memory to keep Redis under the
2289 * configured memory limit.
2291 * The function starts calculating how many bytes should be freed to keep
2292 * Redis under the limit, and enters a loop selecting the best keys to
2293 * evict accordingly to the configured policy.
2295 * If all the bytes needed to return back under the limit were freed the
2296 * function returns REDIS_OK, otherwise REDIS_ERR is returned, and the caller
2297 * should block the execution of commands that will result in more memory
2298 * used by the server.
2300 int freeMemoryIfNeeded(void) {
2301 size_t mem_used
, mem_tofree
, mem_freed
;
2302 int slaves
= listLength(server
.slaves
);
2304 /* Remove the size of slaves output buffers and AOF buffer from the
2305 * count of used memory. */
2306 mem_used
= zmalloc_used_memory();
2311 listRewind(server
.slaves
,&li
);
2312 while((ln
= listNext(&li
))) {
2313 redisClient
*slave
= listNodeValue(ln
);
2314 unsigned long obuf_bytes
= getClientOutputBufferMemoryUsage(slave
);
2315 if (obuf_bytes
> mem_used
)
2318 mem_used
-= obuf_bytes
;
2321 if (server
.aof_state
!= REDIS_AOF_OFF
) {
2322 mem_used
-= sdslen(server
.aof_buf
);
2323 mem_used
-= aofRewriteBufferSize();
2326 /* Check if we are over the memory limit. */
2327 if (mem_used
<= server
.maxmemory
) return REDIS_OK
;
2329 if (server
.maxmemory_policy
== REDIS_MAXMEMORY_NO_EVICTION
)
2330 return REDIS_ERR
; /* We need to free memory, but policy forbids. */
2332 /* Compute how much memory we need to free. */
2333 mem_tofree
= mem_used
- server
.maxmemory
;
2335 while (mem_freed
< mem_tofree
) {
2336 int j
, k
, keys_freed
= 0;
2338 for (j
= 0; j
< server
.dbnum
; j
++) {
2339 long bestval
= 0; /* just to prevent warning */
2341 struct dictEntry
*de
;
2342 redisDb
*db
= server
.db
+j
;
2345 if (server
.maxmemory_policy
== REDIS_MAXMEMORY_ALLKEYS_LRU
||
2346 server
.maxmemory_policy
== REDIS_MAXMEMORY_ALLKEYS_RANDOM
)
2348 dict
= server
.db
[j
].dict
;
2350 dict
= server
.db
[j
].expires
;
2352 if (dictSize(dict
) == 0) continue;
2354 /* volatile-random and allkeys-random policy */
2355 if (server
.maxmemory_policy
== REDIS_MAXMEMORY_ALLKEYS_RANDOM
||
2356 server
.maxmemory_policy
== REDIS_MAXMEMORY_VOLATILE_RANDOM
)
2358 de
= dictGetRandomKey(dict
);
2359 bestkey
= dictGetKey(de
);
2362 /* volatile-lru and allkeys-lru policy */
2363 else if (server
.maxmemory_policy
== REDIS_MAXMEMORY_ALLKEYS_LRU
||
2364 server
.maxmemory_policy
== REDIS_MAXMEMORY_VOLATILE_LRU
)
2366 for (k
= 0; k
< server
.maxmemory_samples
; k
++) {
2371 de
= dictGetRandomKey(dict
);
2372 thiskey
= dictGetKey(de
);
2373 /* When policy is volatile-lru we need an additional lookup
2374 * to locate the real key, as dict is set to db->expires. */
2375 if (server
.maxmemory_policy
== REDIS_MAXMEMORY_VOLATILE_LRU
)
2376 de
= dictFind(db
->dict
, thiskey
);
2378 thisval
= estimateObjectIdleTime(o
);
2380 /* Higher idle time is better candidate for deletion */
2381 if (bestkey
== NULL
|| thisval
> bestval
) {
2389 else if (server
.maxmemory_policy
== REDIS_MAXMEMORY_VOLATILE_TTL
) {
2390 for (k
= 0; k
< server
.maxmemory_samples
; k
++) {
2394 de
= dictGetRandomKey(dict
);
2395 thiskey
= dictGetKey(de
);
2396 thisval
= (long) dictGetVal(de
);
2398 /* Expire sooner (minor expire unix timestamp) is better
2399 * candidate for deletion */
2400 if (bestkey
== NULL
|| thisval
< bestval
) {
2407 /* Finally remove the selected key. */
2411 robj
*keyobj
= createStringObject(bestkey
,sdslen(bestkey
));
2412 propagateExpire(db
,keyobj
);
2413 /* We compute the amount of memory freed by dbDelete() alone.
2414 * It is possible that actually the memory needed to propagate
2415 * the DEL in AOF and replication link is greater than the one
2416 * we are freeing removing the key, but we can't account for
2417 * that otherwise we would never exit the loop.
2419 * AOF and Output buffer memory will be freed eventually so
2420 * we only care about memory used by the key space. */
2421 delta
= (long long) zmalloc_used_memory();
2422 dbDelete(db
,keyobj
);
2423 delta
-= (long long) zmalloc_used_memory();
2425 server
.stat_evictedkeys
++;
2426 decrRefCount(keyobj
);
2429 /* When the memory to free starts to be big enough, we may
2430 * start spending so much time here that is impossible to
2431 * deliver data to the slaves fast enough, so we force the
2432 * transmission here inside the loop. */
2433 if (slaves
) flushSlavesOutputBuffers();
2436 if (!keys_freed
) return REDIS_ERR
; /* nothing to free... */
2441 /* =================================== Main! ================================ */
2444 int linuxOvercommitMemoryValue(void) {
2445 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
2449 if (fgets(buf
,64,fp
) == NULL
) {
2458 void linuxOvercommitMemoryWarning(void) {
2459 if (linuxOvercommitMemoryValue() == 0) {
2460 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.");
2463 #endif /* __linux__ */
2465 void createPidFile(void) {
2466 /* Try to write the pid file in a best-effort way. */
2467 FILE *fp
= fopen(server
.pidfile
,"w");
2469 fprintf(fp
,"%d\n",(int)getpid());
2474 void daemonize(void) {
2477 if (fork() != 0) exit(0); /* parent exits */
2478 setsid(); /* create a new session */
2480 /* Every output goes to /dev/null. If Redis is daemonized but
2481 * the 'logfile' is set to 'stdout' in the configuration file
2482 * it will not log at all. */
2483 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
2484 dup2(fd
, STDIN_FILENO
);
2485 dup2(fd
, STDOUT_FILENO
);
2486 dup2(fd
, STDERR_FILENO
);
2487 if (fd
> STDERR_FILENO
) close(fd
);
2492 printf("Redis server v=%s sha=%s:%d malloc=%s bits=%d\n",
2495 atoi(redisGitDirty()) > 0,
2497 sizeof(long) == 4 ? 32 : 64);
2502 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf] [options]\n");
2503 fprintf(stderr
," ./redis-server - (read config from stdin)\n");
2504 fprintf(stderr
," ./redis-server -v or --version\n");
2505 fprintf(stderr
," ./redis-server -h or --help\n");
2506 fprintf(stderr
," ./redis-server --test-memory <megabytes>\n\n");
2507 fprintf(stderr
,"Examples:\n");
2508 fprintf(stderr
," ./redis-server (run the server with default conf)\n");
2509 fprintf(stderr
," ./redis-server /etc/redis/6379.conf\n");
2510 fprintf(stderr
," ./redis-server --port 7777\n");
2511 fprintf(stderr
," ./redis-server --port 7777 --slaveof 127.0.0.1 8888\n");
2512 fprintf(stderr
," ./redis-server /etc/myredis.conf --loglevel verbose\n\n");
2513 fprintf(stderr
,"Sentinel mode:\n");
2514 fprintf(stderr
," ./redis-server /etc/sentinel.conf --sentinel\n");
2518 void redisAsciiArt(void) {
2519 #include "asciilogo.h"
2520 char *buf
= zmalloc(1024*16);
2521 char *mode
= "stand alone";
2523 if (server
.cluster_enabled
) mode
= "cluster";
2524 else if (server
.sentinel_mode
) mode
= "sentinel";
2526 snprintf(buf
,1024*16,ascii_logo
,
2529 strtol(redisGitDirty(),NULL
,10) > 0,
2530 (sizeof(long) == 8) ? "64" : "32",
2534 redisLogRaw(REDIS_NOTICE
|REDIS_LOG_RAW
,buf
);
2538 static void sigtermHandler(int sig
) {
2541 redisLogFromHandler(REDIS_WARNING
,"Received SIGTERM, scheduling shutdown...");
2542 server
.shutdown_asap
= 1;
2545 void setupSignalHandlers(void) {
2546 struct sigaction act
;
2548 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction is used.
2549 * Otherwise, sa_handler is used. */
2550 sigemptyset(&act
.sa_mask
);
2552 act
.sa_handler
= sigtermHandler
;
2553 sigaction(SIGTERM
, &act
, NULL
);
2555 #ifdef HAVE_BACKTRACE
2556 sigemptyset(&act
.sa_mask
);
2557 act
.sa_flags
= SA_NODEFER
| SA_RESETHAND
| SA_SIGINFO
;
2558 act
.sa_sigaction
= sigsegvHandler
;
2559 sigaction(SIGSEGV
, &act
, NULL
);
2560 sigaction(SIGBUS
, &act
, NULL
);
2561 sigaction(SIGFPE
, &act
, NULL
);
2562 sigaction(SIGILL
, &act
, NULL
);
2567 void memtest(size_t megabytes
, int passes
);
2569 /* Returns 1 if there is --sentinel among the arguments or if
2570 * argv[0] is exactly "redis-sentinel". */
2571 int checkForSentinelMode(int argc
, char **argv
) {
2574 if (strstr(argv
[0],"redis-sentinel") != NULL
) return 1;
2575 for (j
= 1; j
< argc
; j
++)
2576 if (!strcmp(argv
[j
],"--sentinel")) return 1;
2580 /* Function called at startup to load RDB or AOF file in memory. */
2581 void loadDataFromDisk(void) {
2582 long long start
= ustime();
2583 if (server
.aof_state
== REDIS_AOF_ON
) {
2584 if (loadAppendOnlyFile(server
.aof_filename
) == REDIS_OK
)
2585 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %.3f seconds",(float)(ustime()-start
)/1000000);
2587 if (rdbLoad(server
.rdb_filename
) == REDIS_OK
) {
2588 redisLog(REDIS_NOTICE
,"DB loaded from disk: %.3f seconds",
2589 (float)(ustime()-start
)/1000000);
2590 } else if (errno
!= ENOENT
) {
2591 redisLog(REDIS_WARNING
,"Fatal error loading the DB. Exiting.");
2597 void redisOutOfMemoryHandler(size_t allocation_size
) {
2598 redisLog(REDIS_WARNING
,"Out Of Memory allocating %zu bytes!",
2603 int main(int argc
, char **argv
) {
2606 /* We need to initialize our libraries, and the server configuration. */
2607 zmalloc_enable_thread_safeness();
2608 zmalloc_set_oom_handler(redisOutOfMemoryHandler
);
2609 srand(time(NULL
)^getpid());
2610 gettimeofday(&tv
,NULL
);
2611 dictSetHashFunctionSeed(tv
.tv_sec
^tv
.tv_usec
^getpid());
2612 server
.sentinel_mode
= checkForSentinelMode(argc
,argv
);
2615 /* We need to init sentinel right now as parsing the configuration file
2616 * in sentinel mode will have the effect of populating the sentinel
2617 * data structures with master nodes to monitor. */
2618 if (server
.sentinel_mode
) {
2619 initSentinelConfig();
2624 int j
= 1; /* First option to parse in argv[] */
2625 sds options
= sdsempty();
2626 char *configfile
= NULL
;
2628 /* Handle special options --help and --version */
2629 if (strcmp(argv
[1], "-v") == 0 ||
2630 strcmp(argv
[1], "--version") == 0) version();
2631 if (strcmp(argv
[1], "--help") == 0 ||
2632 strcmp(argv
[1], "-h") == 0) usage();
2633 if (strcmp(argv
[1], "--test-memory") == 0) {
2635 memtest(atoi(argv
[2]),50);
2638 fprintf(stderr
,"Please specify the amount of memory to test in megabytes.\n");
2639 fprintf(stderr
,"Example: ./redis-server --test-memory 4096\n\n");
2644 /* First argument is the config file name? */
2645 if (argv
[j
][0] != '-' || argv
[j
][1] != '-')
2646 configfile
= argv
[j
++];
2647 /* All the other options are parsed and conceptually appended to the
2648 * configuration file. For instance --port 6380 will generate the
2649 * string "port 6380\n" to be parsed after the actual file name
2650 * is parsed, if any. */
2652 if (argv
[j
][0] == '-' && argv
[j
][1] == '-') {
2654 if (sdslen(options
)) options
= sdscat(options
,"\n");
2655 options
= sdscat(options
,argv
[j
]+2);
2656 options
= sdscat(options
," ");
2658 /* Option argument */
2659 options
= sdscatrepr(options
,argv
[j
],strlen(argv
[j
]));
2660 options
= sdscat(options
," ");
2664 resetServerSaveParams();
2665 loadServerConfig(configfile
,options
);
2668 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");
2670 if (server
.daemonize
) daemonize();
2672 if (server
.daemonize
) createPidFile();
2675 if (!server
.sentinel_mode
) {
2676 /* Things only needed when not running in Sentinel mode. */
2677 redisLog(REDIS_WARNING
,"Server started, Redis version " REDIS_VERSION
);
2679 linuxOvercommitMemoryWarning();
2682 if (server
.ipfd
> 0)
2683 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
2684 if (server
.sofd
> 0)
2685 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections at %s", server
.unixsocket
);
2688 /* Warning the user about suspicious maxmemory setting. */
2689 if (server
.maxmemory
> 0 && server
.maxmemory
< 1024*1024) {
2690 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
);
2693 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
2695 aeDeleteEventLoop(server
.el
);