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. */
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 /* Migrate cache dict type. */
565 dictType migrateCacheDictType
= {
566 dictSdsHash
, /* hash function */
569 dictSdsKeyCompare
, /* key compare */
570 dictSdsDestructor
, /* key destructor */
571 NULL
/* val destructor */
574 int htNeedsResize(dict
*dict
) {
575 long long size
, used
;
577 size
= dictSlots(dict
);
578 used
= dictSize(dict
);
579 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
580 (used
*100/size
< REDIS_HT_MINFILL
));
583 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
584 * we resize the hash table to save memory */
585 void tryResizeHashTables(void) {
588 for (j
= 0; j
< server
.dbnum
; j
++) {
589 if (htNeedsResize(server
.db
[j
].dict
))
590 dictResize(server
.db
[j
].dict
);
591 if (htNeedsResize(server
.db
[j
].expires
))
592 dictResize(server
.db
[j
].expires
);
596 /* Our hash table implementation performs rehashing incrementally while
597 * we write/read from the hash table. Still if the server is idle, the hash
598 * table will use two tables for a long time. So we try to use 1 millisecond
599 * of CPU time at every serverCron() loop in order to rehash some key. */
600 void incrementallyRehash(void) {
603 for (j
= 0; j
< server
.dbnum
; j
++) {
604 /* Keys dictionary */
605 if (dictIsRehashing(server
.db
[j
].dict
)) {
606 dictRehashMilliseconds(server
.db
[j
].dict
,1);
607 break; /* already used our millisecond for this loop... */
610 if (dictIsRehashing(server
.db
[j
].expires
)) {
611 dictRehashMilliseconds(server
.db
[j
].expires
,1);
612 break; /* already used our millisecond for this loop... */
617 /* This function is called once a background process of some kind terminates,
618 * as we want to avoid resizing the hash tables when there is a child in order
619 * to play well with copy-on-write (otherwise when a resize happens lots of
620 * memory pages are copied). The goal of this function is to update the ability
621 * for dict.c to resize the hash tables accordingly to the fact we have o not
623 void updateDictResizePolicy(void) {
624 if (server
.rdb_child_pid
== -1 && server
.aof_child_pid
== -1)
630 /* ======================= Cron: called every 100 ms ======================== */
632 /* Try to expire a few timed out keys. The algorithm used is adaptive and
633 * will use few CPU cycles if there are few expiring keys, otherwise
634 * it will get more aggressive to avoid that too much memory is used by
635 * keys that can be removed from the keyspace. */
636 void activeExpireCycle(void) {
637 int j
, iteration
= 0;
638 long long start
= ustime(), timelimit
;
640 /* We can use at max REDIS_EXPIRELOOKUPS_TIME_PERC percentage of CPU time
641 * per iteration. Since this function gets called with a frequency of
642 * REDIS_HZ times per second, the following is the max amount of
643 * microseconds we can spend in this function. */
644 timelimit
= 1000000*REDIS_EXPIRELOOKUPS_TIME_PERC
/REDIS_HZ
/100;
645 if (timelimit
<= 0) timelimit
= 1;
647 for (j
= 0; j
< server
.dbnum
; j
++) {
649 redisDb
*db
= server
.db
+j
;
651 /* Continue to expire if at the end of the cycle more than 25%
652 * of the keys were expired. */
654 unsigned long num
= dictSize(db
->expires
);
655 unsigned long slots
= dictSlots(db
->expires
);
656 long long now
= mstime();
658 /* When there are less than 1% filled slots getting random
659 * keys is expensive, so stop here waiting for better times...
660 * The dictionary will be resized asap. */
661 if (num
&& slots
> DICT_HT_INITIAL_SIZE
&&
662 (num
*100/slots
< 1)) break;
664 /* The main collection cycle. Sample random keys among keys
665 * with an expire set, checking for expired ones. */
667 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
668 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
673 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
674 t
= dictGetSignedIntegerVal(de
);
676 sds key
= dictGetKey(de
);
677 robj
*keyobj
= createStringObject(key
,sdslen(key
));
679 propagateExpire(db
,keyobj
);
681 decrRefCount(keyobj
);
683 server
.stat_expiredkeys
++;
686 /* We can't block forever here even if there are many keys to
687 * expire. So after a given amount of milliseconds return to the
688 * caller waiting for the other active expire cycle. */
690 if ((iteration
& 0xf) == 0 && /* check once every 16 cycles. */
691 (ustime()-start
) > timelimit
) return;
692 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
696 void updateLRUClock(void) {
697 server
.lruclock
= (server
.unixtime
/REDIS_LRU_CLOCK_RESOLUTION
) &
702 /* Add a sample to the operations per second array of samples. */
703 void trackOperationsPerSecond(void) {
704 long long t
= mstime() - server
.ops_sec_last_sample_time
;
705 long long ops
= server
.stat_numcommands
- server
.ops_sec_last_sample_ops
;
708 ops_sec
= t
> 0 ? (ops
*1000/t
) : 0;
710 server
.ops_sec_samples
[server
.ops_sec_idx
] = ops_sec
;
711 server
.ops_sec_idx
= (server
.ops_sec_idx
+1) % REDIS_OPS_SEC_SAMPLES
;
712 server
.ops_sec_last_sample_time
= mstime();
713 server
.ops_sec_last_sample_ops
= server
.stat_numcommands
;
716 /* Return the mean of all the samples. */
717 long long getOperationsPerSecond(void) {
721 for (j
= 0; j
< REDIS_OPS_SEC_SAMPLES
; j
++)
722 sum
+= server
.ops_sec_samples
[j
];
723 return sum
/ REDIS_OPS_SEC_SAMPLES
;
726 /* Check for timeouts. Returns non-zero if the client was terminated */
727 int clientsCronHandleTimeout(redisClient
*c
) {
728 time_t now
= server
.unixtime
;
730 if (server
.maxidletime
&&
731 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
732 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
733 !(c
->flags
& REDIS_BLOCKED
) && /* no timeout for BLPOP */
734 dictSize(c
->pubsub_channels
) == 0 && /* no timeout for pubsub */
735 listLength(c
->pubsub_patterns
) == 0 &&
736 (now
- c
->lastinteraction
> server
.maxidletime
))
738 redisLog(REDIS_VERBOSE
,"Closing idle client");
741 } else if (c
->flags
& REDIS_BLOCKED
) {
742 if (c
->bpop
.timeout
!= 0 && c
->bpop
.timeout
< now
) {
743 addReply(c
,shared
.nullmultibulk
);
744 unblockClientWaitingData(c
);
750 /* The client query buffer is an sds.c string that can end with a lot of
751 * free space not used, this function reclaims space if needed.
753 * The funciton always returns 0 as it never terminates the client. */
754 int clientsCronResizeQueryBuffer(redisClient
*c
) {
755 size_t querybuf_size
= sdsAllocSize(c
->querybuf
);
756 time_t idletime
= server
.unixtime
- c
->lastinteraction
;
758 /* There are two conditions to resize the query buffer:
759 * 1) Query buffer is > BIG_ARG and too big for latest peak.
760 * 2) Client is inactive and the buffer is bigger than 1k. */
761 if (((querybuf_size
> REDIS_MBULK_BIG_ARG
) &&
762 (querybuf_size
/(c
->querybuf_peak
+1)) > 2) ||
763 (querybuf_size
> 1024 && idletime
> 2))
765 /* Only resize the query buffer if it is actually wasting space. */
766 if (sdsavail(c
->querybuf
) > 1024) {
767 c
->querybuf
= sdsRemoveFreeSpace(c
->querybuf
);
770 /* Reset the peak again to capture the peak memory usage in the next
772 c
->querybuf_peak
= 0;
776 void clientsCron(void) {
777 /* Make sure to process at least 1/(REDIS_HZ*10) of clients per call.
778 * Since this function is called REDIS_HZ times per second we are sure that
779 * in the worst case we process all the clients in 10 seconds.
780 * In normal conditions (a reasonable number of clients) we process
781 * all the clients in a shorter time. */
782 int numclients
= listLength(server
.clients
);
783 int iterations
= numclients
/(REDIS_HZ
*10);
786 iterations
= (numclients
< 50) ? numclients
: 50;
787 while(listLength(server
.clients
) && iterations
--) {
791 /* Rotate the list, take the current head, process.
792 * This way if the client must be removed from the list it's the
793 * first element and we don't incur into O(N) computation. */
794 listRotate(server
.clients
);
795 head
= listFirst(server
.clients
);
796 c
= listNodeValue(head
);
797 /* The following functions do different service checks on the client.
798 * The protocol is that they return non-zero if the client was
800 if (clientsCronHandleTimeout(c
)) continue;
801 if (clientsCronResizeQueryBuffer(c
)) continue;
805 /* This is our timer interrupt, called REDIS_HZ times per second.
806 * Here is where we do a number of things that need to be done asynchronously.
809 * - Active expired keys collection (it is also performed in a lazy way on
811 * - Software watchdong.
812 * - Update some statistic.
813 * - Incremental rehashing of the DBs hash tables.
814 * - Triggering BGSAVE / AOF rewrite, and handling of terminated children.
815 * - Clients timeout of differnet kinds.
816 * - Replication reconnection.
819 * Everything directly called here will be called REDIS_HZ times per second,
820 * so in order to throttle execution of things we want to do less frequently
821 * a macro is used: run_with_period(milliseconds) { .... }
824 int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
826 REDIS_NOTUSED(eventLoop
);
828 REDIS_NOTUSED(clientData
);
830 /* Software watchdog: deliver the SIGALRM that will reach the signal
831 * handler if we don't return here fast enough. */
832 if (server
.watchdog_period
) watchdogScheduleSignal(server
.watchdog_period
);
834 /* We take a cached value of the unix time in the global state because
835 * with virtual memory and aging there is to store the current time
836 * in objects at every object access, and accuracy is not needed.
837 * To access a global var is faster than calling time(NULL) */
838 server
.unixtime
= time(NULL
);
840 run_with_period(100) trackOperationsPerSecond();
842 /* We have just 22 bits per object for LRU information.
843 * So we use an (eventually wrapping) LRU clock with 10 seconds resolution.
844 * 2^22 bits with 10 seconds resoluton is more or less 1.5 years.
846 * Note that even if this will wrap after 1.5 years it's not a problem,
847 * everything will still work but just some object will appear younger
848 * to Redis. But for this to happen a given object should never be touched
851 * Note that you can change the resolution altering the
852 * REDIS_LRU_CLOCK_RESOLUTION define.
856 /* Record the max memory used since the server was started. */
857 if (zmalloc_used_memory() > server
.stat_peak_memory
)
858 server
.stat_peak_memory
= zmalloc_used_memory();
860 /* We received a SIGTERM, shutting down here in a safe way, as it is
861 * not ok doing so inside the signal handler. */
862 if (server
.shutdown_asap
) {
863 if (prepareForShutdown(0) == REDIS_OK
) exit(0);
864 redisLog(REDIS_WARNING
,"SIGTERM received but errors trying to shut down the server, check the logs for more information");
867 /* Show some info about non-empty databases */
868 run_with_period(5000) {
869 for (j
= 0; j
< server
.dbnum
; j
++) {
870 long long size
, used
, vkeys
;
872 size
= dictSlots(server
.db
[j
].dict
);
873 used
= dictSize(server
.db
[j
].dict
);
874 vkeys
= dictSize(server
.db
[j
].expires
);
876 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
877 /* dictPrintStats(server.dict); */
882 /* We don't want to resize the hash tables while a bacground saving
883 * is in progress: the saving child is created using fork() that is
884 * implemented with a copy-on-write semantic in most modern systems, so
885 * if we resize the HT while there is the saving child at work actually
886 * a lot of memory movements in the parent will cause a lot of pages
888 if (server
.rdb_child_pid
== -1 && server
.aof_child_pid
== -1) {
889 tryResizeHashTables();
890 if (server
.activerehashing
) incrementallyRehash();
893 /* Show information about connected clients */
894 if (!server
.sentinel_mode
) {
895 run_with_period(5000) {
896 redisLog(REDIS_VERBOSE
,
897 "%d clients connected (%d slaves), %zu bytes in use",
898 listLength(server
.clients
)-listLength(server
.slaves
),
899 listLength(server
.slaves
),
900 zmalloc_used_memory());
904 /* We need to do a few operations on clients asynchronously. */
907 /* Start a scheduled AOF rewrite if this was requested by the user while
908 * a BGSAVE was in progress. */
909 if (server
.rdb_child_pid
== -1 && server
.aof_child_pid
== -1 &&
910 server
.aof_rewrite_scheduled
)
912 rewriteAppendOnlyFileBackground();
915 /* Check if a background saving or AOF rewrite in progress terminated. */
916 if (server
.rdb_child_pid
!= -1 || server
.aof_child_pid
!= -1) {
920 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
921 int exitcode
= WEXITSTATUS(statloc
);
924 if (WIFSIGNALED(statloc
)) bysignal
= WTERMSIG(statloc
);
926 if (pid
== server
.rdb_child_pid
) {
927 backgroundSaveDoneHandler(exitcode
,bysignal
);
928 } else if (pid
== server
.aof_child_pid
) {
929 backgroundRewriteDoneHandler(exitcode
,bysignal
);
931 redisLog(REDIS_WARNING
,
932 "Warning, detected child with unmatched pid: %ld",
935 updateDictResizePolicy();
938 /* If there is not a background saving/rewrite in progress check if
939 * we have to save/rewrite now */
940 for (j
= 0; j
< server
.saveparamslen
; j
++) {
941 struct saveparam
*sp
= server
.saveparams
+j
;
943 if (server
.dirty
>= sp
->changes
&&
944 server
.unixtime
-server
.lastsave
> sp
->seconds
) {
945 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
946 sp
->changes
, sp
->seconds
);
947 rdbSaveBackground(server
.rdb_filename
);
952 /* Trigger an AOF rewrite if needed */
953 if (server
.rdb_child_pid
== -1 &&
954 server
.aof_child_pid
== -1 &&
955 server
.aof_rewrite_perc
&&
956 server
.aof_current_size
> server
.aof_rewrite_min_size
)
958 long long base
= server
.aof_rewrite_base_size
?
959 server
.aof_rewrite_base_size
: 1;
960 long long growth
= (server
.aof_current_size
*100/base
) - 100;
961 if (growth
>= server
.aof_rewrite_perc
) {
962 redisLog(REDIS_NOTICE
,"Starting automatic rewriting of AOF on %lld%% growth",growth
);
963 rewriteAppendOnlyFileBackground();
969 /* If we postponed an AOF buffer flush, let's try to do it every time the
970 * cron function is called. */
971 if (server
.aof_flush_postponed_start
) flushAppendOnlyFile(0);
973 /* Expire a few keys per cycle, only if this is a master.
974 * On slaves we wait for DEL operations synthesized by the master
975 * in order to guarantee a strict consistency. */
976 if (server
.masterhost
== NULL
) activeExpireCycle();
978 /* Close clients that need to be closed asynchronous */
979 freeClientsInAsyncFreeQueue();
981 /* Replication cron function -- used to reconnect to master and
982 * to detect transfer failures. */
983 run_with_period(1000) replicationCron();
985 /* Run the Redis Cluster cron. */
986 run_with_period(1000) {
987 if (server
.cluster_enabled
) clusterCron();
990 /* Run the Sentinel timer if we are in sentinel mode. */
991 run_with_period(100) {
992 if (server
.sentinel_mode
) sentinelTimer();
995 /* Cleanup expired MIGRATE cached sockets. */
996 run_with_period(1000) {
997 migrateCloseTimedoutSockets();
1001 return 1000/REDIS_HZ
;
1004 /* This function gets called every time Redis is entering the
1005 * main loop of the event driven library, that is, before to sleep
1006 * for ready file descriptors. */
1007 void beforeSleep(struct aeEventLoop
*eventLoop
) {
1008 REDIS_NOTUSED(eventLoop
);
1012 /* Try to process pending commands for clients that were just unblocked. */
1013 while (listLength(server
.unblocked_clients
)) {
1014 ln
= listFirst(server
.unblocked_clients
);
1015 redisAssert(ln
!= NULL
);
1017 listDelNode(server
.unblocked_clients
,ln
);
1018 c
->flags
&= ~REDIS_UNBLOCKED
;
1020 /* Process remaining data in the input buffer. */
1021 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) {
1022 server
.current_client
= c
;
1023 processInputBuffer(c
);
1024 server
.current_client
= NULL
;
1028 /* Write the AOF buffer on disk */
1029 flushAppendOnlyFile(0);
1032 /* =========================== Server initialization ======================== */
1034 void createSharedObjects(void) {
1037 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1038 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1039 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1040 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1041 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1042 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1043 shared
.cnegone
= createObject(REDIS_STRING
,sdsnew(":-1\r\n"));
1044 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1045 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1046 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1047 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1048 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1049 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1050 "-WRONGTYPE Operation against a key holding the wrong kind of value\r\n"));
1051 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1052 "-ERR no such key\r\n"));
1053 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1054 "-ERR syntax error\r\n"));
1055 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1056 "-ERR source and destination objects are the same\r\n"));
1057 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1058 "-ERR index out of range\r\n"));
1059 shared
.noscripterr
= createObject(REDIS_STRING
,sdsnew(
1060 "-NOSCRIPT No matching script. Please use EVAL.\r\n"));
1061 shared
.loadingerr
= createObject(REDIS_STRING
,sdsnew(
1062 "-LOADING Redis is loading the dataset in memory\r\n"));
1063 shared
.slowscripterr
= createObject(REDIS_STRING
,sdsnew(
1064 "-BUSY Redis is busy running a script. You can only call SCRIPT KILL or SHUTDOWN NOSAVE.\r\n"));
1065 shared
.masterdownerr
= createObject(REDIS_STRING
,sdsnew(
1066 "-MASTERDOWN Link with MASTER is down and slave-serve-stale-data is set to 'no'.\r\n"));
1067 shared
.bgsaveerr
= createObject(REDIS_STRING
,sdsnew(
1068 "-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"));
1069 shared
.roslaveerr
= createObject(REDIS_STRING
,sdsnew(
1070 "-READONLY You can't write against a read only slave.\r\n"));
1071 shared
.oomerr
= createObject(REDIS_STRING
,sdsnew(
1072 "-OOM command not allowed when used memory > 'maxmemory'.\r\n"));
1073 shared
.execaborterr
= createObject(REDIS_STRING
,sdsnew(
1074 "-EXECABORT Transaction discarded because of previous errors.\r\n"));
1075 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1076 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1077 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1079 for (j
= 0; j
< REDIS_SHARED_SELECT_CMDS
; j
++) {
1080 shared
.select
[j
] = createObject(REDIS_STRING
,
1081 sdscatprintf(sdsempty(),"select %d\r\n", j
));
1083 shared
.messagebulk
= createStringObject("$7\r\nmessage\r\n",13);
1084 shared
.pmessagebulk
= createStringObject("$8\r\npmessage\r\n",14);
1085 shared
.subscribebulk
= createStringObject("$9\r\nsubscribe\r\n",15);
1086 shared
.unsubscribebulk
= createStringObject("$11\r\nunsubscribe\r\n",18);
1087 shared
.psubscribebulk
= createStringObject("$10\r\npsubscribe\r\n",17);
1088 shared
.punsubscribebulk
= createStringObject("$12\r\npunsubscribe\r\n",19);
1089 shared
.del
= createStringObject("DEL",3);
1090 shared
.rpop
= createStringObject("RPOP",4);
1091 shared
.lpop
= createStringObject("LPOP",4);
1092 shared
.lpush
= createStringObject("LPUSH",5);
1093 for (j
= 0; j
< REDIS_SHARED_INTEGERS
; j
++) {
1094 shared
.integers
[j
] = createObject(REDIS_STRING
,(void*)(long)j
);
1095 shared
.integers
[j
]->encoding
= REDIS_ENCODING_INT
;
1097 for (j
= 0; j
< REDIS_SHARED_BULKHDR_LEN
; j
++) {
1098 shared
.mbulkhdr
[j
] = createObject(REDIS_STRING
,
1099 sdscatprintf(sdsempty(),"*%d\r\n",j
));
1100 shared
.bulkhdr
[j
] = createObject(REDIS_STRING
,
1101 sdscatprintf(sdsempty(),"$%d\r\n",j
));
1105 void initServerConfig() {
1106 getRandomHexChars(server
.runid
,REDIS_RUN_ID_SIZE
);
1107 server
.runid
[REDIS_RUN_ID_SIZE
] = '\0';
1108 server
.arch_bits
= (sizeof(long) == 8) ? 64 : 32;
1109 server
.port
= REDIS_SERVERPORT
;
1110 server
.bindaddr
= NULL
;
1111 server
.unixsocket
= NULL
;
1112 server
.unixsocketperm
= 0;
1115 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1116 server
.verbosity
= REDIS_NOTICE
;
1117 server
.maxidletime
= REDIS_MAXIDLETIME
;
1118 server
.client_max_querybuf_len
= REDIS_MAX_QUERYBUF_LEN
;
1119 server
.saveparams
= NULL
;
1121 server
.logfile
= NULL
; /* NULL = log on standard output */
1122 server
.syslog_enabled
= 0;
1123 server
.syslog_ident
= zstrdup("redis");
1124 server
.syslog_facility
= LOG_LOCAL0
;
1125 server
.daemonize
= 0;
1126 server
.aof_state
= REDIS_AOF_OFF
;
1127 server
.aof_fsync
= AOF_FSYNC_EVERYSEC
;
1128 server
.aof_no_fsync_on_rewrite
= 0;
1129 server
.aof_rewrite_perc
= REDIS_AOF_REWRITE_PERC
;
1130 server
.aof_rewrite_min_size
= REDIS_AOF_REWRITE_MIN_SIZE
;
1131 server
.aof_rewrite_base_size
= 0;
1132 server
.aof_rewrite_scheduled
= 0;
1133 server
.aof_last_fsync
= time(NULL
);
1134 server
.aof_rewrite_time_last
= -1;
1135 server
.aof_rewrite_time_start
= -1;
1136 server
.aof_lastbgrewrite_status
= REDIS_OK
;
1137 server
.aof_delayed_fsync
= 0;
1139 server
.aof_selected_db
= -1; /* Make sure the first time will not match */
1140 server
.aof_flush_postponed_start
= 0;
1141 server
.pidfile
= zstrdup("/var/run/redis.pid");
1142 server
.rdb_filename
= zstrdup("dump.rdb");
1143 server
.aof_filename
= zstrdup("appendonly.aof");
1144 server
.requirepass
= NULL
;
1145 server
.rdb_compression
= 1;
1146 server
.rdb_checksum
= 1;
1147 server
.activerehashing
= 1;
1148 server
.maxclients
= REDIS_MAX_CLIENTS
;
1149 server
.bpop_blocked_clients
= 0;
1150 server
.maxmemory
= 0;
1151 server
.maxmemory_policy
= REDIS_MAXMEMORY_VOLATILE_LRU
;
1152 server
.maxmemory_samples
= 3;
1153 server
.hash_max_ziplist_entries
= REDIS_HASH_MAX_ZIPLIST_ENTRIES
;
1154 server
.hash_max_ziplist_value
= REDIS_HASH_MAX_ZIPLIST_VALUE
;
1155 server
.list_max_ziplist_entries
= REDIS_LIST_MAX_ZIPLIST_ENTRIES
;
1156 server
.list_max_ziplist_value
= REDIS_LIST_MAX_ZIPLIST_VALUE
;
1157 server
.set_max_intset_entries
= REDIS_SET_MAX_INTSET_ENTRIES
;
1158 server
.zset_max_ziplist_entries
= REDIS_ZSET_MAX_ZIPLIST_ENTRIES
;
1159 server
.zset_max_ziplist_value
= REDIS_ZSET_MAX_ZIPLIST_VALUE
;
1160 server
.shutdown_asap
= 0;
1161 server
.repl_ping_slave_period
= REDIS_REPL_PING_SLAVE_PERIOD
;
1162 server
.repl_timeout
= REDIS_REPL_TIMEOUT
;
1163 server
.cluster_enabled
= 0;
1164 server
.cluster
.configfile
= zstrdup("nodes.conf");
1165 server
.lua_caller
= NULL
;
1166 server
.lua_time_limit
= REDIS_LUA_TIME_LIMIT
;
1167 server
.lua_client
= NULL
;
1168 server
.lua_timedout
= 0;
1169 server
.migrate_cached_sockets
= dictCreate(&migrateCacheDictType
,NULL
);
1172 resetServerSaveParams();
1174 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1175 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1176 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1177 /* Replication related */
1178 server
.masterauth
= NULL
;
1179 server
.masterhost
= NULL
;
1180 server
.masterport
= 6379;
1181 server
.master
= NULL
;
1182 server
.repl_state
= REDIS_REPL_NONE
;
1183 server
.repl_syncio_timeout
= REDIS_REPL_SYNCIO_TIMEOUT
;
1184 server
.repl_serve_stale_data
= 1;
1185 server
.repl_slave_ro
= 1;
1186 server
.repl_down_since
= time(NULL
);
1187 server
.slave_priority
= REDIS_DEFAULT_SLAVE_PRIORITY
;
1189 /* Client output buffer limits */
1190 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_NORMAL
].hard_limit_bytes
= 0;
1191 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_NORMAL
].soft_limit_bytes
= 0;
1192 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_NORMAL
].soft_limit_seconds
= 0;
1193 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_SLAVE
].hard_limit_bytes
= 1024*1024*256;
1194 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_SLAVE
].soft_limit_bytes
= 1024*1024*64;
1195 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_SLAVE
].soft_limit_seconds
= 60;
1196 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_PUBSUB
].hard_limit_bytes
= 1024*1024*32;
1197 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_PUBSUB
].soft_limit_bytes
= 1024*1024*8;
1198 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_PUBSUB
].soft_limit_seconds
= 60;
1200 /* Double constants initialization */
1202 R_PosInf
= 1.0/R_Zero
;
1203 R_NegInf
= -1.0/R_Zero
;
1204 R_Nan
= R_Zero
/R_Zero
;
1206 /* Command table -- we intiialize it here as it is part of the
1207 * initial configuration, since command names may be changed via
1208 * redis.conf using the rename-command directive. */
1209 server
.commands
= dictCreate(&commandTableDictType
,NULL
);
1210 populateCommandTable();
1211 server
.delCommand
= lookupCommandByCString("del");
1212 server
.multiCommand
= lookupCommandByCString("multi");
1213 server
.lpushCommand
= lookupCommandByCString("lpush");
1214 server
.lpopCommand
= lookupCommandByCString("lpop");
1215 server
.rpopCommand
= lookupCommandByCString("rpop");
1218 server
.slowlog_log_slower_than
= REDIS_SLOWLOG_LOG_SLOWER_THAN
;
1219 server
.slowlog_max_len
= REDIS_SLOWLOG_MAX_LEN
;
1222 server
.assert_failed
= "<no assertion failed>";
1223 server
.assert_file
= "<no file>";
1224 server
.assert_line
= 0;
1225 server
.bug_report_start
= 0;
1226 server
.watchdog_period
= 0;
1229 /* This function will try to raise the max number of open files accordingly to
1230 * the configured max number of clients. It will also account for 32 additional
1231 * file descriptors as we need a few more for persistence, listening
1232 * sockets, log files and so forth.
1234 * If it will not be possible to set the limit accordingly to the configured
1235 * max number of clients, the function will do the reverse setting
1236 * server.maxclients to the value that we can actually handle. */
1237 void adjustOpenFilesLimit(void) {
1238 rlim_t maxfiles
= server
.maxclients
+32;
1239 struct rlimit limit
;
1241 if (getrlimit(RLIMIT_NOFILE
,&limit
) == -1) {
1242 redisLog(REDIS_WARNING
,"Unable to obtain the current NOFILE limit (%s), assuming 1024 and setting the max clients configuration accordingly.",
1244 server
.maxclients
= 1024-32;
1246 rlim_t oldlimit
= limit
.rlim_cur
;
1248 /* Set the max number of files if the current limit is not enough
1250 if (oldlimit
< maxfiles
) {
1254 while(f
> oldlimit
) {
1257 if (setrlimit(RLIMIT_NOFILE
,&limit
) != -1) break;
1260 if (f
< oldlimit
) f
= oldlimit
;
1261 if (f
!= maxfiles
) {
1262 server
.maxclients
= f
-32;
1263 redisLog(REDIS_WARNING
,"Unable to set the max number of files limit to %d (%s), setting the max clients configuration to %d.",
1264 (int) maxfiles
, strerror(errno
), (int) server
.maxclients
);
1266 redisLog(REDIS_NOTICE
,"Max number of open files set to %d",
1276 signal(SIGHUP
, SIG_IGN
);
1277 signal(SIGPIPE
, SIG_IGN
);
1278 setupSignalHandlers();
1280 if (server
.syslog_enabled
) {
1281 openlog(server
.syslog_ident
, LOG_PID
| LOG_NDELAY
| LOG_NOWAIT
,
1282 server
.syslog_facility
);
1285 server
.current_client
= NULL
;
1286 server
.clients
= listCreate();
1287 server
.clients_to_close
= listCreate();
1288 server
.slaves
= listCreate();
1289 server
.monitors
= listCreate();
1290 server
.unblocked_clients
= listCreate();
1291 server
.ready_keys
= listCreate();
1293 createSharedObjects();
1294 adjustOpenFilesLimit();
1295 server
.el
= aeCreateEventLoop(server
.maxclients
+1024);
1296 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1298 if (server
.port
!= 0) {
1299 server
.ipfd
= anetTcpServer(server
.neterr
,server
.port
,server
.bindaddr
);
1300 if (server
.ipfd
== ANET_ERR
) {
1301 redisLog(REDIS_WARNING
, "Opening port %d: %s",
1302 server
.port
, server
.neterr
);
1306 if (server
.unixsocket
!= NULL
) {
1307 unlink(server
.unixsocket
); /* don't care if this fails */
1308 server
.sofd
= anetUnixServer(server
.neterr
,server
.unixsocket
,server
.unixsocketperm
);
1309 if (server
.sofd
== ANET_ERR
) {
1310 redisLog(REDIS_WARNING
, "Opening socket: %s", server
.neterr
);
1314 if (server
.ipfd
< 0 && server
.sofd
< 0) {
1315 redisLog(REDIS_WARNING
, "Configured to not listen anywhere, exiting.");
1318 for (j
= 0; j
< server
.dbnum
; j
++) {
1319 server
.db
[j
].dict
= dictCreate(&dbDictType
,NULL
);
1320 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1321 server
.db
[j
].blocking_keys
= dictCreate(&keylistDictType
,NULL
);
1322 server
.db
[j
].ready_keys
= dictCreate(&setDictType
,NULL
);
1323 server
.db
[j
].watched_keys
= dictCreate(&keylistDictType
,NULL
);
1324 server
.db
[j
].id
= j
;
1326 server
.pubsub_channels
= dictCreate(&keylistDictType
,NULL
);
1327 server
.pubsub_patterns
= listCreate();
1328 listSetFreeMethod(server
.pubsub_patterns
,freePubsubPattern
);
1329 listSetMatchMethod(server
.pubsub_patterns
,listMatchPubsubPattern
);
1330 server
.cronloops
= 0;
1331 server
.rdb_child_pid
= -1;
1332 server
.aof_child_pid
= -1;
1333 aofRewriteBufferReset();
1334 server
.aof_buf
= sdsempty();
1335 server
.lastsave
= time(NULL
);
1336 server
.rdb_save_time_last
= -1;
1337 server
.rdb_save_time_start
= -1;
1339 server
.stat_numcommands
= 0;
1340 server
.stat_numconnections
= 0;
1341 server
.stat_expiredkeys
= 0;
1342 server
.stat_evictedkeys
= 0;
1343 server
.stat_starttime
= time(NULL
);
1344 server
.stat_keyspace_misses
= 0;
1345 server
.stat_keyspace_hits
= 0;
1346 server
.stat_peak_memory
= 0;
1347 server
.stat_fork_time
= 0;
1348 server
.stat_rejected_conn
= 0;
1349 memset(server
.ops_sec_samples
,0,sizeof(server
.ops_sec_samples
));
1350 server
.ops_sec_idx
= 0;
1351 server
.ops_sec_last_sample_time
= mstime();
1352 server
.ops_sec_last_sample_ops
= 0;
1353 server
.unixtime
= time(NULL
);
1354 server
.lastbgsave_status
= REDIS_OK
;
1355 server
.stop_writes_on_bgsave_err
= 1;
1356 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1357 if (server
.ipfd
> 0 && aeCreateFileEvent(server
.el
,server
.ipfd
,AE_READABLE
,
1358 acceptTcpHandler
,NULL
) == AE_ERR
) redisPanic("Unrecoverable error creating server.ipfd file event.");
1359 if (server
.sofd
> 0 && aeCreateFileEvent(server
.el
,server
.sofd
,AE_READABLE
,
1360 acceptUnixHandler
,NULL
) == AE_ERR
) redisPanic("Unrecoverable error creating server.sofd file event.");
1362 if (server
.aof_state
== REDIS_AOF_ON
) {
1363 server
.aof_fd
= open(server
.aof_filename
,
1364 O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1365 if (server
.aof_fd
== -1) {
1366 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1372 /* 32 bit instances are limited to 4GB of address space, so if there is
1373 * no explicit limit in the user provided configuration we set a limit
1374 * at 3 GB using maxmemory with 'noeviction' policy'. This avoids
1375 * useless crashes of the Redis instance for out of memory. */
1376 if (server
.arch_bits
== 32 && server
.maxmemory
== 0) {
1377 redisLog(REDIS_WARNING
,"Warning: 32 bit instance detected but no memory limit set. Setting 3 GB maxmemory limit with 'noeviction' policy now.");
1378 server
.maxmemory
= 3072LL*(1024*1024); /* 3 GB */
1379 server
.maxmemory_policy
= REDIS_MAXMEMORY_NO_EVICTION
;
1382 if (server
.cluster_enabled
) clusterInit();
1388 /* Populates the Redis Command Table starting from the hard coded list
1389 * we have on top of redis.c file. */
1390 void populateCommandTable(void) {
1392 int numcommands
= sizeof(redisCommandTable
)/sizeof(struct redisCommand
);
1394 for (j
= 0; j
< numcommands
; j
++) {
1395 struct redisCommand
*c
= redisCommandTable
+j
;
1396 char *f
= c
->sflags
;
1401 case 'w': c
->flags
|= REDIS_CMD_WRITE
; break;
1402 case 'r': c
->flags
|= REDIS_CMD_READONLY
; break;
1403 case 'm': c
->flags
|= REDIS_CMD_DENYOOM
; break;
1404 case 'a': c
->flags
|= REDIS_CMD_ADMIN
; break;
1405 case 'p': c
->flags
|= REDIS_CMD_PUBSUB
; break;
1406 case 'f': c
->flags
|= REDIS_CMD_FORCE_REPLICATION
; break;
1407 case 's': c
->flags
|= REDIS_CMD_NOSCRIPT
; break;
1408 case 'R': c
->flags
|= REDIS_CMD_RANDOM
; break;
1409 case 'S': c
->flags
|= REDIS_CMD_SORT_FOR_SCRIPT
; break;
1410 case 'l': c
->flags
|= REDIS_CMD_LOADING
; break;
1411 case 't': c
->flags
|= REDIS_CMD_STALE
; break;
1412 case 'M': c
->flags
|= REDIS_CMD_SKIP_MONITOR
; break;
1413 default: redisPanic("Unsupported command flag"); break;
1418 retval
= dictAdd(server
.commands
, sdsnew(c
->name
), c
);
1419 assert(retval
== DICT_OK
);
1423 void resetCommandTableStats(void) {
1424 int numcommands
= sizeof(redisCommandTable
)/sizeof(struct redisCommand
);
1427 for (j
= 0; j
< numcommands
; j
++) {
1428 struct redisCommand
*c
= redisCommandTable
+j
;
1430 c
->microseconds
= 0;
1435 /* ========================== Redis OP Array API ============================ */
1437 void redisOpArrayInit(redisOpArray
*oa
) {
1442 int redisOpArrayAppend(redisOpArray
*oa
, struct redisCommand
*cmd
, int dbid
,
1443 robj
**argv
, int argc
, int target
)
1447 oa
->ops
= zrealloc(oa
->ops
,sizeof(redisOp
)*(oa
->numops
+1));
1448 op
= oa
->ops
+oa
->numops
;
1453 op
->target
= target
;
1458 void redisOpArrayFree(redisOpArray
*oa
) {
1464 op
= oa
->ops
+oa
->numops
;
1465 for (j
= 0; j
< op
->argc
; j
++)
1466 decrRefCount(op
->argv
[j
]);
1472 /* ====================== Commands lookup and execution ===================== */
1474 struct redisCommand
*lookupCommand(sds name
) {
1475 return dictFetchValue(server
.commands
, name
);
1478 struct redisCommand
*lookupCommandByCString(char *s
) {
1479 struct redisCommand
*cmd
;
1480 sds name
= sdsnew(s
);
1482 cmd
= dictFetchValue(server
.commands
, name
);
1487 /* Propagate the specified command (in the context of the specified database id)
1488 * to AOF and Slaves.
1490 * flags are an xor between:
1491 * + REDIS_PROPAGATE_NONE (no propagation of command at all)
1492 * + REDIS_PROPAGATE_AOF (propagate into the AOF file if is enabled)
1493 * + REDIS_PROPAGATE_REPL (propagate into the replication link)
1495 void propagate(struct redisCommand
*cmd
, int dbid
, robj
**argv
, int argc
,
1498 if (server
.aof_state
!= REDIS_AOF_OFF
&& flags
& REDIS_PROPAGATE_AOF
)
1499 feedAppendOnlyFile(cmd
,dbid
,argv
,argc
);
1500 if (flags
& REDIS_PROPAGATE_REPL
&& listLength(server
.slaves
))
1501 replicationFeedSlaves(server
.slaves
,dbid
,argv
,argc
);
1504 /* Used inside commands to schedule the propagation of additional commands
1505 * after the current command is propagated to AOF / Replication. */
1506 void alsoPropagate(struct redisCommand
*cmd
, int dbid
, robj
**argv
, int argc
,
1509 redisOpArrayAppend(&server
.also_propagate
,cmd
,dbid
,argv
,argc
,target
);
1512 /* Call() is the core of Redis execution of a command */
1513 void call(redisClient
*c
, int flags
) {
1514 long long dirty
, start
= ustime(), duration
;
1516 /* Sent the command to clients in MONITOR mode, only if the commands are
1517 * not geneated from reading an AOF. */
1518 if (listLength(server
.monitors
) &&
1520 !(c
->cmd
->flags
& REDIS_CMD_SKIP_MONITOR
))
1522 replicationFeedMonitors(c
,server
.monitors
,c
->db
->id
,c
->argv
,c
->argc
);
1525 /* Call the command. */
1526 redisOpArrayInit(&server
.also_propagate
);
1527 dirty
= server
.dirty
;
1529 dirty
= server
.dirty
-dirty
;
1530 duration
= ustime()-start
;
1532 /* When EVAL is called loading the AOF we don't want commands called
1533 * from Lua to go into the slowlog or to populate statistics. */
1534 if (server
.loading
&& c
->flags
& REDIS_LUA_CLIENT
)
1535 flags
&= ~(REDIS_CALL_SLOWLOG
| REDIS_CALL_STATS
);
1537 /* Log the command into the Slow log if needed, and populate the
1538 * per-command statistics that we show in INFO commandstats. */
1539 if (flags
& REDIS_CALL_SLOWLOG
)
1540 slowlogPushEntryIfNeeded(c
->argv
,c
->argc
,duration
);
1541 if (flags
& REDIS_CALL_STATS
) {
1542 c
->cmd
->microseconds
+= duration
;
1546 /* Propagate the command into the AOF and replication link */
1547 if (flags
& REDIS_CALL_PROPAGATE
) {
1548 int flags
= REDIS_PROPAGATE_NONE
;
1550 if (c
->cmd
->flags
& REDIS_CMD_FORCE_REPLICATION
)
1551 flags
|= REDIS_PROPAGATE_REPL
;
1553 flags
|= (REDIS_PROPAGATE_REPL
| REDIS_PROPAGATE_AOF
);
1554 if (flags
!= REDIS_PROPAGATE_NONE
)
1555 propagate(c
->cmd
,c
->db
->id
,c
->argv
,c
->argc
,flags
);
1557 /* Commands such as LPUSH or BRPOPLPUSH may propagate an additional
1559 if (server
.also_propagate
.numops
) {
1563 for (j
= 0; j
< server
.also_propagate
.numops
; j
++) {
1564 rop
= &server
.also_propagate
.ops
[j
];
1565 propagate(rop
->cmd
, rop
->dbid
, rop
->argv
, rop
->argc
, rop
->target
);
1567 redisOpArrayFree(&server
.also_propagate
);
1569 server
.stat_numcommands
++;
1572 /* If this function gets called we already read a whole
1573 * command, arguments are in the client argv/argc fields.
1574 * processCommand() execute the command or prepare the
1575 * server for a bulk read from the client.
1577 * If 1 is returned the client is still alive and valid and
1578 * and other operations can be performed by the caller. Otherwise
1579 * if 0 is returned the client was destroied (i.e. after QUIT). */
1580 int processCommand(redisClient
*c
) {
1581 /* The QUIT command is handled separately. Normal command procs will
1582 * go through checking for replication and QUIT will cause trouble
1583 * when FORCE_REPLICATION is enabled and would be implemented in
1584 * a regular command proc. */
1585 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
1586 addReply(c
,shared
.ok
);
1587 c
->flags
|= REDIS_CLOSE_AFTER_REPLY
;
1591 /* Now lookup the command and check ASAP about trivial error conditions
1592 * such as wrong arity, bad command name and so forth. */
1593 c
->cmd
= c
->lastcmd
= lookupCommand(c
->argv
[0]->ptr
);
1596 addReplyErrorFormat(c
,"unknown command '%s'",
1597 (char*)c
->argv
[0]->ptr
);
1599 } else if ((c
->cmd
->arity
> 0 && c
->cmd
->arity
!= c
->argc
) ||
1600 (c
->argc
< -c
->cmd
->arity
)) {
1602 addReplyErrorFormat(c
,"wrong number of arguments for '%s' command",
1607 /* Check if the user is authenticated */
1608 if (server
.requirepass
&& !c
->authenticated
&& c
->cmd
->proc
!= authCommand
)
1611 addReplyError(c
,"operation not permitted");
1615 /* If cluster is enabled, redirect here */
1616 if (server
.cluster_enabled
&&
1617 !(c
->cmd
->getkeys_proc
== NULL
&& c
->cmd
->firstkey
== 0)) {
1620 if (server
.cluster
.state
!= REDIS_CLUSTER_OK
) {
1621 addReplyError(c
,"The cluster is down. Check with CLUSTER INFO for more information");
1625 clusterNode
*n
= getNodeByQuery(c
,c
->cmd
,c
->argv
,c
->argc
,&hashslot
,&ask
);
1627 addReplyError(c
,"Multi keys request invalid in cluster");
1629 } else if (n
!= server
.cluster
.myself
) {
1630 addReplySds(c
,sdscatprintf(sdsempty(),
1631 "-%s %d %s:%d\r\n", ask
? "ASK" : "MOVED",
1632 hashslot
,n
->ip
,n
->port
));
1638 /* Handle the maxmemory directive.
1640 * First we try to free some memory if possible (if there are volatile
1641 * keys in the dataset). If there are not the only thing we can do
1642 * is returning an error. */
1643 if (server
.maxmemory
) {
1644 int retval
= freeMemoryIfNeeded();
1645 if ((c
->cmd
->flags
& REDIS_CMD_DENYOOM
) && retval
== REDIS_ERR
) {
1647 addReply(c
, shared
.oomerr
);
1652 /* Don't accept write commands if there are problems persisting on disk. */
1653 if (server
.stop_writes_on_bgsave_err
&&
1654 server
.saveparamslen
> 0
1655 && server
.lastbgsave_status
== REDIS_ERR
&&
1656 c
->cmd
->flags
& REDIS_CMD_WRITE
)
1659 addReply(c
, shared
.bgsaveerr
);
1663 /* Don't accept write commands if this is a read only slave. But
1664 * accept write commands if this is our master. */
1665 if (server
.masterhost
&& server
.repl_slave_ro
&&
1666 !(c
->flags
& REDIS_MASTER
) &&
1667 c
->cmd
->flags
& REDIS_CMD_WRITE
)
1669 addReply(c
, shared
.roslaveerr
);
1673 /* Only allow SUBSCRIBE and UNSUBSCRIBE in the context of Pub/Sub */
1674 if ((dictSize(c
->pubsub_channels
) > 0 || listLength(c
->pubsub_patterns
) > 0)
1676 c
->cmd
->proc
!= subscribeCommand
&&
1677 c
->cmd
->proc
!= unsubscribeCommand
&&
1678 c
->cmd
->proc
!= psubscribeCommand
&&
1679 c
->cmd
->proc
!= punsubscribeCommand
) {
1680 addReplyError(c
,"only (P)SUBSCRIBE / (P)UNSUBSCRIBE / QUIT allowed in this context");
1684 /* Only allow INFO and SLAVEOF when slave-serve-stale-data is no and
1685 * we are a slave with a broken link with master. */
1686 if (server
.masterhost
&& server
.repl_state
!= REDIS_REPL_CONNECTED
&&
1687 server
.repl_serve_stale_data
== 0 &&
1688 !(c
->cmd
->flags
& REDIS_CMD_STALE
))
1691 addReply(c
, shared
.masterdownerr
);
1695 /* Loading DB? Return an error if the command has not the
1696 * REDIS_CMD_LOADING flag. */
1697 if (server
.loading
&& !(c
->cmd
->flags
& REDIS_CMD_LOADING
)) {
1698 addReply(c
, shared
.loadingerr
);
1702 /* Lua script too slow? Only allow commands with REDIS_CMD_STALE flag. */
1703 if (server
.lua_timedout
&&
1704 c
->cmd
->proc
!= authCommand
&&
1705 !(c
->cmd
->proc
== shutdownCommand
&&
1707 tolower(((char*)c
->argv
[1]->ptr
)[0]) == 'n') &&
1708 !(c
->cmd
->proc
== scriptCommand
&&
1710 tolower(((char*)c
->argv
[1]->ptr
)[0]) == 'k'))
1713 addReply(c
, shared
.slowscripterr
);
1717 /* Exec the command */
1718 if (c
->flags
& REDIS_MULTI
&&
1719 c
->cmd
->proc
!= execCommand
&& c
->cmd
->proc
!= discardCommand
&&
1720 c
->cmd
->proc
!= multiCommand
&& c
->cmd
->proc
!= watchCommand
)
1722 queueMultiCommand(c
);
1723 addReply(c
,shared
.queued
);
1725 call(c
,REDIS_CALL_FULL
);
1726 if (listLength(server
.ready_keys
))
1727 handleClientsBlockedOnLists();
1732 /*================================== Shutdown =============================== */
1734 int prepareForShutdown(int flags
) {
1735 int save
= flags
& REDIS_SHUTDOWN_SAVE
;
1736 int nosave
= flags
& REDIS_SHUTDOWN_NOSAVE
;
1738 redisLog(REDIS_WARNING
,"User requested shutdown...");
1739 /* Kill the saving child if there is a background saving in progress.
1740 We want to avoid race conditions, for instance our saving child may
1741 overwrite the synchronous saving did by SHUTDOWN. */
1742 if (server
.rdb_child_pid
!= -1) {
1743 redisLog(REDIS_WARNING
,"There is a child saving an .rdb. Killing it!");
1744 kill(server
.rdb_child_pid
,SIGKILL
);
1745 rdbRemoveTempFile(server
.rdb_child_pid
);
1747 if (server
.aof_state
!= REDIS_AOF_OFF
) {
1748 /* Kill the AOF saving child as the AOF we already have may be longer
1749 * but contains the full dataset anyway. */
1750 if (server
.aof_child_pid
!= -1) {
1751 redisLog(REDIS_WARNING
,
1752 "There is a child rewriting the AOF. Killing it!");
1753 kill(server
.aof_child_pid
,SIGKILL
);
1755 /* Append only file: fsync() the AOF and exit */
1756 redisLog(REDIS_NOTICE
,"Calling fsync() on the AOF file.");
1757 aof_fsync(server
.aof_fd
);
1759 if ((server
.saveparamslen
> 0 && !nosave
) || save
) {
1760 redisLog(REDIS_NOTICE
,"Saving the final RDB snapshot before exiting.");
1761 /* Snapshotting. Perform a SYNC SAVE and exit */
1762 if (rdbSave(server
.rdb_filename
) != REDIS_OK
) {
1763 /* Ooops.. error saving! The best we can do is to continue
1764 * operating. Note that if there was a background saving process,
1765 * in the next cron() Redis will be notified that the background
1766 * saving aborted, handling special stuff like slaves pending for
1767 * synchronization... */
1768 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit.");
1772 if (server
.daemonize
) {
1773 redisLog(REDIS_NOTICE
,"Removing the pid file.");
1774 unlink(server
.pidfile
);
1776 /* Close the listening sockets. Apparently this allows faster restarts. */
1777 if (server
.ipfd
!= -1) close(server
.ipfd
);
1778 if (server
.sofd
!= -1) close(server
.sofd
);
1779 if (server
.unixsocket
) {
1780 redisLog(REDIS_NOTICE
,"Removing the unix socket file.");
1781 unlink(server
.unixsocket
); /* don't care if this fails */
1784 redisLog(REDIS_WARNING
,"Redis is now ready to exit, bye bye...");
1788 /*================================== Commands =============================== */
1790 /* Return zero if strings are the same, non-zero if they are not.
1791 * The comparison is performed in a way that prevents an attacker to obtain
1792 * information about the nature of the strings just monitoring the execution
1793 * time of the function.
1795 * Note that limiting the comparison length to strings up to 512 bytes we
1796 * can avoid leaking any information about the password length and any
1797 * possible branch misprediction related leak.
1799 int time_independent_strcmp(char *a
, char *b
) {
1800 char bufa
[REDIS_AUTHPASS_MAX_LEN
], bufb
[REDIS_AUTHPASS_MAX_LEN
];
1801 /* The above two strlen perform len(a) + len(b) operations where either
1802 * a or b are fixed (our password) length, and the difference is only
1803 * relative to the length of the user provided string, so no information
1804 * leak is possible in the following two lines of code. */
1805 int alen
= strlen(a
);
1806 int blen
= strlen(b
);
1810 /* We can't compare strings longer than our static buffers.
1811 * Note that this will never pass the first test in practical circumstances
1812 * so there is no info leak. */
1813 if (alen
> sizeof(bufa
) || blen
> sizeof(bufb
)) return 1;
1815 memset(bufa
,0,sizeof(bufa
)); /* Constant time. */
1816 memset(bufb
,0,sizeof(bufb
)); /* Constant time. */
1817 /* Again the time of the following two copies is proportional to
1818 * len(a) + len(b) so no info is leaked. */
1819 memcpy(bufa
,a
,alen
);
1820 memcpy(bufb
,b
,blen
);
1822 /* Always compare all the chars in the two buffers without
1823 * conditional expressions. */
1824 for (j
= 0; j
< sizeof(bufa
); j
++) {
1825 diff
|= (bufa
[j
] ^ bufb
[j
]);
1827 /* Length must be equal as well. */
1828 diff
|= alen
^ blen
;
1829 return diff
; /* If zero strings are the same. */
1832 void authCommand(redisClient
*c
) {
1833 if (!server
.requirepass
) {
1834 addReplyError(c
,"Client sent AUTH, but no password is set");
1835 } else if (!time_independent_strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
1836 c
->authenticated
= 1;
1837 addReply(c
,shared
.ok
);
1839 c
->authenticated
= 0;
1840 addReplyError(c
,"invalid password");
1844 void pingCommand(redisClient
*c
) {
1845 addReply(c
,shared
.pong
);
1848 void echoCommand(redisClient
*c
) {
1849 addReplyBulk(c
,c
->argv
[1]);
1852 void timeCommand(redisClient
*c
) {
1855 /* gettimeofday() can only fail if &tv is a bad addresss so we
1856 * don't check for errors. */
1857 gettimeofday(&tv
,NULL
);
1858 addReplyMultiBulkLen(c
,2);
1859 addReplyBulkLongLong(c
,tv
.tv_sec
);
1860 addReplyBulkLongLong(c
,tv
.tv_usec
);
1863 /* Convert an amount of bytes into a human readable string in the form
1864 * of 100B, 2G, 100M, 4K, and so forth. */
1865 void bytesToHuman(char *s
, unsigned long long n
) {
1870 sprintf(s
,"%lluB",n
);
1872 } else if (n
< (1024*1024)) {
1873 d
= (double)n
/(1024);
1874 sprintf(s
,"%.2fK",d
);
1875 } else if (n
< (1024LL*1024*1024)) {
1876 d
= (double)n
/(1024*1024);
1877 sprintf(s
,"%.2fM",d
);
1878 } else if (n
< (1024LL*1024*1024*1024)) {
1879 d
= (double)n
/(1024LL*1024*1024);
1880 sprintf(s
,"%.2fG",d
);
1884 /* Create the string returned by the INFO command. This is decoupled
1885 * by the INFO command itself as we need to report the same information
1886 * on memory corruption problems. */
1887 sds
genRedisInfoString(char *section
) {
1888 sds info
= sdsempty();
1889 time_t uptime
= server
.unixtime
-server
.stat_starttime
;
1891 struct rusage self_ru
, c_ru
;
1892 unsigned long lol
, bib
;
1893 int allsections
= 0, defsections
= 0;
1897 allsections
= strcasecmp(section
,"all") == 0;
1898 defsections
= strcasecmp(section
,"default") == 0;
1901 getrusage(RUSAGE_SELF
, &self_ru
);
1902 getrusage(RUSAGE_CHILDREN
, &c_ru
);
1903 getClientsMaxBuffers(&lol
,&bib
);
1906 if (allsections
|| defsections
|| !strcasecmp(section
,"server")) {
1907 struct utsname name
;
1910 if (server
.cluster_enabled
) mode
= "cluster";
1911 else if (server
.sentinel_mode
) mode
= "sentinel";
1912 else mode
= "standalone";
1914 if (sections
++) info
= sdscat(info
,"\r\n");
1916 info
= sdscatprintf(info
,
1918 "redis_version:%s\r\n"
1919 "redis_git_sha1:%s\r\n"
1920 "redis_git_dirty:%d\r\n"
1924 "multiplexing_api:%s\r\n"
1925 "gcc_version:%d.%d.%d\r\n"
1926 "process_id:%ld\r\n"
1929 "uptime_in_seconds:%ld\r\n"
1930 "uptime_in_days:%ld\r\n"
1931 "lru_clock:%ld\r\n",
1934 strtol(redisGitDirty(),NULL
,10) > 0,
1936 name
.sysname
, name
.release
, name
.machine
,
1940 __GNUC__
,__GNUC_MINOR__
,__GNUC_PATCHLEVEL__
,
1949 (unsigned long) server
.lruclock
);
1953 if (allsections
|| defsections
|| !strcasecmp(section
,"clients")) {
1954 if (sections
++) info
= sdscat(info
,"\r\n");
1955 info
= sdscatprintf(info
,
1957 "connected_clients:%lu\r\n"
1958 "client_longest_output_list:%lu\r\n"
1959 "client_biggest_input_buf:%lu\r\n"
1960 "blocked_clients:%d\r\n",
1961 listLength(server
.clients
)-listLength(server
.slaves
),
1963 server
.bpop_blocked_clients
);
1967 if (allsections
|| defsections
|| !strcasecmp(section
,"memory")) {
1971 bytesToHuman(hmem
,zmalloc_used_memory());
1972 bytesToHuman(peak_hmem
,server
.stat_peak_memory
);
1973 if (sections
++) info
= sdscat(info
,"\r\n");
1974 info
= sdscatprintf(info
,
1976 "used_memory:%zu\r\n"
1977 "used_memory_human:%s\r\n"
1978 "used_memory_rss:%zu\r\n"
1979 "used_memory_peak:%zu\r\n"
1980 "used_memory_peak_human:%s\r\n"
1981 "used_memory_lua:%lld\r\n"
1982 "mem_fragmentation_ratio:%.2f\r\n"
1983 "mem_allocator:%s\r\n",
1984 zmalloc_used_memory(),
1987 server
.stat_peak_memory
,
1989 ((long long)lua_gc(server
.lua
,LUA_GCCOUNT
,0))*1024LL,
1990 zmalloc_get_fragmentation_ratio(),
1996 if (allsections
|| defsections
|| !strcasecmp(section
,"persistence")) {
1997 if (sections
++) info
= sdscat(info
,"\r\n");
1998 info
= sdscatprintf(info
,
2001 "rdb_changes_since_last_save:%lld\r\n"
2002 "rdb_bgsave_in_progress:%d\r\n"
2003 "rdb_last_save_time:%ld\r\n"
2004 "rdb_last_bgsave_status:%s\r\n"
2005 "rdb_last_bgsave_time_sec:%ld\r\n"
2006 "rdb_current_bgsave_time_sec:%ld\r\n"
2007 "aof_enabled:%d\r\n"
2008 "aof_rewrite_in_progress:%d\r\n"
2009 "aof_rewrite_scheduled:%d\r\n"
2010 "aof_last_rewrite_time_sec:%ld\r\n"
2011 "aof_current_rewrite_time_sec:%ld\r\n"
2012 "aof_last_bgrewrite_status:%s\r\n",
2015 server
.rdb_child_pid
!= -1,
2017 (server
.lastbgsave_status
== REDIS_OK
) ? "ok" : "err",
2018 server
.rdb_save_time_last
,
2019 (server
.rdb_child_pid
== -1) ?
2020 -1 : time(NULL
)-server
.rdb_save_time_start
,
2021 server
.aof_state
!= REDIS_AOF_OFF
,
2022 server
.aof_child_pid
!= -1,
2023 server
.aof_rewrite_scheduled
,
2024 server
.aof_rewrite_time_last
,
2025 (server
.aof_child_pid
== -1) ?
2026 -1 : time(NULL
)-server
.aof_rewrite_time_start
,
2027 (server
.aof_lastbgrewrite_status
== REDIS_OK
) ? "ok" : "err");
2029 if (server
.aof_state
!= REDIS_AOF_OFF
) {
2030 info
= sdscatprintf(info
,
2031 "aof_current_size:%lld\r\n"
2032 "aof_base_size:%lld\r\n"
2033 "aof_pending_rewrite:%d\r\n"
2034 "aof_buffer_length:%zu\r\n"
2035 "aof_rewrite_buffer_length:%lu\r\n"
2036 "aof_pending_bio_fsync:%llu\r\n"
2037 "aof_delayed_fsync:%lu\r\n",
2038 (long long) server
.aof_current_size
,
2039 (long long) server
.aof_rewrite_base_size
,
2040 server
.aof_rewrite_scheduled
,
2041 sdslen(server
.aof_buf
),
2042 aofRewriteBufferSize(),
2043 bioPendingJobsOfType(REDIS_BIO_AOF_FSYNC
),
2044 server
.aof_delayed_fsync
);
2047 if (server
.loading
) {
2049 time_t eta
, elapsed
;
2050 off_t remaining_bytes
= server
.loading_total_bytes
-
2051 server
.loading_loaded_bytes
;
2053 perc
= ((double)server
.loading_loaded_bytes
/
2054 server
.loading_total_bytes
) * 100;
2056 elapsed
= server
.unixtime
-server
.loading_start_time
;
2058 eta
= 1; /* A fake 1 second figure if we don't have
2061 eta
= (elapsed
*remaining_bytes
)/server
.loading_loaded_bytes
;
2064 info
= sdscatprintf(info
,
2065 "loading_start_time:%ld\r\n"
2066 "loading_total_bytes:%llu\r\n"
2067 "loading_loaded_bytes:%llu\r\n"
2068 "loading_loaded_perc:%.2f\r\n"
2069 "loading_eta_seconds:%ld\r\n"
2070 ,(unsigned long) server
.loading_start_time
,
2071 (unsigned long long) server
.loading_total_bytes
,
2072 (unsigned long long) server
.loading_loaded_bytes
,
2080 if (allsections
|| defsections
|| !strcasecmp(section
,"stats")) {
2081 if (sections
++) info
= sdscat(info
,"\r\n");
2082 info
= sdscatprintf(info
,
2084 "total_connections_received:%lld\r\n"
2085 "total_commands_processed:%lld\r\n"
2086 "instantaneous_ops_per_sec:%lld\r\n"
2087 "rejected_connections:%lld\r\n"
2088 "expired_keys:%lld\r\n"
2089 "evicted_keys:%lld\r\n"
2090 "keyspace_hits:%lld\r\n"
2091 "keyspace_misses:%lld\r\n"
2092 "pubsub_channels:%ld\r\n"
2093 "pubsub_patterns:%lu\r\n"
2094 "latest_fork_usec:%lld\r\n"
2095 "migrate_cached_sockets:%ld\r\n",
2096 server
.stat_numconnections
,
2097 server
.stat_numcommands
,
2098 getOperationsPerSecond(),
2099 server
.stat_rejected_conn
,
2100 server
.stat_expiredkeys
,
2101 server
.stat_evictedkeys
,
2102 server
.stat_keyspace_hits
,
2103 server
.stat_keyspace_misses
,
2104 dictSize(server
.pubsub_channels
),
2105 listLength(server
.pubsub_patterns
),
2106 server
.stat_fork_time
,
2107 dictSize(server
.migrate_cached_sockets
));
2111 if (allsections
|| defsections
|| !strcasecmp(section
,"replication")) {
2112 if (sections
++) info
= sdscat(info
,"\r\n");
2113 info
= sdscatprintf(info
,
2116 server
.masterhost
== NULL
? "master" : "slave");
2117 if (server
.masterhost
) {
2118 info
= sdscatprintf(info
,
2119 "master_host:%s\r\n"
2120 "master_port:%d\r\n"
2121 "master_link_status:%s\r\n"
2122 "master_last_io_seconds_ago:%d\r\n"
2123 "master_sync_in_progress:%d\r\n"
2126 (server
.repl_state
== REDIS_REPL_CONNECTED
) ?
2129 ((int)(server
.unixtime
-server
.master
->lastinteraction
)) : -1,
2130 server
.repl_state
== REDIS_REPL_TRANSFER
2133 if (server
.repl_state
== REDIS_REPL_TRANSFER
) {
2134 info
= sdscatprintf(info
,
2135 "master_sync_left_bytes:%lld\r\n"
2136 "master_sync_last_io_seconds_ago:%d\r\n"
2138 (server
.repl_transfer_size
- server
.repl_transfer_read
),
2139 (int)(server
.unixtime
-server
.repl_transfer_lastio
)
2143 if (server
.repl_state
!= REDIS_REPL_CONNECTED
) {
2144 info
= sdscatprintf(info
,
2145 "master_link_down_since_seconds:%ld\r\n",
2146 (long)server
.unixtime
-server
.repl_down_since
);
2148 info
= sdscatprintf(info
,
2149 "slave_priority:%d\r\n"
2150 "slave_read_only:%d\r\n",
2151 server
.slave_priority
,
2152 server
.repl_slave_ro
);
2154 info
= sdscatprintf(info
,
2155 "connected_slaves:%lu\r\n",
2156 listLength(server
.slaves
));
2157 if (listLength(server
.slaves
)) {
2162 listRewind(server
.slaves
,&li
);
2163 while((ln
= listNext(&li
))) {
2164 redisClient
*slave
= listNodeValue(ln
);
2169 if (anetPeerToString(slave
->fd
,ip
,&port
) == -1) continue;
2170 switch(slave
->replstate
) {
2171 case REDIS_REPL_WAIT_BGSAVE_START
:
2172 case REDIS_REPL_WAIT_BGSAVE_END
:
2173 state
= "wait_bgsave";
2175 case REDIS_REPL_SEND_BULK
:
2176 state
= "send_bulk";
2178 case REDIS_REPL_ONLINE
:
2182 if (state
== NULL
) continue;
2183 info
= sdscatprintf(info
,"slave%d:%s,%d,%s\r\n",
2184 slaveid
,ip
,slave
->slave_listening_port
,state
);
2191 if (allsections
|| defsections
|| !strcasecmp(section
,"cpu")) {
2192 if (sections
++) info
= sdscat(info
,"\r\n");
2193 info
= sdscatprintf(info
,
2195 "used_cpu_sys:%.2f\r\n"
2196 "used_cpu_user:%.2f\r\n"
2197 "used_cpu_sys_children:%.2f\r\n"
2198 "used_cpu_user_children:%.2f\r\n",
2199 (float)self_ru
.ru_stime
.tv_sec
+(float)self_ru
.ru_stime
.tv_usec
/1000000,
2200 (float)self_ru
.ru_utime
.tv_sec
+(float)self_ru
.ru_utime
.tv_usec
/1000000,
2201 (float)c_ru
.ru_stime
.tv_sec
+(float)c_ru
.ru_stime
.tv_usec
/1000000,
2202 (float)c_ru
.ru_utime
.tv_sec
+(float)c_ru
.ru_utime
.tv_usec
/1000000);
2206 if (allsections
|| !strcasecmp(section
,"commandstats")) {
2207 if (sections
++) info
= sdscat(info
,"\r\n");
2208 info
= sdscatprintf(info
, "# Commandstats\r\n");
2209 numcommands
= sizeof(redisCommandTable
)/sizeof(struct redisCommand
);
2210 for (j
= 0; j
< numcommands
; j
++) {
2211 struct redisCommand
*c
= redisCommandTable
+j
;
2213 if (!c
->calls
) continue;
2214 info
= sdscatprintf(info
,
2215 "cmdstat_%s:calls=%lld,usec=%lld,usec_per_call=%.2f\r\n",
2216 c
->name
, c
->calls
, c
->microseconds
,
2217 (c
->calls
== 0) ? 0 : ((float)c
->microseconds
/c
->calls
));
2222 if (allsections
|| defsections
|| !strcasecmp(section
,"cluster")) {
2223 if (sections
++) info
= sdscat(info
,"\r\n");
2224 info
= sdscatprintf(info
,
2226 "cluster_enabled:%d\r\n",
2227 server
.cluster_enabled
);
2231 if (allsections
|| defsections
|| !strcasecmp(section
,"keyspace")) {
2232 if (sections
++) info
= sdscat(info
,"\r\n");
2233 info
= sdscatprintf(info
, "# Keyspace\r\n");
2234 for (j
= 0; j
< server
.dbnum
; j
++) {
2235 long long keys
, vkeys
;
2237 keys
= dictSize(server
.db
[j
].dict
);
2238 vkeys
= dictSize(server
.db
[j
].expires
);
2239 if (keys
|| vkeys
) {
2240 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
2248 void infoCommand(redisClient
*c
) {
2249 char *section
= c
->argc
== 2 ? c
->argv
[1]->ptr
: "default";
2252 addReply(c
,shared
.syntaxerr
);
2255 sds info
= genRedisInfoString(section
);
2256 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
2257 (unsigned long)sdslen(info
)));
2258 addReplySds(c
,info
);
2259 addReply(c
,shared
.crlf
);
2262 void monitorCommand(redisClient
*c
) {
2263 /* ignore MONITOR if already slave or in monitor mode */
2264 if (c
->flags
& REDIS_SLAVE
) return;
2266 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
2268 listAddNodeTail(server
.monitors
,c
);
2269 addReply(c
,shared
.ok
);
2272 /* ============================ Maxmemory directive ======================== */
2274 /* This function gets called when 'maxmemory' is set on the config file to limit
2275 * the max memory used by the server, before processing a command.
2277 * The goal of the function is to free enough memory to keep Redis under the
2278 * configured memory limit.
2280 * The function starts calculating how many bytes should be freed to keep
2281 * Redis under the limit, and enters a loop selecting the best keys to
2282 * evict accordingly to the configured policy.
2284 * If all the bytes needed to return back under the limit were freed the
2285 * function returns REDIS_OK, otherwise REDIS_ERR is returned, and the caller
2286 * should block the execution of commands that will result in more memory
2287 * used by the server.
2289 int freeMemoryIfNeeded(void) {
2290 size_t mem_used
, mem_tofree
, mem_freed
;
2291 int slaves
= listLength(server
.slaves
);
2293 /* Remove the size of slaves output buffers and AOF buffer from the
2294 * count of used memory. */
2295 mem_used
= zmalloc_used_memory();
2300 listRewind(server
.slaves
,&li
);
2301 while((ln
= listNext(&li
))) {
2302 redisClient
*slave
= listNodeValue(ln
);
2303 unsigned long obuf_bytes
= getClientOutputBufferMemoryUsage(slave
);
2304 if (obuf_bytes
> mem_used
)
2307 mem_used
-= obuf_bytes
;
2310 if (server
.aof_state
!= REDIS_AOF_OFF
) {
2311 mem_used
-= sdslen(server
.aof_buf
);
2312 mem_used
-= aofRewriteBufferSize();
2315 /* Check if we are over the memory limit. */
2316 if (mem_used
<= server
.maxmemory
) return REDIS_OK
;
2318 if (server
.maxmemory_policy
== REDIS_MAXMEMORY_NO_EVICTION
)
2319 return REDIS_ERR
; /* We need to free memory, but policy forbids. */
2321 /* Compute how much memory we need to free. */
2322 mem_tofree
= mem_used
- server
.maxmemory
;
2324 while (mem_freed
< mem_tofree
) {
2325 int j
, k
, keys_freed
= 0;
2327 for (j
= 0; j
< server
.dbnum
; j
++) {
2328 long bestval
= 0; /* just to prevent warning */
2330 struct dictEntry
*de
;
2331 redisDb
*db
= server
.db
+j
;
2334 if (server
.maxmemory_policy
== REDIS_MAXMEMORY_ALLKEYS_LRU
||
2335 server
.maxmemory_policy
== REDIS_MAXMEMORY_ALLKEYS_RANDOM
)
2337 dict
= server
.db
[j
].dict
;
2339 dict
= server
.db
[j
].expires
;
2341 if (dictSize(dict
) == 0) continue;
2343 /* volatile-random and allkeys-random policy */
2344 if (server
.maxmemory_policy
== REDIS_MAXMEMORY_ALLKEYS_RANDOM
||
2345 server
.maxmemory_policy
== REDIS_MAXMEMORY_VOLATILE_RANDOM
)
2347 de
= dictGetRandomKey(dict
);
2348 bestkey
= dictGetKey(de
);
2351 /* volatile-lru and allkeys-lru policy */
2352 else if (server
.maxmemory_policy
== REDIS_MAXMEMORY_ALLKEYS_LRU
||
2353 server
.maxmemory_policy
== REDIS_MAXMEMORY_VOLATILE_LRU
)
2355 for (k
= 0; k
< server
.maxmemory_samples
; k
++) {
2360 de
= dictGetRandomKey(dict
);
2361 thiskey
= dictGetKey(de
);
2362 /* When policy is volatile-lru we need an additional lookup
2363 * to locate the real key, as dict is set to db->expires. */
2364 if (server
.maxmemory_policy
== REDIS_MAXMEMORY_VOLATILE_LRU
)
2365 de
= dictFind(db
->dict
, thiskey
);
2367 thisval
= estimateObjectIdleTime(o
);
2369 /* Higher idle time is better candidate for deletion */
2370 if (bestkey
== NULL
|| thisval
> bestval
) {
2378 else if (server
.maxmemory_policy
== REDIS_MAXMEMORY_VOLATILE_TTL
) {
2379 for (k
= 0; k
< server
.maxmemory_samples
; k
++) {
2383 de
= dictGetRandomKey(dict
);
2384 thiskey
= dictGetKey(de
);
2385 thisval
= (long) dictGetVal(de
);
2387 /* Expire sooner (minor expire unix timestamp) is better
2388 * candidate for deletion */
2389 if (bestkey
== NULL
|| thisval
< bestval
) {
2396 /* Finally remove the selected key. */
2400 robj
*keyobj
= createStringObject(bestkey
,sdslen(bestkey
));
2401 propagateExpire(db
,keyobj
);
2402 /* We compute the amount of memory freed by dbDelete() alone.
2403 * It is possible that actually the memory needed to propagate
2404 * the DEL in AOF and replication link is greater than the one
2405 * we are freeing removing the key, but we can't account for
2406 * that otherwise we would never exit the loop.
2408 * AOF and Output buffer memory will be freed eventually so
2409 * we only care about memory used by the key space. */
2410 delta
= (long long) zmalloc_used_memory();
2411 dbDelete(db
,keyobj
);
2412 delta
-= (long long) zmalloc_used_memory();
2414 server
.stat_evictedkeys
++;
2415 decrRefCount(keyobj
);
2418 /* When the memory to free starts to be big enough, we may
2419 * start spending so much time here that is impossible to
2420 * deliver data to the slaves fast enough, so we force the
2421 * transmission here inside the loop. */
2422 if (slaves
) flushSlavesOutputBuffers();
2425 if (!keys_freed
) return REDIS_ERR
; /* nothing to free... */
2430 /* =================================== Main! ================================ */
2433 int linuxOvercommitMemoryValue(void) {
2434 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
2438 if (fgets(buf
,64,fp
) == NULL
) {
2447 void linuxOvercommitMemoryWarning(void) {
2448 if (linuxOvercommitMemoryValue() == 0) {
2449 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.");
2452 #endif /* __linux__ */
2454 void createPidFile(void) {
2455 /* Try to write the pid file in a best-effort way. */
2456 FILE *fp
= fopen(server
.pidfile
,"w");
2458 fprintf(fp
,"%d\n",(int)getpid());
2463 void daemonize(void) {
2466 if (fork() != 0) exit(0); /* parent exits */
2467 setsid(); /* create a new session */
2469 /* Every output goes to /dev/null. If Redis is daemonized but
2470 * the 'logfile' is set to 'stdout' in the configuration file
2471 * it will not log at all. */
2472 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
2473 dup2(fd
, STDIN_FILENO
);
2474 dup2(fd
, STDOUT_FILENO
);
2475 dup2(fd
, STDERR_FILENO
);
2476 if (fd
> STDERR_FILENO
) close(fd
);
2481 printf("Redis server v=%s sha=%s:%d malloc=%s bits=%d\n",
2484 atoi(redisGitDirty()) > 0,
2486 sizeof(long) == 4 ? 32 : 64);
2491 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf] [options]\n");
2492 fprintf(stderr
," ./redis-server - (read config from stdin)\n");
2493 fprintf(stderr
," ./redis-server -v or --version\n");
2494 fprintf(stderr
," ./redis-server -h or --help\n");
2495 fprintf(stderr
," ./redis-server --test-memory <megabytes>\n\n");
2496 fprintf(stderr
,"Examples:\n");
2497 fprintf(stderr
," ./redis-server (run the server with default conf)\n");
2498 fprintf(stderr
," ./redis-server /etc/redis/6379.conf\n");
2499 fprintf(stderr
," ./redis-server --port 7777\n");
2500 fprintf(stderr
," ./redis-server --port 7777 --slaveof 127.0.0.1 8888\n");
2501 fprintf(stderr
," ./redis-server /etc/myredis.conf --loglevel verbose\n\n");
2502 fprintf(stderr
,"Sentinel mode:\n");
2503 fprintf(stderr
," ./redis-server /etc/sentinel.conf --sentinel\n");
2507 void redisAsciiArt(void) {
2508 #include "asciilogo.h"
2509 char *buf
= zmalloc(1024*16);
2510 char *mode
= "stand alone";
2512 if (server
.cluster_enabled
) mode
= "cluster";
2513 else if (server
.sentinel_mode
) mode
= "sentinel";
2515 snprintf(buf
,1024*16,ascii_logo
,
2518 strtol(redisGitDirty(),NULL
,10) > 0,
2519 (sizeof(long) == 8) ? "64" : "32",
2523 redisLogRaw(REDIS_NOTICE
|REDIS_LOG_RAW
,buf
);
2527 static void sigtermHandler(int sig
) {
2530 redisLogFromHandler(REDIS_WARNING
,"Received SIGTERM, scheduling shutdown...");
2531 server
.shutdown_asap
= 1;
2534 void setupSignalHandlers(void) {
2535 struct sigaction act
;
2537 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction is used.
2538 * Otherwise, sa_handler is used. */
2539 sigemptyset(&act
.sa_mask
);
2541 act
.sa_handler
= sigtermHandler
;
2542 sigaction(SIGTERM
, &act
, NULL
);
2544 #ifdef HAVE_BACKTRACE
2545 sigemptyset(&act
.sa_mask
);
2546 act
.sa_flags
= SA_NODEFER
| SA_RESETHAND
| SA_SIGINFO
;
2547 act
.sa_sigaction
= sigsegvHandler
;
2548 sigaction(SIGSEGV
, &act
, NULL
);
2549 sigaction(SIGBUS
, &act
, NULL
);
2550 sigaction(SIGFPE
, &act
, NULL
);
2551 sigaction(SIGILL
, &act
, NULL
);
2556 void memtest(size_t megabytes
, int passes
);
2558 /* Returns 1 if there is --sentinel among the arguments or if
2559 * argv[0] is exactly "redis-sentinel". */
2560 int checkForSentinelMode(int argc
, char **argv
) {
2563 if (strstr(argv
[0],"redis-sentinel") != NULL
) return 1;
2564 for (j
= 1; j
< argc
; j
++)
2565 if (!strcmp(argv
[j
],"--sentinel")) return 1;
2569 /* Function called at startup to load RDB or AOF file in memory. */
2570 void loadDataFromDisk(void) {
2571 long long start
= ustime();
2572 if (server
.aof_state
== REDIS_AOF_ON
) {
2573 if (loadAppendOnlyFile(server
.aof_filename
) == REDIS_OK
)
2574 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %.3f seconds",(float)(ustime()-start
)/1000000);
2576 if (rdbLoad(server
.rdb_filename
) == REDIS_OK
) {
2577 redisLog(REDIS_NOTICE
,"DB loaded from disk: %.3f seconds",
2578 (float)(ustime()-start
)/1000000);
2579 } else if (errno
!= ENOENT
) {
2580 redisLog(REDIS_WARNING
,"Fatal error loading the DB. Exiting.");
2586 void redisOutOfMemoryHandler(size_t allocation_size
) {
2587 redisLog(REDIS_WARNING
,"Out Of Memory allocating %zu bytes!",
2592 int main(int argc
, char **argv
) {
2595 /* We need to initialize our libraries, and the server configuration. */
2596 zmalloc_enable_thread_safeness();
2597 zmalloc_set_oom_handler(redisOutOfMemoryHandler
);
2598 srand(time(NULL
)^getpid());
2599 gettimeofday(&tv
,NULL
);
2600 dictSetHashFunctionSeed(tv
.tv_sec
^tv
.tv_usec
^getpid());
2601 server
.sentinel_mode
= checkForSentinelMode(argc
,argv
);
2604 /* We need to init sentinel right now as parsing the configuration file
2605 * in sentinel mode will have the effect of populating the sentinel
2606 * data structures with master nodes to monitor. */
2607 if (server
.sentinel_mode
) {
2608 initSentinelConfig();
2613 int j
= 1; /* First option to parse in argv[] */
2614 sds options
= sdsempty();
2615 char *configfile
= NULL
;
2617 /* Handle special options --help and --version */
2618 if (strcmp(argv
[1], "-v") == 0 ||
2619 strcmp(argv
[1], "--version") == 0) version();
2620 if (strcmp(argv
[1], "--help") == 0 ||
2621 strcmp(argv
[1], "-h") == 0) usage();
2622 if (strcmp(argv
[1], "--test-memory") == 0) {
2624 memtest(atoi(argv
[2]),50);
2627 fprintf(stderr
,"Please specify the amount of memory to test in megabytes.\n");
2628 fprintf(stderr
,"Example: ./redis-server --test-memory 4096\n\n");
2633 /* First argument is the config file name? */
2634 if (argv
[j
][0] != '-' || argv
[j
][1] != '-')
2635 configfile
= argv
[j
++];
2636 /* All the other options are parsed and conceptually appended to the
2637 * configuration file. For instance --port 6380 will generate the
2638 * string "port 6380\n" to be parsed after the actual file name
2639 * is parsed, if any. */
2641 if (argv
[j
][0] == '-' && argv
[j
][1] == '-') {
2643 if (sdslen(options
)) options
= sdscat(options
,"\n");
2644 options
= sdscat(options
,argv
[j
]+2);
2645 options
= sdscat(options
," ");
2647 /* Option argument */
2648 options
= sdscatrepr(options
,argv
[j
],strlen(argv
[j
]));
2649 options
= sdscat(options
," ");
2653 resetServerSaveParams();
2654 loadServerConfig(configfile
,options
);
2657 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");
2659 if (server
.daemonize
) daemonize();
2661 if (server
.daemonize
) createPidFile();
2664 if (!server
.sentinel_mode
) {
2665 /* Things only needed when not running in Sentinel mode. */
2666 redisLog(REDIS_WARNING
,"Server started, Redis version " REDIS_VERSION
);
2668 linuxOvercommitMemoryWarning();
2671 if (server
.ipfd
> 0)
2672 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
2673 if (server
.sofd
> 0)
2674 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections at %s", server
.unixsocket
);
2677 /* Warning the user about suspicious maxmemory setting. */
2678 if (server
.maxmemory
> 0 && server
.maxmemory
< 1024*1024) {
2679 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
);
2682 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
2684 aeDeleteEventLoop(server
.el
);