2 * Copyright (c) 2009-2010, Salvatore Sanfilippo <antirez at gmail dot com>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
8 * * Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * * Neither the name of Redis nor the names of its contributors may be used
14 * to endorse or promote products derived from this software without
15 * specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 * POSSIBILITY OF SUCH DAMAGE.
41 #include <arpa/inet.h>
45 #include <sys/resource.h>
50 #include <sys/resource.h>
52 /* Our shared "common" objects */
54 struct sharedObjectsStruct shared
;
56 /* Global vars that are actually used as constants. The following double
57 * values are used for double on-disk serialization, and are initialized
58 * at runtime to avoid strange compiler optimizations. */
60 double R_Zero
, R_PosInf
, R_NegInf
, R_Nan
;
62 /*================================= Globals ================================= */
65 struct redisServer server
; /* server global state */
66 struct redisCommand
*commandTable
;
70 * Every entry is composed of the following fields:
72 * name: a string representing the command name.
73 * function: pointer to the C function implementing the command.
74 * arity: number of arguments, it is possible to use -N to say >= N
75 * sflags: command flags as string. See below for a table of flags.
76 * flags: flags as bitmask. Computed by Redis using the 'sflags' field.
77 * get_keys_proc: an optional function to get key arguments from a command.
78 * This is only used when the following three fields are not
79 * enough to specify what arguments are keys.
80 * first_key_index: first argument that is a key
81 * last_key_index: last argument that is a key
82 * key_step: step to get all the keys from first to last argument. For instance
83 * in MSET the step is two since arguments are key,val,key,val,...
84 * microseconds: microseconds of total execution time for this command.
85 * calls: total number of calls of this command.
87 * The flags, microseconds and calls fields are computed by Redis and should
88 * always be set to zero.
90 * Command flags are expressed using strings where every character represents
91 * a flag. Later the populateCommandTable() function will take care of
92 * populating the real 'flags' field using this characters.
94 * This is the meaning of the flags:
96 * w: write command (may modify the key space).
97 * r: read command (will never modify the key space).
98 * m: may increase memory usage once called. Don't allow if out of memory.
99 * a: admin command, like SAVE or SHUTDOWN.
100 * p: Pub/Sub related command.
101 * f: force replication of this command, regarless of server.dirty.
102 * s: command not allowed in scripts.
103 * R: random command. Command is not deterministic, that is, the same command
104 * with the same arguments, with the same key space, may have different
105 * results. For instance SPOP and RANDOMKEY are two random commands.
106 * S: Sort command output array if called from script, so that the output
109 struct redisCommand redisCommandTable
[] = {
110 {"get",getCommand
,2,"r",0,NULL
,1,1,1,0,0},
111 {"set",setCommand
,3,"wm",0,noPreloadGetKeys
,1,1,1,0,0},
112 {"setnx",setnxCommand
,3,"wm",0,noPreloadGetKeys
,1,1,1,0,0},
113 {"setex",setexCommand
,4,"wm",0,noPreloadGetKeys
,1,1,1,0,0},
114 {"psetex",psetexCommand
,4,"wm",0,noPreloadGetKeys
,1,1,1,0,0},
115 {"append",appendCommand
,3,"wm",0,NULL
,1,1,1,0,0},
116 {"strlen",strlenCommand
,2,"r",0,NULL
,1,1,1,0,0},
117 {"del",delCommand
,-2,"w",0,noPreloadGetKeys
,1,-1,1,0,0},
118 {"exists",existsCommand
,2,"r",0,NULL
,1,1,1,0,0},
119 {"setbit",setbitCommand
,4,"wm",0,NULL
,1,1,1,0,0},
120 {"getbit",getbitCommand
,3,"r",0,NULL
,1,1,1,0,0},
121 {"setrange",setrangeCommand
,4,"wm",0,NULL
,1,1,1,0,0},
122 {"getrange",getrangeCommand
,4,"r",0,NULL
,1,1,1,0,0},
123 {"substr",getrangeCommand
,4,"r",0,NULL
,1,1,1,0,0},
124 {"incr",incrCommand
,2,"wm",0,NULL
,1,1,1,0,0},
125 {"decr",decrCommand
,2,"wm",0,NULL
,1,1,1,0,0},
126 {"mget",mgetCommand
,-2,"r",0,NULL
,1,-1,1,0,0},
127 {"rpush",rpushCommand
,-3,"wm",0,NULL
,1,1,1,0,0},
128 {"lpush",lpushCommand
,-3,"wm",0,NULL
,1,1,1,0,0},
129 {"rpushx",rpushxCommand
,3,"wm",0,NULL
,1,1,1,0,0},
130 {"lpushx",lpushxCommand
,3,"wm",0,NULL
,1,1,1,0,0},
131 {"linsert",linsertCommand
,5,"wm",0,NULL
,1,1,1,0,0},
132 {"rpop",rpopCommand
,2,"w",0,NULL
,1,1,1,0,0},
133 {"lpop",lpopCommand
,2,"w",0,NULL
,1,1,1,0,0},
134 {"brpop",brpopCommand
,-3,"ws",0,NULL
,1,1,1,0,0},
135 {"brpoplpush",brpoplpushCommand
,4,"wms",0,NULL
,1,2,1,0,0},
136 {"blpop",blpopCommand
,-3,"ws",0,NULL
,1,-2,1,0,0},
137 {"llen",llenCommand
,2,"r",0,NULL
,1,1,1,0,0},
138 {"lindex",lindexCommand
,3,"r",0,NULL
,1,1,1,0,0},
139 {"lset",lsetCommand
,4,"wm",0,NULL
,1,1,1,0,0},
140 {"lrange",lrangeCommand
,4,"r",0,NULL
,1,1,1,0,0},
141 {"ltrim",ltrimCommand
,4,"w",0,NULL
,1,1,1,0,0},
142 {"lrem",lremCommand
,4,"w",0,NULL
,1,1,1,0,0},
143 {"rpoplpush",rpoplpushCommand
,3,"wm",0,NULL
,1,2,1,0,0},
144 {"sadd",saddCommand
,-3,"wm",0,NULL
,1,1,1,0,0},
145 {"srem",sremCommand
,-3,"w",0,NULL
,1,1,1,0,0},
146 {"smove",smoveCommand
,4,"w",0,NULL
,1,2,1,0,0},
147 {"sismember",sismemberCommand
,3,"r",0,NULL
,1,1,1,0,0},
148 {"scard",scardCommand
,2,"r",0,NULL
,1,1,1,0,0},
149 {"spop",spopCommand
,2,"wRs",0,NULL
,1,1,1,0,0},
150 {"srandmember",srandmemberCommand
,2,"rR",0,NULL
,1,1,1,0,0},
151 {"sinter",sinterCommand
,-2,"rS",0,NULL
,1,-1,1,0,0},
152 {"sinterstore",sinterstoreCommand
,-3,"wm",0,NULL
,1,-1,1,0,0},
153 {"sunion",sunionCommand
,-2,"rS",0,NULL
,1,-1,1,0,0},
154 {"sunionstore",sunionstoreCommand
,-3,"wm",0,NULL
,1,-1,1,0,0},
155 {"sdiff",sdiffCommand
,-2,"rS",0,NULL
,1,-1,1,0,0},
156 {"sdiffstore",sdiffstoreCommand
,-3,"wm",0,NULL
,1,-1,1,0,0},
157 {"smembers",sinterCommand
,2,"rS",0,NULL
,1,1,1,0,0},
158 {"zadd",zaddCommand
,-4,"wm",0,NULL
,1,1,1,0,0},
159 {"zincrby",zincrbyCommand
,4,"wm",0,NULL
,1,1,1,0,0},
160 {"zrem",zremCommand
,-3,"w",0,NULL
,1,1,1,0,0},
161 {"zremrangebyscore",zremrangebyscoreCommand
,4,"w",0,NULL
,1,1,1,0,0},
162 {"zremrangebyrank",zremrangebyrankCommand
,4,"w",0,NULL
,1,1,1,0,0},
163 {"zunionstore",zunionstoreCommand
,-4,"wm",0,zunionInterGetKeys
,0,0,0,0,0},
164 {"zinterstore",zinterstoreCommand
,-4,"wm",0,zunionInterGetKeys
,0,0,0,0,0},
165 {"zrange",zrangeCommand
,-4,"r",0,NULL
,1,1,1,0,0},
166 {"zrangebyscore",zrangebyscoreCommand
,-4,"r",0,NULL
,1,1,1,0,0},
167 {"zrevrangebyscore",zrevrangebyscoreCommand
,-4,"r",0,NULL
,1,1,1,0,0},
168 {"zcount",zcountCommand
,4,"r",0,NULL
,1,1,1,0,0},
169 {"zrevrange",zrevrangeCommand
,-4,"r",0,NULL
,1,1,1,0,0},
170 {"zcard",zcardCommand
,2,"r",0,NULL
,1,1,1,0,0},
171 {"zscore",zscoreCommand
,3,"r",0,NULL
,1,1,1,0,0},
172 {"zrank",zrankCommand
,3,"r",0,NULL
,1,1,1,0,0},
173 {"zrevrank",zrevrankCommand
,3,"r",0,NULL
,1,1,1,0,0},
174 {"hset",hsetCommand
,4,"wm",0,NULL
,1,1,1,0,0},
175 {"hsetnx",hsetnxCommand
,4,"wm",0,NULL
,1,1,1,0,0},
176 {"hget",hgetCommand
,3,"r",0,NULL
,1,1,1,0,0},
177 {"hmset",hmsetCommand
,-4,"wm",0,NULL
,1,1,1,0,0},
178 {"hmget",hmgetCommand
,-3,"r",0,NULL
,1,1,1,0,0},
179 {"hincrby",hincrbyCommand
,4,"wm",0,NULL
,1,1,1,0,0},
180 {"hincrbyfloat",hincrbyfloatCommand
,4,"wm",0,NULL
,1,1,1,0,0},
181 {"hdel",hdelCommand
,-3,"w",0,NULL
,1,1,1,0,0},
182 {"hlen",hlenCommand
,2,"r",0,NULL
,1,1,1,0,0},
183 {"hkeys",hkeysCommand
,2,"rS",0,NULL
,1,1,1,0,0},
184 {"hvals",hvalsCommand
,2,"rS",0,NULL
,1,1,1,0,0},
185 {"hgetall",hgetallCommand
,2,"r",0,NULL
,1,1,1,0,0},
186 {"hexists",hexistsCommand
,3,"r",0,NULL
,1,1,1,0,0},
187 {"incrby",incrbyCommand
,3,"wm",0,NULL
,1,1,1,0,0},
188 {"decrby",decrbyCommand
,3,"wm",0,NULL
,1,1,1,0,0},
189 {"incrbyfloat",incrbyfloatCommand
,3,"wm",0,NULL
,1,1,1,0,0},
190 {"getset",getsetCommand
,3,"wm",0,NULL
,1,1,1,0,0},
191 {"mset",msetCommand
,-3,"wm",0,NULL
,1,-1,2,0,0},
192 {"msetnx",msetnxCommand
,-3,"wm",0,NULL
,1,-1,2,0,0},
193 {"randomkey",randomkeyCommand
,1,"rR",0,NULL
,0,0,0,0,0},
194 {"select",selectCommand
,2,"r",0,NULL
,0,0,0,0,0},
195 {"move",moveCommand
,3,"w",0,NULL
,1,1,1,0,0},
196 {"rename",renameCommand
,3,"w",0,renameGetKeys
,1,2,1,0,0},
197 {"renamenx",renamenxCommand
,3,"w",0,renameGetKeys
,1,2,1,0,0},
198 {"expire",expireCommand
,3,"w",0,NULL
,1,1,1,0,0},
199 {"expireat",expireatCommand
,3,"w",0,NULL
,1,1,1,0,0},
200 {"pexpire",pexpireCommand
,3,"w",0,NULL
,1,1,1,0,0},
201 {"pexpireat",pexpireatCommand
,3,"w",0,NULL
,1,1,1,0,0},
202 {"keys",keysCommand
,2,"rS",0,NULL
,0,0,0,0,0},
203 {"dbsize",dbsizeCommand
,1,"r",0,NULL
,0,0,0,0,0},
204 {"auth",authCommand
,2,"rs",0,NULL
,0,0,0,0,0},
205 {"ping",pingCommand
,1,"r",0,NULL
,0,0,0,0,0},
206 {"echo",echoCommand
,2,"r",0,NULL
,0,0,0,0,0},
207 {"save",saveCommand
,1,"ars",0,NULL
,0,0,0,0,0},
208 {"bgsave",bgsaveCommand
,1,"ar",0,NULL
,0,0,0,0,0},
209 {"bgrewriteaof",bgrewriteaofCommand
,1,"ar",0,NULL
,0,0,0,0,0},
210 {"shutdown",shutdownCommand
,-1,"ar",0,NULL
,0,0,0,0,0},
211 {"lastsave",lastsaveCommand
,1,"r",0,NULL
,0,0,0,0,0},
212 {"type",typeCommand
,2,"r",0,NULL
,1,1,1,0,0},
213 {"multi",multiCommand
,1,"rs",0,NULL
,0,0,0,0,0},
214 {"exec",execCommand
,1,"wms",0,NULL
,0,0,0,0,0},
215 {"discard",discardCommand
,1,"rs",0,NULL
,0,0,0,0,0},
216 {"sync",syncCommand
,1,"ars",0,NULL
,0,0,0,0,0},
217 {"flushdb",flushdbCommand
,1,"w",0,NULL
,0,0,0,0,0},
218 {"flushall",flushallCommand
,1,"w",0,NULL
,0,0,0,0,0},
219 {"sort",sortCommand
,-2,"wmS",0,NULL
,1,1,1,0,0},
220 {"info",infoCommand
,-1,"r",0,NULL
,0,0,0,0,0},
221 {"monitor",monitorCommand
,1,"ars",0,NULL
,0,0,0,0,0},
222 {"ttl",ttlCommand
,2,"r",0,NULL
,1,1,1,0,0},
223 {"pttl",pttlCommand
,2,"r",0,NULL
,1,1,1,0,0},
224 {"persist",persistCommand
,2,"w",0,NULL
,1,1,1,0,0},
225 {"slaveof",slaveofCommand
,3,"aws",0,NULL
,0,0,0,0,0},
226 {"debug",debugCommand
,-2,"aws",0,NULL
,0,0,0,0,0},
227 {"config",configCommand
,-2,"ar",0,NULL
,0,0,0,0,0},
228 {"subscribe",subscribeCommand
,-2,"rps",0,NULL
,0,0,0,0,0},
229 {"unsubscribe",unsubscribeCommand
,-1,"rps",0,NULL
,0,0,0,0,0},
230 {"psubscribe",psubscribeCommand
,-2,"rps",0,NULL
,0,0,0,0,0},
231 {"punsubscribe",punsubscribeCommand
,-1,"rps",0,NULL
,0,0,0,0,0},
232 {"publish",publishCommand
,3,"rpf",0,NULL
,0,0,0,0,0},
233 {"watch",watchCommand
,-2,"rs",0,noPreloadGetKeys
,1,-1,1,0,0},
234 {"unwatch",unwatchCommand
,1,"rs",0,NULL
,0,0,0,0,0},
235 {"cluster",clusterCommand
,-2,"ar",0,NULL
,0,0,0,0,0},
236 {"restore",restoreCommand
,4,"awm",0,NULL
,1,1,1,0,0},
237 {"migrate",migrateCommand
,6,"aw",0,NULL
,0,0,0,0,0},
238 {"asking",askingCommand
,1,"r",0,NULL
,0,0,0,0,0},
239 {"dump",dumpCommand
,2,"ar",0,NULL
,1,1,1,0,0},
240 {"object",objectCommand
,-2,"r",0,NULL
,2,2,2,0,0},
241 {"client",clientCommand
,-2,"ar",0,NULL
,0,0,0,0,0},
242 {"eval",evalCommand
,-3,"wms",0,zunionInterGetKeys
,0,0,0,0,0},
243 {"evalsha",evalShaCommand
,-3,"wms",0,zunionInterGetKeys
,0,0,0,0,0},
244 {"slowlog",slowlogCommand
,-2,"r",0,NULL
,0,0,0,0,0},
245 {"script",scriptCommand
,-2,"ras",0,NULL
,0,0,0,0,0},
246 {"time",timeCommand
,1,"rR",0,NULL
,0,0,0,0,0}
249 /*============================ Utility functions ============================ */
251 /* Low level logging. To use only for very big messages, otherwise
252 * redisLog() is to prefer. */
253 void redisLogRaw(int level
, const char *msg
) {
254 const int syslogLevelMap
[] = { LOG_DEBUG
, LOG_INFO
, LOG_NOTICE
, LOG_WARNING
};
255 const char *c
= ".-*#";
256 time_t now
= time(NULL
);
259 int rawmode
= (level
& REDIS_LOG_RAW
);
261 level
&= 0xff; /* clear flags */
262 if (level
< server
.verbosity
) return;
264 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
268 fprintf(fp
,"%s",msg
);
270 strftime(buf
,sizeof(buf
),"%d %b %H:%M:%S",localtime(&now
));
271 fprintf(fp
,"[%d] %s %c %s\n",(int)getpid(),buf
,c
[level
],msg
);
275 if (server
.logfile
) fclose(fp
);
277 if (server
.syslog_enabled
) syslog(syslogLevelMap
[level
], "%s", msg
);
280 /* Like redisLogRaw() but with printf-alike support. This is the funciton that
281 * is used across the code. The raw version is only used in order to dump
282 * the INFO output on crash. */
283 void redisLog(int level
, const char *fmt
, ...) {
285 char msg
[REDIS_MAX_LOGMSG_LEN
];
287 if ((level
&0xff) < server
.verbosity
) return;
290 vsnprintf(msg
, sizeof(msg
), fmt
, ap
);
293 redisLogRaw(level
,msg
);
296 /* Redis generally does not try to recover from out of memory conditions
297 * when allocating objects or strings, it is not clear if it will be possible
298 * to report this condition to the client since the networking layer itself
299 * is based on heap allocation for send buffers, so we simply abort.
300 * At least the code will be simpler to read... */
301 void oom(const char *msg
) {
302 redisLog(REDIS_WARNING
, "%s: Out of memory\n",msg
);
307 /* Return the UNIX time in microseconds */
308 long long ustime(void) {
312 gettimeofday(&tv
, NULL
);
313 ust
= ((long long)tv
.tv_sec
)*1000000;
318 /* Return the UNIX time in milliseconds */
319 long long mstime(void) {
320 return ustime()/1000;
323 /*====================== Hash table type implementation ==================== */
325 /* This is an hash table type that uses the SDS dynamic strings libary as
326 * keys and radis objects as values (objects can hold SDS strings,
329 void dictVanillaFree(void *privdata
, void *val
)
331 DICT_NOTUSED(privdata
);
335 void dictListDestructor(void *privdata
, void *val
)
337 DICT_NOTUSED(privdata
);
338 listRelease((list
*)val
);
341 int dictSdsKeyCompare(void *privdata
, const void *key1
,
345 DICT_NOTUSED(privdata
);
347 l1
= sdslen((sds
)key1
);
348 l2
= sdslen((sds
)key2
);
349 if (l1
!= l2
) return 0;
350 return memcmp(key1
, key2
, l1
) == 0;
353 /* A case insensitive version used for the command lookup table. */
354 int dictSdsKeyCaseCompare(void *privdata
, const void *key1
,
357 DICT_NOTUSED(privdata
);
359 return strcasecmp(key1
, key2
) == 0;
362 void dictRedisObjectDestructor(void *privdata
, void *val
)
364 DICT_NOTUSED(privdata
);
366 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
370 void dictSdsDestructor(void *privdata
, void *val
)
372 DICT_NOTUSED(privdata
);
377 int dictObjKeyCompare(void *privdata
, const void *key1
,
380 const robj
*o1
= key1
, *o2
= key2
;
381 return dictSdsKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
384 unsigned int dictObjHash(const void *key
) {
386 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
389 unsigned int dictSdsHash(const void *key
) {
390 return dictGenHashFunction((unsigned char*)key
, sdslen((char*)key
));
393 unsigned int dictSdsCaseHash(const void *key
) {
394 return dictGenCaseHashFunction((unsigned char*)key
, sdslen((char*)key
));
397 int dictEncObjKeyCompare(void *privdata
, const void *key1
,
400 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
403 if (o1
->encoding
== REDIS_ENCODING_INT
&&
404 o2
->encoding
== REDIS_ENCODING_INT
)
405 return o1
->ptr
== o2
->ptr
;
407 o1
= getDecodedObject(o1
);
408 o2
= getDecodedObject(o2
);
409 cmp
= dictSdsKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
415 unsigned int dictEncObjHash(const void *key
) {
416 robj
*o
= (robj
*) key
;
418 if (o
->encoding
== REDIS_ENCODING_RAW
) {
419 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
421 if (o
->encoding
== REDIS_ENCODING_INT
) {
425 len
= ll2string(buf
,32,(long)o
->ptr
);
426 return dictGenHashFunction((unsigned char*)buf
, len
);
430 o
= getDecodedObject(o
);
431 hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
438 /* Sets type hash table */
439 dictType setDictType
= {
440 dictEncObjHash
, /* hash function */
443 dictEncObjKeyCompare
, /* key compare */
444 dictRedisObjectDestructor
, /* key destructor */
445 NULL
/* val destructor */
448 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
449 dictType zsetDictType
= {
450 dictEncObjHash
, /* hash function */
453 dictEncObjKeyCompare
, /* key compare */
454 dictRedisObjectDestructor
, /* key destructor */
455 NULL
/* val destructor */
458 /* Db->dict, keys are sds strings, vals are Redis objects. */
459 dictType dbDictType
= {
460 dictSdsHash
, /* hash function */
463 dictSdsKeyCompare
, /* key compare */
464 dictSdsDestructor
, /* key destructor */
465 dictRedisObjectDestructor
/* val destructor */
469 dictType keyptrDictType
= {
470 dictSdsHash
, /* hash function */
473 dictSdsKeyCompare
, /* key compare */
474 NULL
, /* key destructor */
475 NULL
/* val destructor */
478 /* Command table. sds string -> command struct pointer. */
479 dictType commandTableDictType
= {
480 dictSdsCaseHash
, /* hash function */
483 dictSdsKeyCaseCompare
, /* key compare */
484 dictSdsDestructor
, /* key destructor */
485 NULL
/* val destructor */
488 /* Hash type hash table (note that small hashes are represented with zimpaps) */
489 dictType hashDictType
= {
490 dictEncObjHash
, /* hash function */
493 dictEncObjKeyCompare
, /* key compare */
494 dictRedisObjectDestructor
, /* key destructor */
495 dictRedisObjectDestructor
/* val destructor */
498 /* Keylist hash table type has unencoded redis objects as keys and
499 * lists as values. It's used for blocking operations (BLPOP) and to
500 * map swapped keys to a list of clients waiting for this keys to be loaded. */
501 dictType keylistDictType
= {
502 dictObjHash
, /* hash function */
505 dictObjKeyCompare
, /* key compare */
506 dictRedisObjectDestructor
, /* key destructor */
507 dictListDestructor
/* val destructor */
510 /* Cluster nodes hash table, mapping nodes addresses 1.2.3.4:6379 to
511 * clusterNode structures. */
512 dictType clusterNodesDictType
= {
513 dictSdsHash
, /* hash function */
516 dictSdsKeyCompare
, /* key compare */
517 dictSdsDestructor
, /* key destructor */
518 NULL
/* val destructor */
521 int htNeedsResize(dict
*dict
) {
522 long long size
, used
;
524 size
= dictSlots(dict
);
525 used
= dictSize(dict
);
526 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
527 (used
*100/size
< REDIS_HT_MINFILL
));
530 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
531 * we resize the hash table to save memory */
532 void tryResizeHashTables(void) {
535 for (j
= 0; j
< server
.dbnum
; j
++) {
536 if (htNeedsResize(server
.db
[j
].dict
))
537 dictResize(server
.db
[j
].dict
);
538 if (htNeedsResize(server
.db
[j
].expires
))
539 dictResize(server
.db
[j
].expires
);
543 /* Our hash table implementation performs rehashing incrementally while
544 * we write/read from the hash table. Still if the server is idle, the hash
545 * table will use two tables for a long time. So we try to use 1 millisecond
546 * of CPU time at every serverCron() loop in order to rehash some key. */
547 void incrementallyRehash(void) {
550 for (j
= 0; j
< server
.dbnum
; j
++) {
551 if (dictIsRehashing(server
.db
[j
].dict
)) {
552 dictRehashMilliseconds(server
.db
[j
].dict
,1);
553 break; /* already used our millisecond for this loop... */
558 /* This function is called once a background process of some kind terminates,
559 * as we want to avoid resizing the hash tables when there is a child in order
560 * to play well with copy-on-write (otherwise when a resize happens lots of
561 * memory pages are copied). The goal of this function is to update the ability
562 * for dict.c to resize the hash tables accordingly to the fact we have o not
564 void updateDictResizePolicy(void) {
565 if (server
.rdb_child_pid
== -1 && server
.aof_child_pid
== -1)
571 /* ======================= Cron: called every 100 ms ======================== */
573 /* Try to expire a few timed out keys. The algorithm used is adaptive and
574 * will use few CPU cycles if there are few expiring keys, otherwise
575 * it will get more aggressive to avoid that too much memory is used by
576 * keys that can be removed from the keyspace. */
577 void activeExpireCycle(void) {
580 for (j
= 0; j
< server
.dbnum
; j
++) {
582 redisDb
*db
= server
.db
+j
;
584 /* Continue to expire if at the end of the cycle more than 25%
585 * of the keys were expired. */
587 long num
= dictSize(db
->expires
);
588 long long now
= mstime();
591 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
592 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
597 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
598 t
= dictGetSignedIntegerVal(de
);
600 sds key
= dictGetKey(de
);
601 robj
*keyobj
= createStringObject(key
,sdslen(key
));
603 propagateExpire(db
,keyobj
);
605 decrRefCount(keyobj
);
607 server
.stat_expiredkeys
++;
610 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
614 void updateLRUClock(void) {
615 server
.lruclock
= (time(NULL
)/REDIS_LRU_CLOCK_RESOLUTION
) &
619 int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
620 int j
, loops
= server
.cronloops
;
621 REDIS_NOTUSED(eventLoop
);
623 REDIS_NOTUSED(clientData
);
625 /* We take a cached value of the unix time in the global state because
626 * with virtual memory and aging there is to store the current time
627 * in objects at every object access, and accuracy is not needed.
628 * To access a global var is faster than calling time(NULL) */
629 server
.unixtime
= time(NULL
);
631 /* We have just 22 bits per object for LRU information.
632 * So we use an (eventually wrapping) LRU clock with 10 seconds resolution.
633 * 2^22 bits with 10 seconds resoluton is more or less 1.5 years.
635 * Note that even if this will wrap after 1.5 years it's not a problem,
636 * everything will still work but just some object will appear younger
637 * to Redis. But for this to happen a given object should never be touched
640 * Note that you can change the resolution altering the
641 * REDIS_LRU_CLOCK_RESOLUTION define.
645 /* Record the max memory used since the server was started. */
646 if (zmalloc_used_memory() > server
.stat_peak_memory
)
647 server
.stat_peak_memory
= zmalloc_used_memory();
649 /* We received a SIGTERM, shutting down here in a safe way, as it is
650 * not ok doing so inside the signal handler. */
651 if (server
.shutdown_asap
) {
652 if (prepareForShutdown(0) == REDIS_OK
) exit(0);
653 redisLog(REDIS_WARNING
,"SIGTERM received but errors trying to shut down the server, check the logs for more information");
656 /* Show some info about non-empty databases */
657 for (j
= 0; j
< server
.dbnum
; j
++) {
658 long long size
, used
, vkeys
;
660 size
= dictSlots(server
.db
[j
].dict
);
661 used
= dictSize(server
.db
[j
].dict
);
662 vkeys
= dictSize(server
.db
[j
].expires
);
663 if (!(loops
% 50) && (used
|| vkeys
)) {
664 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
665 /* dictPrintStats(server.dict); */
669 /* We don't want to resize the hash tables while a bacground saving
670 * is in progress: the saving child is created using fork() that is
671 * implemented with a copy-on-write semantic in most modern systems, so
672 * if we resize the HT while there is the saving child at work actually
673 * a lot of memory movements in the parent will cause a lot of pages
675 if (server
.rdb_child_pid
== -1 && server
.aof_child_pid
== -1) {
676 if (!(loops
% 10)) tryResizeHashTables();
677 if (server
.activerehashing
) incrementallyRehash();
680 /* Show information about connected clients */
682 redisLog(REDIS_VERBOSE
,"%d clients connected (%d slaves), %zu bytes in use",
683 listLength(server
.clients
)-listLength(server
.slaves
),
684 listLength(server
.slaves
),
685 zmalloc_used_memory());
688 /* Close connections of timedout clients */
689 if ((server
.maxidletime
&& !(loops
% 100)) || server
.bpop_blocked_clients
)
690 closeTimedoutClients();
692 /* Start a scheduled AOF rewrite if this was requested by the user while
693 * a BGSAVE was in progress. */
694 if (server
.rdb_child_pid
== -1 && server
.aof_child_pid
== -1 &&
695 server
.aof_rewrite_scheduled
)
697 rewriteAppendOnlyFileBackground();
700 /* Check if a background saving or AOF rewrite in progress terminated. */
701 if (server
.rdb_child_pid
!= -1 || server
.aof_child_pid
!= -1) {
705 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
706 int exitcode
= WEXITSTATUS(statloc
);
709 if (WIFSIGNALED(statloc
)) bysignal
= WTERMSIG(statloc
);
711 if (pid
== server
.rdb_child_pid
) {
712 backgroundSaveDoneHandler(exitcode
,bysignal
);
714 backgroundRewriteDoneHandler(exitcode
,bysignal
);
716 updateDictResizePolicy();
719 time_t now
= time(NULL
);
721 /* If there is not a background saving/rewrite in progress check if
722 * we have to save/rewrite now */
723 for (j
= 0; j
< server
.saveparamslen
; j
++) {
724 struct saveparam
*sp
= server
.saveparams
+j
;
726 if (server
.dirty
>= sp
->changes
&&
727 now
-server
.lastsave
> sp
->seconds
) {
728 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
729 sp
->changes
, sp
->seconds
);
730 rdbSaveBackground(server
.rdb_filename
);
735 /* Trigger an AOF rewrite if needed */
736 if (server
.rdb_child_pid
== -1 &&
737 server
.aof_child_pid
== -1 &&
738 server
.aof_rewrite_perc
&&
739 server
.aof_current_size
> server
.aof_rewrite_min_size
)
741 long long base
= server
.aof_rewrite_base_size
?
742 server
.aof_rewrite_base_size
: 1;
743 long long growth
= (server
.aof_current_size
*100/base
) - 100;
744 if (growth
>= server
.aof_rewrite_perc
) {
745 redisLog(REDIS_NOTICE
,"Starting automatic rewriting of AOF on %lld%% growth",growth
);
746 rewriteAppendOnlyFileBackground();
752 /* If we postponed an AOF buffer flush, let's try to do it every time the
753 * cron function is called. */
754 if (server
.aof_flush_postponed_start
) flushAppendOnlyFile(0);
756 /* Expire a few keys per cycle, only if this is a master.
757 * On slaves we wait for DEL operations synthesized by the master
758 * in order to guarantee a strict consistency. */
759 if (server
.masterhost
== NULL
) activeExpireCycle();
761 /* Close clients that need to be closed asynchronous */
762 freeClientsInAsyncFreeQueue();
764 /* Replication cron function -- used to reconnect to master and
765 * to detect transfer failures. */
766 if (!(loops
% 10)) replicationCron();
768 /* Run other sub-systems specific cron jobs */
769 if (server
.cluster_enabled
&& !(loops
% 10)) clusterCron();
775 /* This function gets called every time Redis is entering the
776 * main loop of the event driven library, that is, before to sleep
777 * for ready file descriptors. */
778 void beforeSleep(struct aeEventLoop
*eventLoop
) {
779 REDIS_NOTUSED(eventLoop
);
783 /* Try to process pending commands for clients that were just unblocked. */
784 while (listLength(server
.unblocked_clients
)) {
785 ln
= listFirst(server
.unblocked_clients
);
786 redisAssert(ln
!= NULL
);
788 listDelNode(server
.unblocked_clients
,ln
);
789 c
->flags
&= ~REDIS_UNBLOCKED
;
791 /* Process remaining data in the input buffer. */
792 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) {
793 server
.current_client
= c
;
794 processInputBuffer(c
);
795 server
.current_client
= NULL
;
799 /* Write the AOF buffer on disk */
800 flushAppendOnlyFile(0);
803 /* =========================== Server initialization ======================== */
805 void createSharedObjects(void) {
808 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
809 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
810 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
811 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
812 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
813 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
814 shared
.cnegone
= createObject(REDIS_STRING
,sdsnew(":-1\r\n"));
815 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
816 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
817 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
818 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
819 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
820 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
821 "-ERR Operation against a key holding the wrong kind of value\r\n"));
822 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
823 "-ERR no such key\r\n"));
824 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
825 "-ERR syntax error\r\n"));
826 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
827 "-ERR source and destination objects are the same\r\n"));
828 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
829 "-ERR index out of range\r\n"));
830 shared
.noscripterr
= createObject(REDIS_STRING
,sdsnew(
831 "-NOSCRIPT No matching script. Please use EVAL.\r\n"));
832 shared
.loadingerr
= createObject(REDIS_STRING
,sdsnew(
833 "-LOADING Redis is loading the dataset in memory\r\n"));
834 shared
.slowscripterr
= createObject(REDIS_STRING
,sdsnew(
835 "-BUSY Redis is busy running a script. You can only call SCRIPT KILL or SHUTDOWN NOSAVE.\r\n"));
836 shared
.bgsaveerr
= createObject(REDIS_STRING
,sdsnew(
837 "-MISCONF Redis is configured to save RDB snapshots, but is currently not able to persist on disk. Write commands are disabled. Please check Redis logs for details about the error.\r\n"));
838 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
839 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
840 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
841 shared
.select0
= createStringObject("select 0\r\n",10);
842 shared
.select1
= createStringObject("select 1\r\n",10);
843 shared
.select2
= createStringObject("select 2\r\n",10);
844 shared
.select3
= createStringObject("select 3\r\n",10);
845 shared
.select4
= createStringObject("select 4\r\n",10);
846 shared
.select5
= createStringObject("select 5\r\n",10);
847 shared
.select6
= createStringObject("select 6\r\n",10);
848 shared
.select7
= createStringObject("select 7\r\n",10);
849 shared
.select8
= createStringObject("select 8\r\n",10);
850 shared
.select9
= createStringObject("select 9\r\n",10);
851 shared
.messagebulk
= createStringObject("$7\r\nmessage\r\n",13);
852 shared
.pmessagebulk
= createStringObject("$8\r\npmessage\r\n",14);
853 shared
.subscribebulk
= createStringObject("$9\r\nsubscribe\r\n",15);
854 shared
.unsubscribebulk
= createStringObject("$11\r\nunsubscribe\r\n",18);
855 shared
.psubscribebulk
= createStringObject("$10\r\npsubscribe\r\n",17);
856 shared
.punsubscribebulk
= createStringObject("$12\r\npunsubscribe\r\n",19);
857 shared
.del
= createStringObject("DEL",3);
858 shared
.rpop
= createStringObject("RPOP",4);
859 shared
.lpop
= createStringObject("LPOP",4);
860 for (j
= 0; j
< REDIS_SHARED_INTEGERS
; j
++) {
861 shared
.integers
[j
] = createObject(REDIS_STRING
,(void*)(long)j
);
862 shared
.integers
[j
]->encoding
= REDIS_ENCODING_INT
;
864 for (j
= 0; j
< REDIS_SHARED_BULKHDR_LEN
; j
++) {
865 shared
.mbulkhdr
[j
] = createObject(REDIS_STRING
,
866 sdscatprintf(sdsempty(),"*%d\r\n",j
));
867 shared
.bulkhdr
[j
] = createObject(REDIS_STRING
,
868 sdscatprintf(sdsempty(),"$%d\r\n",j
));
872 void initServerConfig() {
873 server
.arch_bits
= (sizeof(long) == 8) ? 64 : 32;
874 server
.port
= REDIS_SERVERPORT
;
875 server
.bindaddr
= NULL
;
876 server
.unixsocket
= NULL
;
877 server
.unixsocketperm
= 0;
880 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
881 server
.verbosity
= REDIS_NOTICE
;
882 server
.maxidletime
= REDIS_MAXIDLETIME
;
883 server
.client_max_querybuf_len
= REDIS_MAX_QUERYBUF_LEN
;
884 server
.saveparams
= NULL
;
886 server
.logfile
= NULL
; /* NULL = log on standard output */
887 server
.syslog_enabled
= 0;
888 server
.syslog_ident
= zstrdup("redis");
889 server
.syslog_facility
= LOG_LOCAL0
;
890 server
.daemonize
= 0;
891 server
.aof_state
= REDIS_AOF_OFF
;
892 server
.aof_fsync
= AOF_FSYNC_EVERYSEC
;
893 server
.aof_no_fsync_on_rewrite
= 0;
894 server
.aof_rewrite_perc
= REDIS_AOF_REWRITE_PERC
;
895 server
.aof_rewrite_min_size
= REDIS_AOF_REWRITE_MIN_SIZE
;
896 server
.aof_rewrite_base_size
= 0;
897 server
.aof_rewrite_scheduled
= 0;
898 server
.aof_last_fsync
= time(NULL
);
900 server
.aof_selected_db
= -1; /* Make sure the first time will not match */
901 server
.aof_flush_postponed_start
= 0;
902 server
.pidfile
= zstrdup("/var/run/redis.pid");
903 server
.rdb_filename
= zstrdup("dump.rdb");
904 server
.aof_filename
= zstrdup("appendonly.aof");
905 server
.requirepass
= NULL
;
906 server
.rdb_compression
= 1;
907 server
.activerehashing
= 1;
908 server
.maxclients
= REDIS_MAX_CLIENTS
;
909 server
.bpop_blocked_clients
= 0;
910 server
.maxmemory
= 0;
911 server
.maxmemory_policy
= REDIS_MAXMEMORY_VOLATILE_LRU
;
912 server
.maxmemory_samples
= 3;
913 server
.hash_max_zipmap_entries
= REDIS_HASH_MAX_ZIPMAP_ENTRIES
;
914 server
.hash_max_zipmap_value
= REDIS_HASH_MAX_ZIPMAP_VALUE
;
915 server
.list_max_ziplist_entries
= REDIS_LIST_MAX_ZIPLIST_ENTRIES
;
916 server
.list_max_ziplist_value
= REDIS_LIST_MAX_ZIPLIST_VALUE
;
917 server
.set_max_intset_entries
= REDIS_SET_MAX_INTSET_ENTRIES
;
918 server
.zset_max_ziplist_entries
= REDIS_ZSET_MAX_ZIPLIST_ENTRIES
;
919 server
.zset_max_ziplist_value
= REDIS_ZSET_MAX_ZIPLIST_VALUE
;
920 server
.shutdown_asap
= 0;
921 server
.repl_ping_slave_period
= REDIS_REPL_PING_SLAVE_PERIOD
;
922 server
.repl_timeout
= REDIS_REPL_TIMEOUT
;
923 server
.cluster_enabled
= 0;
924 server
.cluster
.configfile
= zstrdup("nodes.conf");
925 server
.lua_caller
= NULL
;
926 server
.lua_time_limit
= REDIS_LUA_TIME_LIMIT
;
927 server
.lua_client
= NULL
;
928 server
.lua_timedout
= 0;
931 resetServerSaveParams();
933 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
934 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
935 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
936 /* Replication related */
937 server
.masterauth
= NULL
;
938 server
.masterhost
= NULL
;
939 server
.masterport
= 6379;
940 server
.master
= NULL
;
941 server
.repl_state
= REDIS_REPL_NONE
;
942 server
.repl_syncio_timeout
= REDIS_REPL_SYNCIO_TIMEOUT
;
943 server
.repl_serve_stale_data
= 1;
944 server
.repl_down_since
= -1;
946 /* Client output buffer limits */
947 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_NORMAL
].hard_limit_bytes
= 0;
948 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_NORMAL
].soft_limit_bytes
= 0;
949 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_NORMAL
].soft_limit_seconds
= 0;
950 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_SLAVE
].hard_limit_bytes
= 1024*1024*256;
951 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_SLAVE
].soft_limit_bytes
= 1024*1024*64;
952 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_SLAVE
].soft_limit_seconds
= 60;
953 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_PUBSUB
].hard_limit_bytes
= 1024*1024*32;
954 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_PUBSUB
].soft_limit_bytes
= 1024*1024*8;
955 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_PUBSUB
].soft_limit_seconds
= 60;
957 /* Double constants initialization */
959 R_PosInf
= 1.0/R_Zero
;
960 R_NegInf
= -1.0/R_Zero
;
961 R_Nan
= R_Zero
/R_Zero
;
963 /* Command table -- we intiialize it here as it is part of the
964 * initial configuration, since command names may be changed via
965 * redis.conf using the rename-command directive. */
966 server
.commands
= dictCreate(&commandTableDictType
,NULL
);
967 populateCommandTable();
968 server
.delCommand
= lookupCommandByCString("del");
969 server
.multiCommand
= lookupCommandByCString("multi");
970 server
.lpushCommand
= lookupCommandByCString("lpush");
973 server
.slowlog_log_slower_than
= REDIS_SLOWLOG_LOG_SLOWER_THAN
;
974 server
.slowlog_max_len
= REDIS_SLOWLOG_MAX_LEN
;
977 server
.assert_failed
= "<no assertion failed>";
978 server
.assert_file
= "<no file>";
979 server
.assert_line
= 0;
980 server
.bug_report_start
= 0;
983 /* This function will try to raise the max number of open files accordingly to
984 * the configured max number of clients. It will also account for 32 additional
985 * file descriptors as we need a few more for persistence, listening
986 * sockets, log files and so forth.
988 * If it will not be possible to set the limit accordingly to the configured
989 * max number of clients, the function will do the reverse setting
990 * server.maxclients to the value that we can actually handle. */
991 void adjustOpenFilesLimit(void) {
992 rlim_t maxfiles
= server
.maxclients
+32;
995 if (maxfiles
< 1024) maxfiles
= 1024;
996 if (getrlimit(RLIMIT_NOFILE
,&limit
) == -1) {
997 redisLog(REDIS_WARNING
,"Unable to obtain the current NOFILE limit (%s), assuming 1024 and setting the max clients configuration accordingly.",
999 server
.maxclients
= 1024-32;
1001 rlim_t oldlimit
= limit
.rlim_cur
;
1003 /* Set the max number of files if the current limit is not enough
1005 if (oldlimit
< maxfiles
) {
1006 limit
.rlim_cur
= maxfiles
;
1007 limit
.rlim_max
= maxfiles
;
1008 if (setrlimit(RLIMIT_NOFILE
,&limit
) == -1) {
1009 server
.maxclients
= oldlimit
-32;
1010 redisLog(REDIS_WARNING
,"Unable to set the max number of files limit to %d (%s), setting the max clients configuration to %d.",
1011 (int) maxfiles
, strerror(errno
), (int) server
.maxclients
);
1013 redisLog(REDIS_NOTICE
,"Max number of open files set to %d",
1023 signal(SIGHUP
, SIG_IGN
);
1024 signal(SIGPIPE
, SIG_IGN
);
1025 setupSignalHandlers();
1027 if (server
.syslog_enabled
) {
1028 openlog(server
.syslog_ident
, LOG_PID
| LOG_NDELAY
| LOG_NOWAIT
,
1029 server
.syslog_facility
);
1032 server
.current_client
= NULL
;
1033 server
.clients
= listCreate();
1034 server
.clients_to_close
= listCreate();
1035 server
.slaves
= listCreate();
1036 server
.monitors
= listCreate();
1037 server
.unblocked_clients
= listCreate();
1039 createSharedObjects();
1040 adjustOpenFilesLimit();
1041 server
.el
= aeCreateEventLoop(server
.maxclients
+1024);
1042 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1044 if (server
.port
!= 0) {
1045 server
.ipfd
= anetTcpServer(server
.neterr
,server
.port
,server
.bindaddr
);
1046 if (server
.ipfd
== ANET_ERR
) {
1047 redisLog(REDIS_WARNING
, "Opening port %d: %s",
1048 server
.port
, server
.neterr
);
1052 if (server
.unixsocket
!= NULL
) {
1053 unlink(server
.unixsocket
); /* don't care if this fails */
1054 server
.sofd
= anetUnixServer(server
.neterr
,server
.unixsocket
,server
.unixsocketperm
);
1055 if (server
.sofd
== ANET_ERR
) {
1056 redisLog(REDIS_WARNING
, "Opening socket: %s", server
.neterr
);
1060 if (server
.ipfd
< 0 && server
.sofd
< 0) {
1061 redisLog(REDIS_WARNING
, "Configured to not listen anywhere, exiting.");
1064 for (j
= 0; j
< server
.dbnum
; j
++) {
1065 server
.db
[j
].dict
= dictCreate(&dbDictType
,NULL
);
1066 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1067 server
.db
[j
].blocking_keys
= dictCreate(&keylistDictType
,NULL
);
1068 server
.db
[j
].watched_keys
= dictCreate(&keylistDictType
,NULL
);
1069 server
.db
[j
].id
= j
;
1071 server
.pubsub_channels
= dictCreate(&keylistDictType
,NULL
);
1072 server
.pubsub_patterns
= listCreate();
1073 listSetFreeMethod(server
.pubsub_patterns
,freePubsubPattern
);
1074 listSetMatchMethod(server
.pubsub_patterns
,listMatchPubsubPattern
);
1075 server
.cronloops
= 0;
1076 server
.rdb_child_pid
= -1;
1077 server
.aof_child_pid
= -1;
1078 server
.aof_rewrite_buf
= sdsempty();
1079 server
.aof_buf
= sdsempty();
1080 server
.lastsave
= time(NULL
);
1082 server
.stat_numcommands
= 0;
1083 server
.stat_numconnections
= 0;
1084 server
.stat_expiredkeys
= 0;
1085 server
.stat_evictedkeys
= 0;
1086 server
.stat_starttime
= time(NULL
);
1087 server
.stat_keyspace_misses
= 0;
1088 server
.stat_keyspace_hits
= 0;
1089 server
.stat_peak_memory
= 0;
1090 server
.stat_fork_time
= 0;
1091 server
.stat_rejected_conn
= 0;
1092 server
.unixtime
= time(NULL
);
1093 server
.lastbgsave_status
= REDIS_OK
;
1094 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1095 if (server
.ipfd
> 0 && aeCreateFileEvent(server
.el
,server
.ipfd
,AE_READABLE
,
1096 acceptTcpHandler
,NULL
) == AE_ERR
) oom("creating file event");
1097 if (server
.sofd
> 0 && aeCreateFileEvent(server
.el
,server
.sofd
,AE_READABLE
,
1098 acceptUnixHandler
,NULL
) == AE_ERR
) oom("creating file event");
1100 if (server
.aof_state
== REDIS_AOF_ON
) {
1101 server
.aof_fd
= open(server
.aof_filename
,
1102 O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1103 if (server
.aof_fd
== -1) {
1104 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1110 /* 32 bit instances are limited to 4GB of address space, so if there is
1111 * no explicit limit in the user provided configuration we set a limit
1112 * at 3.5GB using maxmemory with 'noeviction' policy'. This saves
1113 * useless crashes of the Redis instance. */
1114 if (server
.arch_bits
== 32 && server
.maxmemory
== 0) {
1115 redisLog(REDIS_WARNING
,"Warning: 32 bit instance detected but no memory limit set. Setting 3.5 GB maxmemory limit with 'noeviction' policy now.");
1116 server
.maxmemory
= 3584LL*(1024*1024); /* 3584 MB = 3.5 GB */
1117 server
.maxmemory_policy
= REDIS_MAXMEMORY_NO_EVICTION
;
1120 if (server
.cluster_enabled
) clusterInit();
1126 /* Populates the Redis Command Table starting from the hard coded list
1127 * we have on top of redis.c file. */
1128 void populateCommandTable(void) {
1130 int numcommands
= sizeof(redisCommandTable
)/sizeof(struct redisCommand
);
1132 for (j
= 0; j
< numcommands
; j
++) {
1133 struct redisCommand
*c
= redisCommandTable
+j
;
1134 char *f
= c
->sflags
;
1139 case 'w': c
->flags
|= REDIS_CMD_WRITE
; break;
1140 case 'r': c
->flags
|= REDIS_CMD_READONLY
; break;
1141 case 'm': c
->flags
|= REDIS_CMD_DENYOOM
; break;
1142 case 'a': c
->flags
|= REDIS_CMD_ADMIN
; break;
1143 case 'p': c
->flags
|= REDIS_CMD_PUBSUB
; break;
1144 case 'f': c
->flags
|= REDIS_CMD_FORCE_REPLICATION
; break;
1145 case 's': c
->flags
|= REDIS_CMD_NOSCRIPT
; break;
1146 case 'R': c
->flags
|= REDIS_CMD_RANDOM
; break;
1147 case 'S': c
->flags
|= REDIS_CMD_SORT_FOR_SCRIPT
; break;
1148 default: redisPanic("Unsupported command flag"); break;
1153 retval
= dictAdd(server
.commands
, sdsnew(c
->name
), c
);
1154 assert(retval
== DICT_OK
);
1158 void resetCommandTableStats(void) {
1159 int numcommands
= sizeof(redisCommandTable
)/sizeof(struct redisCommand
);
1162 for (j
= 0; j
< numcommands
; j
++) {
1163 struct redisCommand
*c
= redisCommandTable
+j
;
1165 c
->microseconds
= 0;
1170 /* ========================== Redis OP Array API ============================ */
1172 void redisOpArrayInit(redisOpArray
*oa
) {
1177 int redisOpArrayAppend(redisOpArray
*oa
, struct redisCommand
*cmd
, int dbid
,
1178 robj
**argv
, int argc
, int target
)
1182 oa
->ops
= zrealloc(oa
->ops
,sizeof(redisOp
)*(oa
->numops
+1));
1183 op
= oa
->ops
+oa
->numops
;
1188 op
->target
= target
;
1193 void redisOpArrayFree(redisOpArray
*oa
) {
1199 op
= oa
->ops
+oa
->numops
;
1200 for (j
= 0; j
< op
->argc
; j
++)
1201 decrRefCount(op
->argv
[j
]);
1207 /* ====================== Commands lookup and execution ===================== */
1209 struct redisCommand
*lookupCommand(sds name
) {
1210 return dictFetchValue(server
.commands
, name
);
1213 struct redisCommand
*lookupCommandByCString(char *s
) {
1214 struct redisCommand
*cmd
;
1215 sds name
= sdsnew(s
);
1217 cmd
= dictFetchValue(server
.commands
, name
);
1222 /* Propagate the specified command (in the context of the specified database id)
1223 * to AOF, Slaves and Monitors.
1225 * flags are an xor between:
1226 * + REDIS_PROPAGATE_NONE (no propagation of command at all)
1227 * + REDIS_PROPAGATE_AOF (propagate into the AOF file if is enabled)
1228 * + REDIS_PROPAGATE_REPL (propagate into the replication link)
1230 void propagate(struct redisCommand
*cmd
, int dbid
, robj
**argv
, int argc
,
1233 if (server
.aof_state
!= REDIS_AOF_OFF
&& flags
& REDIS_PROPAGATE_AOF
)
1234 feedAppendOnlyFile(cmd
,dbid
,argv
,argc
);
1235 if (flags
& REDIS_PROPAGATE_REPL
&& listLength(server
.slaves
))
1236 replicationFeedSlaves(server
.slaves
,dbid
,argv
,argc
);
1239 /* Used inside commands to schedule the propagation of additional commands
1240 * after the current command is propagated to AOF / Replication. */
1241 void alsoPropagate(struct redisCommand
*cmd
, int dbid
, robj
**argv
, int argc
,
1244 redisOpArrayAppend(&server
.also_propagate
,cmd
,dbid
,argv
,argc
,target
);
1247 /* Call() is the core of Redis execution of a command */
1248 void call(redisClient
*c
, int flags
) {
1249 long long dirty
, start
= ustime(), duration
;
1251 /* Sent the command to clients in MONITOR mode, only if the commands are
1252 * not geneated from reading an AOF. */
1253 if (listLength(server
.monitors
) && !server
.loading
)
1254 replicationFeedMonitors(c
,server
.monitors
,c
->db
->id
,c
->argv
,c
->argc
);
1256 /* Call the command. */
1257 redisOpArrayInit(&server
.also_propagate
);
1258 dirty
= server
.dirty
;
1260 dirty
= server
.dirty
-dirty
;
1261 duration
= ustime()-start
;
1263 /* When EVAL is called loading the AOF we don't want commands called
1264 * from Lua to go into the slowlog or to populate statistics. */
1265 if (server
.loading
&& c
->flags
& REDIS_LUA_CLIENT
)
1266 flags
&= ~(REDIS_CALL_SLOWLOG
| REDIS_CALL_STATS
);
1268 /* Log the command into the Slow log if needed, and populate the
1269 * per-command statistics that we show in INFO commandstats. */
1270 if (flags
& REDIS_CALL_SLOWLOG
)
1271 slowlogPushEntryIfNeeded(c
->argv
,c
->argc
,duration
);
1272 if (flags
& REDIS_CALL_STATS
) {
1273 c
->cmd
->microseconds
+= duration
;
1277 /* Propagate the command into the AOF and replication link */
1278 if (flags
& REDIS_CALL_PROPAGATE
) {
1279 int flags
= REDIS_PROPAGATE_NONE
;
1281 if (c
->cmd
->flags
& REDIS_CMD_FORCE_REPLICATION
)
1282 flags
|= REDIS_PROPAGATE_REPL
;
1284 flags
|= (REDIS_PROPAGATE_REPL
| REDIS_PROPAGATE_AOF
);
1285 if (flags
!= REDIS_PROPAGATE_NONE
)
1286 propagate(c
->cmd
,c
->db
->id
,c
->argv
,c
->argc
,flags
);
1288 /* Commands such as LPUSH or BRPOPLPUSH may propagate an additional
1290 if (server
.also_propagate
.numops
) {
1294 for (j
= 0; j
< server
.also_propagate
.numops
; j
++) {
1295 rop
= &server
.also_propagate
.ops
[j
];
1296 propagate(rop
->cmd
, rop
->dbid
, rop
->argv
, rop
->argc
, rop
->target
);
1298 redisOpArrayFree(&server
.also_propagate
);
1300 server
.stat_numcommands
++;
1303 /* If this function gets called we already read a whole
1304 * command, argments are in the client argv/argc fields.
1305 * processCommand() execute the command or prepare the
1306 * server for a bulk read from the client.
1308 * If 1 is returned the client is still alive and valid and
1309 * and other operations can be performed by the caller. Otherwise
1310 * if 0 is returned the client was destroied (i.e. after QUIT). */
1311 int processCommand(redisClient
*c
) {
1312 /* The QUIT command is handled separately. Normal command procs will
1313 * go through checking for replication and QUIT will cause trouble
1314 * when FORCE_REPLICATION is enabled and would be implemented in
1315 * a regular command proc. */
1316 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
1317 addReply(c
,shared
.ok
);
1318 c
->flags
|= REDIS_CLOSE_AFTER_REPLY
;
1322 /* Now lookup the command and check ASAP about trivial error conditions
1323 * such as wrong arity, bad command name and so forth. */
1324 c
->cmd
= c
->lastcmd
= lookupCommand(c
->argv
[0]->ptr
);
1326 addReplyErrorFormat(c
,"unknown command '%s'",
1327 (char*)c
->argv
[0]->ptr
);
1329 } else if ((c
->cmd
->arity
> 0 && c
->cmd
->arity
!= c
->argc
) ||
1330 (c
->argc
< -c
->cmd
->arity
)) {
1331 addReplyErrorFormat(c
,"wrong number of arguments for '%s' command",
1336 /* Check if the user is authenticated */
1337 if (server
.requirepass
&& !c
->authenticated
&& c
->cmd
->proc
!= authCommand
)
1339 addReplyError(c
,"operation not permitted");
1343 /* If cluster is enabled, redirect here */
1344 if (server
.cluster_enabled
&&
1345 !(c
->cmd
->getkeys_proc
== NULL
&& c
->cmd
->firstkey
== 0)) {
1348 if (server
.cluster
.state
!= REDIS_CLUSTER_OK
) {
1349 addReplyError(c
,"The cluster is down. Check with CLUSTER INFO for more information");
1353 clusterNode
*n
= getNodeByQuery(c
,c
->cmd
,c
->argv
,c
->argc
,&hashslot
,&ask
);
1355 addReplyError(c
,"Multi keys request invalid in cluster");
1357 } else if (n
!= server
.cluster
.myself
) {
1358 addReplySds(c
,sdscatprintf(sdsempty(),
1359 "-%s %d %s:%d\r\n", ask
? "ASK" : "MOVED",
1360 hashslot
,n
->ip
,n
->port
));
1366 /* Handle the maxmemory directive.
1368 * First we try to free some memory if possible (if there are volatile
1369 * keys in the dataset). If there are not the only thing we can do
1370 * is returning an error. */
1371 if (server
.maxmemory
) {
1372 int retval
= freeMemoryIfNeeded();
1373 if ((c
->cmd
->flags
& REDIS_CMD_DENYOOM
) && retval
== REDIS_ERR
) {
1375 "command not allowed when used memory > 'maxmemory'");
1380 /* Don't accept write commands if there are problems persisting on disk. */
1381 if (server
.saveparamslen
> 0 && server
.lastbgsave_status
== REDIS_ERR
&&
1382 c
->cmd
->flags
& REDIS_CMD_WRITE
)
1384 addReply(c
, shared
.bgsaveerr
);
1388 /* Only allow SUBSCRIBE and UNSUBSCRIBE in the context of Pub/Sub */
1389 if ((dictSize(c
->pubsub_channels
) > 0 || listLength(c
->pubsub_patterns
) > 0)
1391 c
->cmd
->proc
!= subscribeCommand
&&
1392 c
->cmd
->proc
!= unsubscribeCommand
&&
1393 c
->cmd
->proc
!= psubscribeCommand
&&
1394 c
->cmd
->proc
!= punsubscribeCommand
) {
1395 addReplyError(c
,"only (P)SUBSCRIBE / (P)UNSUBSCRIBE / QUIT allowed in this context");
1399 /* Only allow INFO and SLAVEOF when slave-serve-stale-data is no and
1400 * we are a slave with a broken link with master. */
1401 if (server
.masterhost
&& server
.repl_state
!= REDIS_REPL_CONNECTED
&&
1402 server
.repl_serve_stale_data
== 0 &&
1403 c
->cmd
->proc
!= infoCommand
&& c
->cmd
->proc
!= slaveofCommand
)
1406 "link with MASTER is down and slave-serve-stale-data is set to no");
1410 /* Loading DB? Return an error if the command is not INFO */
1411 if (server
.loading
&& c
->cmd
->proc
!= infoCommand
) {
1412 addReply(c
, shared
.loadingerr
);
1416 /* Lua script too slow? Only allow SHUTDOWN NOSAVE and SCRIPT KILL. */
1417 if (server
.lua_timedout
&&
1418 !(c
->cmd
->proc
!= shutdownCommand
&&
1420 tolower(((char*)c
->argv
[1]->ptr
)[0]) == 'n') &&
1421 !(c
->cmd
->proc
== scriptCommand
&&
1423 tolower(((char*)c
->argv
[1]->ptr
)[0]) == 'k'))
1425 addReply(c
, shared
.slowscripterr
);
1429 /* Exec the command */
1430 if (c
->flags
& REDIS_MULTI
&&
1431 c
->cmd
->proc
!= execCommand
&& c
->cmd
->proc
!= discardCommand
&&
1432 c
->cmd
->proc
!= multiCommand
&& c
->cmd
->proc
!= watchCommand
)
1434 queueMultiCommand(c
);
1435 addReply(c
,shared
.queued
);
1437 call(c
,REDIS_CALL_FULL
);
1442 /*================================== Shutdown =============================== */
1444 int prepareForShutdown(int flags
) {
1445 int save
= flags
& REDIS_SHUTDOWN_SAVE
;
1446 int nosave
= flags
& REDIS_SHUTDOWN_NOSAVE
;
1448 redisLog(REDIS_WARNING
,"User requested shutdown...");
1449 /* Kill the saving child if there is a background saving in progress.
1450 We want to avoid race conditions, for instance our saving child may
1451 overwrite the synchronous saving did by SHUTDOWN. */
1452 if (server
.rdb_child_pid
!= -1) {
1453 redisLog(REDIS_WARNING
,"There is a child saving an .rdb. Killing it!");
1454 kill(server
.rdb_child_pid
,SIGKILL
);
1455 rdbRemoveTempFile(server
.rdb_child_pid
);
1457 if (server
.aof_state
!= REDIS_AOF_OFF
) {
1458 /* Kill the AOF saving child as the AOF we already have may be longer
1459 * but contains the full dataset anyway. */
1460 if (server
.aof_child_pid
!= -1) {
1461 redisLog(REDIS_WARNING
,
1462 "There is a child rewriting the AOF. Killing it!");
1463 kill(server
.aof_child_pid
,SIGKILL
);
1465 /* Append only file: fsync() the AOF and exit */
1466 redisLog(REDIS_NOTICE
,"Calling fsync() on the AOF file.");
1467 aof_fsync(server
.aof_fd
);
1469 if ((server
.saveparamslen
> 0 && !nosave
) || save
) {
1470 redisLog(REDIS_NOTICE
,"Saving the final RDB snapshot before exiting.");
1471 /* Snapshotting. Perform a SYNC SAVE and exit */
1472 if (rdbSave(server
.rdb_filename
) != REDIS_OK
) {
1473 /* Ooops.. error saving! The best we can do is to continue
1474 * operating. Note that if there was a background saving process,
1475 * in the next cron() Redis will be notified that the background
1476 * saving aborted, handling special stuff like slaves pending for
1477 * synchronization... */
1478 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit.");
1482 if (server
.daemonize
) {
1483 redisLog(REDIS_NOTICE
,"Removing the pid file.");
1484 unlink(server
.pidfile
);
1486 /* Close the listening sockets. Apparently this allows faster restarts. */
1487 if (server
.ipfd
!= -1) close(server
.ipfd
);
1488 if (server
.sofd
!= -1) close(server
.sofd
);
1489 if (server
.unixsocket
) {
1490 redisLog(REDIS_NOTICE
,"Removing the unix socket file.");
1491 unlink(server
.unixsocket
); /* don't care if this fails */
1494 redisLog(REDIS_WARNING
,"Redis is now ready to exit, bye bye...");
1498 /*================================== Commands =============================== */
1500 void authCommand(redisClient
*c
) {
1501 if (!server
.requirepass
) {
1502 addReplyError(c
,"Client sent AUTH, but no password is set");
1503 } else if (!strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
1504 c
->authenticated
= 1;
1505 addReply(c
,shared
.ok
);
1507 c
->authenticated
= 0;
1508 addReplyError(c
,"invalid password");
1512 void pingCommand(redisClient
*c
) {
1513 addReply(c
,shared
.pong
);
1516 void echoCommand(redisClient
*c
) {
1517 addReplyBulk(c
,c
->argv
[1]);
1520 void timeCommand(redisClient
*c
) {
1523 /* gettimeofday() can only fail if &tv is a bad addresss so we
1524 * don't check for errors. */
1525 gettimeofday(&tv
,NULL
);
1526 addReplyMultiBulkLen(c
,2);
1527 addReplyBulkLongLong(c
,tv
.tv_sec
);
1528 addReplyBulkLongLong(c
,tv
.tv_usec
);
1531 /* Convert an amount of bytes into a human readable string in the form
1532 * of 100B, 2G, 100M, 4K, and so forth. */
1533 void bytesToHuman(char *s
, unsigned long long n
) {
1538 sprintf(s
,"%lluB",n
);
1540 } else if (n
< (1024*1024)) {
1541 d
= (double)n
/(1024);
1542 sprintf(s
,"%.2fK",d
);
1543 } else if (n
< (1024LL*1024*1024)) {
1544 d
= (double)n
/(1024*1024);
1545 sprintf(s
,"%.2fM",d
);
1546 } else if (n
< (1024LL*1024*1024*1024)) {
1547 d
= (double)n
/(1024LL*1024*1024);
1548 sprintf(s
,"%.2fG",d
);
1552 /* Create the string returned by the INFO command. This is decoupled
1553 * by the INFO command itself as we need to report the same information
1554 * on memory corruption problems. */
1555 sds
genRedisInfoString(char *section
) {
1556 sds info
= sdsempty();
1557 time_t uptime
= time(NULL
)-server
.stat_starttime
;
1559 struct rusage self_ru
, c_ru
;
1560 unsigned long lol
, bib
;
1561 int allsections
= 0, defsections
= 0;
1565 allsections
= strcasecmp(section
,"all") == 0;
1566 defsections
= strcasecmp(section
,"default") == 0;
1569 getrusage(RUSAGE_SELF
, &self_ru
);
1570 getrusage(RUSAGE_CHILDREN
, &c_ru
);
1571 getClientsMaxBuffers(&lol
,&bib
);
1574 if (allsections
|| defsections
|| !strcasecmp(section
,"server")) {
1575 if (sections
++) info
= sdscat(info
,"\r\n");
1576 info
= sdscatprintf(info
,
1578 "redis_version:%s\r\n"
1579 "redis_git_sha1:%s\r\n"
1580 "redis_git_dirty:%d\r\n"
1582 "multiplexing_api:%s\r\n"
1583 "gcc_version:%d.%d.%d\r\n"
1584 "process_id:%ld\r\n"
1586 "uptime_in_seconds:%ld\r\n"
1587 "uptime_in_days:%ld\r\n"
1588 "lru_clock:%ld\r\n",
1591 strtol(redisGitDirty(),NULL
,10) > 0,
1595 __GNUC__
,__GNUC_MINOR__
,__GNUC_PATCHLEVEL__
,
1603 (unsigned long) server
.lruclock
);
1607 if (allsections
|| defsections
|| !strcasecmp(section
,"clients")) {
1608 if (sections
++) info
= sdscat(info
,"\r\n");
1609 info
= sdscatprintf(info
,
1611 "connected_clients:%lu\r\n"
1612 "client_longest_output_list:%lu\r\n"
1613 "client_biggest_input_buf:%lu\r\n"
1614 "blocked_clients:%d\r\n",
1615 listLength(server
.clients
)-listLength(server
.slaves
),
1617 server
.bpop_blocked_clients
);
1621 if (allsections
|| defsections
|| !strcasecmp(section
,"memory")) {
1625 bytesToHuman(hmem
,zmalloc_used_memory());
1626 bytesToHuman(peak_hmem
,server
.stat_peak_memory
);
1627 if (sections
++) info
= sdscat(info
,"\r\n");
1628 info
= sdscatprintf(info
,
1630 "used_memory:%zu\r\n"
1631 "used_memory_human:%s\r\n"
1632 "used_memory_rss:%zu\r\n"
1633 "used_memory_peak:%zu\r\n"
1634 "used_memory_peak_human:%s\r\n"
1635 "used_memory_lua:%lld\r\n"
1636 "mem_fragmentation_ratio:%.2f\r\n"
1637 "mem_allocator:%s\r\n",
1638 zmalloc_used_memory(),
1641 server
.stat_peak_memory
,
1643 ((long long)lua_gc(server
.lua
,LUA_GCCOUNT
,0))*1024LL,
1644 zmalloc_get_fragmentation_ratio(),
1650 if (allsections
|| defsections
|| !strcasecmp(section
,"persistence")) {
1651 if (sections
++) info
= sdscat(info
,"\r\n");
1652 info
= sdscatprintf(info
,
1655 "aof_enabled:%d\r\n"
1656 "changes_since_last_save:%lld\r\n"
1657 "bgsave_in_progress:%d\r\n"
1658 "last_save_time:%ld\r\n"
1659 "last_bgsave_status:%s\r\n"
1660 "bgrewriteaof_in_progress:%d\r\n",
1662 server
.aof_state
!= REDIS_AOF_OFF
,
1664 server
.rdb_child_pid
!= -1,
1666 server
.lastbgsave_status
== REDIS_OK
? "ok" : "err",
1667 server
.aof_child_pid
!= -1);
1669 if (server
.aof_state
!= REDIS_AOF_OFF
) {
1670 info
= sdscatprintf(info
,
1671 "aof_current_size:%lld\r\n"
1672 "aof_base_size:%lld\r\n"
1673 "aof_pending_rewrite:%d\r\n"
1674 "aof_buffer_length:%zu\r\n"
1675 "aof_pending_bio_fsync:%llu\r\n",
1676 (long long) server
.aof_current_size
,
1677 (long long) server
.aof_rewrite_base_size
,
1678 server
.aof_rewrite_scheduled
,
1679 sdslen(server
.aof_buf
),
1680 bioPendingJobsOfType(REDIS_BIO_AOF_FSYNC
));
1683 if (server
.loading
) {
1685 time_t eta
, elapsed
;
1686 off_t remaining_bytes
= server
.loading_total_bytes
-
1687 server
.loading_loaded_bytes
;
1689 perc
= ((double)server
.loading_loaded_bytes
/
1690 server
.loading_total_bytes
) * 100;
1692 elapsed
= time(NULL
)-server
.loading_start_time
;
1694 eta
= 1; /* A fake 1 second figure if we don't have
1697 eta
= (elapsed
*remaining_bytes
)/server
.loading_loaded_bytes
;
1700 info
= sdscatprintf(info
,
1701 "loading_start_time:%ld\r\n"
1702 "loading_total_bytes:%llu\r\n"
1703 "loading_loaded_bytes:%llu\r\n"
1704 "loading_loaded_perc:%.2f\r\n"
1705 "loading_eta_seconds:%ld\r\n"
1706 ,(unsigned long) server
.loading_start_time
,
1707 (unsigned long long) server
.loading_total_bytes
,
1708 (unsigned long long) server
.loading_loaded_bytes
,
1716 if (allsections
|| defsections
|| !strcasecmp(section
,"stats")) {
1717 if (sections
++) info
= sdscat(info
,"\r\n");
1718 info
= sdscatprintf(info
,
1720 "total_connections_received:%lld\r\n"
1721 "total_commands_processed:%lld\r\n"
1722 "rejected_connections:%lld\r\n"
1723 "expired_keys:%lld\r\n"
1724 "evicted_keys:%lld\r\n"
1725 "keyspace_hits:%lld\r\n"
1726 "keyspace_misses:%lld\r\n"
1727 "pubsub_channels:%ld\r\n"
1728 "pubsub_patterns:%lu\r\n"
1729 "latest_fork_usec:%lld\r\n",
1730 server
.stat_numconnections
,
1731 server
.stat_numcommands
,
1732 server
.stat_rejected_conn
,
1733 server
.stat_expiredkeys
,
1734 server
.stat_evictedkeys
,
1735 server
.stat_keyspace_hits
,
1736 server
.stat_keyspace_misses
,
1737 dictSize(server
.pubsub_channels
),
1738 listLength(server
.pubsub_patterns
),
1739 server
.stat_fork_time
);
1743 if (allsections
|| defsections
|| !strcasecmp(section
,"replication")) {
1744 if (sections
++) info
= sdscat(info
,"\r\n");
1745 info
= sdscatprintf(info
,
1748 server
.masterhost
== NULL
? "master" : "slave");
1749 if (server
.masterhost
) {
1750 info
= sdscatprintf(info
,
1751 "master_host:%s\r\n"
1752 "master_port:%d\r\n"
1753 "master_link_status:%s\r\n"
1754 "master_last_io_seconds_ago:%d\r\n"
1755 "master_sync_in_progress:%d\r\n"
1758 (server
.repl_state
== REDIS_REPL_CONNECTED
) ?
1761 ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1,
1762 server
.repl_state
== REDIS_REPL_TRANSFER
1765 if (server
.repl_state
== REDIS_REPL_TRANSFER
) {
1766 info
= sdscatprintf(info
,
1767 "master_sync_left_bytes:%ld\r\n"
1768 "master_sync_last_io_seconds_ago:%d\r\n"
1769 ,(long)server
.repl_transfer_left
,
1770 (int)(time(NULL
)-server
.repl_transfer_lastio
)
1774 if (server
.repl_state
!= REDIS_REPL_CONNECTED
) {
1775 info
= sdscatprintf(info
,
1776 "master_link_down_since_seconds:%ld\r\n",
1777 (long)time(NULL
)-server
.repl_down_since
);
1780 info
= sdscatprintf(info
,
1781 "connected_slaves:%lu\r\n",
1782 listLength(server
.slaves
));
1783 if (listLength(server
.slaves
)) {
1788 listRewind(server
.slaves
,&li
);
1789 while((ln
= listNext(&li
))) {
1790 redisClient
*slave
= listNodeValue(ln
);
1795 if (anetPeerToString(slave
->fd
,ip
,&port
) == -1) continue;
1796 switch(slave
->replstate
) {
1797 case REDIS_REPL_WAIT_BGSAVE_START
:
1798 case REDIS_REPL_WAIT_BGSAVE_END
:
1799 state
= "wait_bgsave";
1801 case REDIS_REPL_SEND_BULK
:
1802 state
= "send_bulk";
1804 case REDIS_REPL_ONLINE
:
1808 if (state
== NULL
) continue;
1809 info
= sdscatprintf(info
,"slave%d:%s,%d,%s\r\n",
1810 slaveid
,ip
,port
,state
);
1817 if (allsections
|| defsections
|| !strcasecmp(section
,"cpu")) {
1818 if (sections
++) info
= sdscat(info
,"\r\n");
1819 info
= sdscatprintf(info
,
1821 "used_cpu_sys:%.2f\r\n"
1822 "used_cpu_user:%.2f\r\n"
1823 "used_cpu_sys_children:%.2f\r\n"
1824 "used_cpu_user_children:%.2f\r\n",
1825 (float)self_ru
.ru_stime
.tv_sec
+(float)self_ru
.ru_stime
.tv_usec
/1000000,
1826 (float)self_ru
.ru_utime
.tv_sec
+(float)self_ru
.ru_utime
.tv_usec
/1000000,
1827 (float)c_ru
.ru_stime
.tv_sec
+(float)c_ru
.ru_stime
.tv_usec
/1000000,
1828 (float)c_ru
.ru_utime
.tv_sec
+(float)c_ru
.ru_utime
.tv_usec
/1000000);
1832 if (allsections
|| !strcasecmp(section
,"commandstats")) {
1833 if (sections
++) info
= sdscat(info
,"\r\n");
1834 info
= sdscatprintf(info
, "# Commandstats\r\n");
1835 numcommands
= sizeof(redisCommandTable
)/sizeof(struct redisCommand
);
1836 for (j
= 0; j
< numcommands
; j
++) {
1837 struct redisCommand
*c
= redisCommandTable
+j
;
1839 if (!c
->calls
) continue;
1840 info
= sdscatprintf(info
,
1841 "cmdstat_%s:calls=%lld,usec=%lld,usec_per_call=%.2f\r\n",
1842 c
->name
, c
->calls
, c
->microseconds
,
1843 (c
->calls
== 0) ? 0 : ((float)c
->microseconds
/c
->calls
));
1848 if (allsections
|| defsections
|| !strcasecmp(section
,"cluster")) {
1849 if (sections
++) info
= sdscat(info
,"\r\n");
1850 info
= sdscatprintf(info
,
1852 "cluster_enabled:%d\r\n",
1853 server
.cluster_enabled
);
1857 if (allsections
|| defsections
|| !strcasecmp(section
,"keyspace")) {
1858 if (sections
++) info
= sdscat(info
,"\r\n");
1859 info
= sdscatprintf(info
, "# Keyspace\r\n");
1860 for (j
= 0; j
< server
.dbnum
; j
++) {
1861 long long keys
, vkeys
;
1863 keys
= dictSize(server
.db
[j
].dict
);
1864 vkeys
= dictSize(server
.db
[j
].expires
);
1865 if (keys
|| vkeys
) {
1866 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
1874 void infoCommand(redisClient
*c
) {
1875 char *section
= c
->argc
== 2 ? c
->argv
[1]->ptr
: "default";
1878 addReply(c
,shared
.syntaxerr
);
1881 sds info
= genRedisInfoString(section
);
1882 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
1883 (unsigned long)sdslen(info
)));
1884 addReplySds(c
,info
);
1885 addReply(c
,shared
.crlf
);
1888 void monitorCommand(redisClient
*c
) {
1889 /* ignore MONITOR if aleady slave or in monitor mode */
1890 if (c
->flags
& REDIS_SLAVE
) return;
1892 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
1894 listAddNodeTail(server
.monitors
,c
);
1895 addReply(c
,shared
.ok
);
1898 /* ============================ Maxmemory directive ======================== */
1900 /* This function gets called when 'maxmemory' is set on the config file to limit
1901 * the max memory used by the server, before processing a command.
1903 * The goal of the function is to free enough memory to keep Redis under the
1904 * configured memory limit.
1906 * The function starts calculating how many bytes should be freed to keep
1907 * Redis under the limit, and enters a loop selecting the best keys to
1908 * evict accordingly to the configured policy.
1910 * If all the bytes needed to return back under the limit were freed the
1911 * function returns REDIS_OK, otherwise REDIS_ERR is returned, and the caller
1912 * should block the execution of commands that will result in more memory
1913 * used by the server.
1915 int freeMemoryIfNeeded(void) {
1916 size_t mem_used
, mem_tofree
, mem_freed
;
1917 int slaves
= listLength(server
.slaves
);
1919 /* Remove the size of slaves output buffers and AOF buffer from the
1920 * count of used memory. */
1921 mem_used
= zmalloc_used_memory();
1926 listRewind(server
.slaves
,&li
);
1927 while((ln
= listNext(&li
))) {
1928 redisClient
*slave
= listNodeValue(ln
);
1929 unsigned long obuf_bytes
= getClientOutputBufferMemoryUsage(slave
);
1930 if (obuf_bytes
> mem_used
)
1933 mem_used
-= obuf_bytes
;
1936 if (server
.aof_state
!= REDIS_AOF_OFF
) {
1937 mem_used
-= sdslen(server
.aof_buf
);
1938 mem_used
-= sdslen(server
.aof_rewrite_buf
);
1941 /* Check if we are over the memory limit. */
1942 if (mem_used
<= server
.maxmemory
) return REDIS_OK
;
1944 if (server
.maxmemory_policy
== REDIS_MAXMEMORY_NO_EVICTION
)
1945 return REDIS_ERR
; /* We need to free memory, but policy forbids. */
1947 /* Compute how much memory we need to free. */
1948 mem_tofree
= mem_used
- server
.maxmemory
;
1950 while (mem_freed
< mem_tofree
) {
1951 int j
, k
, keys_freed
= 0;
1953 for (j
= 0; j
< server
.dbnum
; j
++) {
1954 long bestval
= 0; /* just to prevent warning */
1956 struct dictEntry
*de
;
1957 redisDb
*db
= server
.db
+j
;
1960 if (server
.maxmemory_policy
== REDIS_MAXMEMORY_ALLKEYS_LRU
||
1961 server
.maxmemory_policy
== REDIS_MAXMEMORY_ALLKEYS_RANDOM
)
1963 dict
= server
.db
[j
].dict
;
1965 dict
= server
.db
[j
].expires
;
1967 if (dictSize(dict
) == 0) continue;
1969 /* volatile-random and allkeys-random policy */
1970 if (server
.maxmemory_policy
== REDIS_MAXMEMORY_ALLKEYS_RANDOM
||
1971 server
.maxmemory_policy
== REDIS_MAXMEMORY_VOLATILE_RANDOM
)
1973 de
= dictGetRandomKey(dict
);
1974 bestkey
= dictGetKey(de
);
1977 /* volatile-lru and allkeys-lru policy */
1978 else if (server
.maxmemory_policy
== REDIS_MAXMEMORY_ALLKEYS_LRU
||
1979 server
.maxmemory_policy
== REDIS_MAXMEMORY_VOLATILE_LRU
)
1981 for (k
= 0; k
< server
.maxmemory_samples
; k
++) {
1986 de
= dictGetRandomKey(dict
);
1987 thiskey
= dictGetKey(de
);
1988 /* When policy is volatile-lru we need an additonal lookup
1989 * to locate the real key, as dict is set to db->expires. */
1990 if (server
.maxmemory_policy
== REDIS_MAXMEMORY_VOLATILE_LRU
)
1991 de
= dictFind(db
->dict
, thiskey
);
1993 thisval
= estimateObjectIdleTime(o
);
1995 /* Higher idle time is better candidate for deletion */
1996 if (bestkey
== NULL
|| thisval
> bestval
) {
2004 else if (server
.maxmemory_policy
== REDIS_MAXMEMORY_VOLATILE_TTL
) {
2005 for (k
= 0; k
< server
.maxmemory_samples
; k
++) {
2009 de
= dictGetRandomKey(dict
);
2010 thiskey
= dictGetKey(de
);
2011 thisval
= (long) dictGetVal(de
);
2013 /* Expire sooner (minor expire unix timestamp) is better
2014 * candidate for deletion */
2015 if (bestkey
== NULL
|| thisval
< bestval
) {
2022 /* Finally remove the selected key. */
2026 robj
*keyobj
= createStringObject(bestkey
,sdslen(bestkey
));
2027 propagateExpire(db
,keyobj
);
2028 /* We compute the amount of memory freed by dbDelete() alone.
2029 * It is possible that actually the memory needed to propagate
2030 * the DEL in AOF and replication link is greater than the one
2031 * we are freeing removing the key, but we can't account for
2032 * that otherwise we would never exit the loop.
2034 * AOF and Output buffer memory will be freed eventually so
2035 * we only care about memory used by the key space. */
2036 delta
= (long long) zmalloc_used_memory();
2037 dbDelete(db
,keyobj
);
2038 delta
-= (long long) zmalloc_used_memory();
2040 server
.stat_evictedkeys
++;
2041 decrRefCount(keyobj
);
2044 /* When the memory to free starts to be big enough, we may
2045 * start spending so much time here that is impossible to
2046 * deliver data to the slaves fast enough, so we force the
2047 * transmission here inside the loop. */
2048 if (slaves
) flushSlavesOutputBuffers();
2051 if (!keys_freed
) return REDIS_ERR
; /* nothing to free... */
2056 /* =================================== Main! ================================ */
2059 int linuxOvercommitMemoryValue(void) {
2060 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
2064 if (fgets(buf
,64,fp
) == NULL
) {
2073 void linuxOvercommitMemoryWarning(void) {
2074 if (linuxOvercommitMemoryValue() == 0) {
2075 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.");
2078 #endif /* __linux__ */
2080 void createPidFile(void) {
2081 /* Try to write the pid file in a best-effort way. */
2082 FILE *fp
= fopen(server
.pidfile
,"w");
2084 fprintf(fp
,"%d\n",(int)getpid());
2089 void daemonize(void) {
2092 if (fork() != 0) exit(0); /* parent exits */
2093 setsid(); /* create a new session */
2095 /* Every output goes to /dev/null. If Redis is daemonized but
2096 * the 'logfile' is set to 'stdout' in the configuration file
2097 * it will not log at all. */
2098 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
2099 dup2(fd
, STDIN_FILENO
);
2100 dup2(fd
, STDOUT_FILENO
);
2101 dup2(fd
, STDERR_FILENO
);
2102 if (fd
> STDERR_FILENO
) close(fd
);
2107 printf("Redis server version %s (%s:%d)\n", REDIS_VERSION
,
2108 redisGitSHA1(), atoi(redisGitDirty()) > 0);
2113 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf] [options]\n");
2114 fprintf(stderr
," ./redis-server - (read config from stdin)\n");
2115 fprintf(stderr
," ./redis-server -v or --version\n");
2116 fprintf(stderr
," ./redis-server -h or --help\n\n");
2117 fprintf(stderr
,"Examples:\n");
2118 fprintf(stderr
," ./redis-server (run the server with default conf)\n");
2119 fprintf(stderr
," ./redis-server /etc/redis/6379.conf\n");
2120 fprintf(stderr
," ./redis-server --port 7777\n");
2121 fprintf(stderr
," ./redis-server --port 7777 --slaveof 127.0.0.1 8888\n");
2122 fprintf(stderr
," ./redis-server /etc/myredis.conf --loglevel verbose\n");
2126 void redisAsciiArt(void) {
2127 #include "asciilogo.h"
2128 char *buf
= zmalloc(1024*16);
2130 snprintf(buf
,1024*16,ascii_logo
,
2133 strtol(redisGitDirty(),NULL
,10) > 0,
2134 (sizeof(long) == 8) ? "64" : "32",
2135 server
.cluster_enabled
? "cluster" : "stand alone",
2139 redisLogRaw(REDIS_NOTICE
|REDIS_LOG_RAW
,buf
);
2143 static void sigtermHandler(int sig
) {
2146 redisLog(REDIS_WARNING
,"Received SIGTERM, scheduling shutdown...");
2147 server
.shutdown_asap
= 1;
2150 void setupSignalHandlers(void) {
2151 struct sigaction act
;
2153 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction is used.
2154 * Otherwise, sa_handler is used. */
2155 sigemptyset(&act
.sa_mask
);
2156 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
;
2157 act
.sa_handler
= sigtermHandler
;
2158 sigaction(SIGTERM
, &act
, NULL
);
2160 #ifdef HAVE_BACKTRACE
2161 sigemptyset(&act
.sa_mask
);
2162 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
2163 act
.sa_sigaction
= sigsegvHandler
;
2164 sigaction(SIGSEGV
, &act
, NULL
);
2165 sigaction(SIGBUS
, &act
, NULL
);
2166 sigaction(SIGFPE
, &act
, NULL
);
2167 sigaction(SIGILL
, &act
, NULL
);
2172 int main(int argc
, char **argv
) {
2176 /* We need to initialize our libraries, and the server configuration. */
2177 zmalloc_enable_thread_safeness();
2178 srand(time(NULL
)^getpid());
2179 gettimeofday(&tv
,NULL
);
2180 dictSetHashFunctionSeed(tv
.tv_sec
^tv
.tv_usec
^getpid());
2184 int j
= 1; /* First option to parse in argv[] */
2185 sds options
= sdsempty();
2186 char *configfile
= NULL
;
2188 /* Handle special options --help and --version */
2189 if (strcmp(argv
[1], "-v") == 0 ||
2190 strcmp(argv
[1], "--version") == 0) version();
2191 if (strcmp(argv
[1], "--help") == 0 ||
2192 strcmp(argv
[1], "-h") == 0) usage();
2193 /* First argument is the config file name? */
2194 if (argv
[j
][0] != '-' || argv
[j
][1] != '-')
2195 configfile
= argv
[j
++];
2196 /* All the other options are parsed and conceptually appended to the
2197 * configuration file. For instance --port 6380 will generate the
2198 * string "port 6380\n" to be parsed after the actual file name
2199 * is parsed, if any. */
2201 if (argv
[j
][0] == '-' && argv
[j
][1] == '-') {
2203 if (sdslen(options
)) options
= sdscat(options
,"\n");
2204 options
= sdscat(options
,argv
[j
]+2);
2205 options
= sdscat(options
," ");
2207 /* Option argument */
2208 options
= sdscatrepr(options
,argv
[j
],strlen(argv
[j
]));
2209 options
= sdscat(options
," ");
2213 resetServerSaveParams();
2214 loadServerConfig(configfile
,options
);
2217 redisLog(REDIS_WARNING
,"Warning: no config file specified, using the default config. In order to specify a config file use 'redis-server /path/to/redis.conf'");
2219 if (server
.daemonize
) daemonize();
2221 if (server
.daemonize
) createPidFile();
2223 redisLog(REDIS_WARNING
,"Server started, Redis version " REDIS_VERSION
);
2225 linuxOvercommitMemoryWarning();
2228 if (server
.aof_state
== REDIS_AOF_ON
) {
2229 if (loadAppendOnlyFile(server
.aof_filename
) == REDIS_OK
)
2230 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %.3f seconds",(float)(ustime()-start
)/1000000);
2232 if (rdbLoad(server
.rdb_filename
) == REDIS_OK
) {
2233 redisLog(REDIS_NOTICE
,"DB loaded from disk: %.3f seconds",
2234 (float)(ustime()-start
)/1000000);
2235 } else if (errno
!= ENOENT
) {
2236 redisLog(REDIS_WARNING
,"Fatal error loading the DB. Exiting.");
2240 if (server
.ipfd
> 0)
2241 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
2242 if (server
.sofd
> 0)
2243 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections at %s", server
.unixsocket
);
2244 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
2246 aeDeleteEventLoop(server
.el
);