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 {"restore",restoreCommand
,4,"awm",0,NULL
,1,1,1,0,0},
236 {"migrate",migrateCommand
,6,"aw",0,NULL
,0,0,0,0,0},
237 {"dump",dumpCommand
,2,"ar",0,NULL
,1,1,1,0,0},
238 {"object",objectCommand
,-2,"r",0,NULL
,2,2,2,0,0},
239 {"client",clientCommand
,-2,"ar",0,NULL
,0,0,0,0,0},
240 {"eval",evalCommand
,-3,"wms",0,zunionInterGetKeys
,0,0,0,0,0},
241 {"evalsha",evalShaCommand
,-3,"wms",0,zunionInterGetKeys
,0,0,0,0,0},
242 {"slowlog",slowlogCommand
,-2,"r",0,NULL
,0,0,0,0,0},
243 {"script",scriptCommand
,-2,"ras",0,NULL
,0,0,0,0,0},
244 {"time",timeCommand
,1,"rR",0,NULL
,0,0,0,0,0}
247 /*============================ Utility functions ============================ */
249 /* Low level logging. To use only for very big messages, otherwise
250 * redisLog() is to prefer. */
251 void redisLogRaw(int level
, const char *msg
) {
252 const int syslogLevelMap
[] = { LOG_DEBUG
, LOG_INFO
, LOG_NOTICE
, LOG_WARNING
};
253 const char *c
= ".-*#";
254 time_t now
= time(NULL
);
257 int rawmode
= (level
& REDIS_LOG_RAW
);
259 level
&= 0xff; /* clear flags */
260 if (level
< server
.verbosity
) return;
262 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
266 fprintf(fp
,"%s",msg
);
268 strftime(buf
,sizeof(buf
),"%d %b %H:%M:%S",localtime(&now
));
269 fprintf(fp
,"[%d] %s %c %s\n",(int)getpid(),buf
,c
[level
],msg
);
273 if (server
.logfile
) fclose(fp
);
275 if (server
.syslog_enabled
) syslog(syslogLevelMap
[level
], "%s", msg
);
278 /* Like redisLogRaw() but with printf-alike support. This is the funciton that
279 * is used across the code. The raw version is only used in order to dump
280 * the INFO output on crash. */
281 void redisLog(int level
, const char *fmt
, ...) {
283 char msg
[REDIS_MAX_LOGMSG_LEN
];
285 if ((level
&0xff) < server
.verbosity
) return;
288 vsnprintf(msg
, sizeof(msg
), fmt
, ap
);
291 redisLogRaw(level
,msg
);
294 /* Redis generally does not try to recover from out of memory conditions
295 * when allocating objects or strings, it is not clear if it will be possible
296 * to report this condition to the client since the networking layer itself
297 * is based on heap allocation for send buffers, so we simply abort.
298 * At least the code will be simpler to read... */
299 void oom(const char *msg
) {
300 redisLog(REDIS_WARNING
, "%s: Out of memory\n",msg
);
305 /* Return the UNIX time in microseconds */
306 long long ustime(void) {
310 gettimeofday(&tv
, NULL
);
311 ust
= ((long long)tv
.tv_sec
)*1000000;
316 /* Return the UNIX time in milliseconds */
317 long long mstime(void) {
318 return ustime()/1000;
321 /*====================== Hash table type implementation ==================== */
323 /* This is an hash table type that uses the SDS dynamic strings libary as
324 * keys and radis objects as values (objects can hold SDS strings,
327 void dictVanillaFree(void *privdata
, void *val
)
329 DICT_NOTUSED(privdata
);
333 void dictListDestructor(void *privdata
, void *val
)
335 DICT_NOTUSED(privdata
);
336 listRelease((list
*)val
);
339 int dictSdsKeyCompare(void *privdata
, const void *key1
,
343 DICT_NOTUSED(privdata
);
345 l1
= sdslen((sds
)key1
);
346 l2
= sdslen((sds
)key2
);
347 if (l1
!= l2
) return 0;
348 return memcmp(key1
, key2
, l1
) == 0;
351 /* A case insensitive version used for the command lookup table. */
352 int dictSdsKeyCaseCompare(void *privdata
, const void *key1
,
355 DICT_NOTUSED(privdata
);
357 return strcasecmp(key1
, key2
) == 0;
360 void dictRedisObjectDestructor(void *privdata
, void *val
)
362 DICT_NOTUSED(privdata
);
364 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
368 void dictSdsDestructor(void *privdata
, void *val
)
370 DICT_NOTUSED(privdata
);
375 int dictObjKeyCompare(void *privdata
, const void *key1
,
378 const robj
*o1
= key1
, *o2
= key2
;
379 return dictSdsKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
382 unsigned int dictObjHash(const void *key
) {
384 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
387 unsigned int dictSdsHash(const void *key
) {
388 return dictGenHashFunction((unsigned char*)key
, sdslen((char*)key
));
391 unsigned int dictSdsCaseHash(const void *key
) {
392 return dictGenCaseHashFunction((unsigned char*)key
, sdslen((char*)key
));
395 int dictEncObjKeyCompare(void *privdata
, const void *key1
,
398 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
401 if (o1
->encoding
== REDIS_ENCODING_INT
&&
402 o2
->encoding
== REDIS_ENCODING_INT
)
403 return o1
->ptr
== o2
->ptr
;
405 o1
= getDecodedObject(o1
);
406 o2
= getDecodedObject(o2
);
407 cmp
= dictSdsKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
413 unsigned int dictEncObjHash(const void *key
) {
414 robj
*o
= (robj
*) key
;
416 if (o
->encoding
== REDIS_ENCODING_RAW
) {
417 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
419 if (o
->encoding
== REDIS_ENCODING_INT
) {
423 len
= ll2string(buf
,32,(long)o
->ptr
);
424 return dictGenHashFunction((unsigned char*)buf
, len
);
428 o
= getDecodedObject(o
);
429 hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
436 /* Sets type hash table */
437 dictType setDictType
= {
438 dictEncObjHash
, /* hash function */
441 dictEncObjKeyCompare
, /* key compare */
442 dictRedisObjectDestructor
, /* key destructor */
443 NULL
/* val destructor */
446 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
447 dictType zsetDictType
= {
448 dictEncObjHash
, /* hash function */
451 dictEncObjKeyCompare
, /* key compare */
452 dictRedisObjectDestructor
, /* key destructor */
453 NULL
/* val destructor */
456 /* Db->dict, keys are sds strings, vals are Redis objects. */
457 dictType dbDictType
= {
458 dictSdsHash
, /* hash function */
461 dictSdsKeyCompare
, /* key compare */
462 dictSdsDestructor
, /* key destructor */
463 dictRedisObjectDestructor
/* val destructor */
467 dictType keyptrDictType
= {
468 dictSdsHash
, /* hash function */
471 dictSdsKeyCompare
, /* key compare */
472 NULL
, /* key destructor */
473 NULL
/* val destructor */
476 /* Command table. sds string -> command struct pointer. */
477 dictType commandTableDictType
= {
478 dictSdsCaseHash
, /* hash function */
481 dictSdsKeyCaseCompare
, /* key compare */
482 dictSdsDestructor
, /* key destructor */
483 NULL
/* val destructor */
486 /* Hash type hash table (note that small hashes are represented with zimpaps) */
487 dictType hashDictType
= {
488 dictEncObjHash
, /* hash function */
491 dictEncObjKeyCompare
, /* key compare */
492 dictRedisObjectDestructor
, /* key destructor */
493 dictRedisObjectDestructor
/* val destructor */
496 /* Keylist hash table type has unencoded redis objects as keys and
497 * lists as values. It's used for blocking operations (BLPOP) and to
498 * map swapped keys to a list of clients waiting for this keys to be loaded. */
499 dictType keylistDictType
= {
500 dictObjHash
, /* hash function */
503 dictObjKeyCompare
, /* key compare */
504 dictRedisObjectDestructor
, /* key destructor */
505 dictListDestructor
/* val destructor */
508 int htNeedsResize(dict
*dict
) {
509 long long size
, used
;
511 size
= dictSlots(dict
);
512 used
= dictSize(dict
);
513 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
514 (used
*100/size
< REDIS_HT_MINFILL
));
517 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
518 * we resize the hash table to save memory */
519 void tryResizeHashTables(void) {
522 for (j
= 0; j
< server
.dbnum
; j
++) {
523 if (htNeedsResize(server
.db
[j
].dict
))
524 dictResize(server
.db
[j
].dict
);
525 if (htNeedsResize(server
.db
[j
].expires
))
526 dictResize(server
.db
[j
].expires
);
530 /* Our hash table implementation performs rehashing incrementally while
531 * we write/read from the hash table. Still if the server is idle, the hash
532 * table will use two tables for a long time. So we try to use 1 millisecond
533 * of CPU time at every serverCron() loop in order to rehash some key. */
534 void incrementallyRehash(void) {
537 for (j
= 0; j
< server
.dbnum
; j
++) {
538 if (dictIsRehashing(server
.db
[j
].dict
)) {
539 dictRehashMilliseconds(server
.db
[j
].dict
,1);
540 break; /* already used our millisecond for this loop... */
545 /* This function is called once a background process of some kind terminates,
546 * as we want to avoid resizing the hash tables when there is a child in order
547 * to play well with copy-on-write (otherwise when a resize happens lots of
548 * memory pages are copied). The goal of this function is to update the ability
549 * for dict.c to resize the hash tables accordingly to the fact we have o not
551 void updateDictResizePolicy(void) {
552 if (server
.rdb_child_pid
== -1 && server
.aof_child_pid
== -1)
558 /* ======================= Cron: called every 100 ms ======================== */
560 /* Try to expire a few timed out keys. The algorithm used is adaptive and
561 * will use few CPU cycles if there are few expiring keys, otherwise
562 * it will get more aggressive to avoid that too much memory is used by
563 * keys that can be removed from the keyspace. */
564 void activeExpireCycle(void) {
567 for (j
= 0; j
< server
.dbnum
; j
++) {
569 redisDb
*db
= server
.db
+j
;
571 /* Continue to expire if at the end of the cycle more than 25%
572 * of the keys were expired. */
574 long num
= dictSize(db
->expires
);
575 long long now
= mstime();
578 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
579 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
584 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
585 t
= dictGetSignedIntegerVal(de
);
587 sds key
= dictGetKey(de
);
588 robj
*keyobj
= createStringObject(key
,sdslen(key
));
590 propagateExpire(db
,keyobj
);
592 decrRefCount(keyobj
);
594 server
.stat_expiredkeys
++;
597 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
601 void updateLRUClock(void) {
602 server
.lruclock
= (time(NULL
)/REDIS_LRU_CLOCK_RESOLUTION
) &
607 /* Add a sample to the operations per second array of samples. */
608 void trackOperationsPerSecond(void) {
609 long long t
= mstime() - server
.ops_sec_last_sample_time
;
610 long long ops
= server
.stat_numcommands
- server
.ops_sec_last_sample_ops
;
613 ops_sec
= t
> 0 ? (ops
*1000/t
) : 0;
615 server
.ops_sec_samples
[server
.ops_sec_idx
] = ops_sec
;
616 server
.ops_sec_idx
= (server
.ops_sec_idx
+1) % REDIS_OPS_SEC_SAMPLES
;
617 server
.ops_sec_last_sample_time
= mstime();
618 server
.ops_sec_last_sample_ops
= server
.stat_numcommands
;
621 /* Return the mean of all the samples. */
622 long long getOperationsPerSecond(void) {
626 for (j
= 0; j
< REDIS_OPS_SEC_SAMPLES
; j
++)
627 sum
+= server
.ops_sec_samples
[j
];
628 return sum
/ REDIS_OPS_SEC_SAMPLES
;
631 void closeTimedoutClient(redisClient
*c
) {
632 time_t now
= time(NULL
);
634 if (server
.maxidletime
&&
635 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
636 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
637 !(c
->flags
& REDIS_BLOCKED
) && /* no timeout for BLPOP */
638 dictSize(c
->pubsub_channels
) == 0 && /* no timeout for pubsub */
639 listLength(c
->pubsub_patterns
) == 0 &&
640 (now
- c
->lastinteraction
> server
.maxidletime
))
642 redisLog(REDIS_VERBOSE
,"Closing idle client");
644 } else if (c
->flags
& REDIS_BLOCKED
) {
645 if (c
->bpop
.timeout
!= 0 && c
->bpop
.timeout
< now
) {
646 addReply(c
,shared
.nullmultibulk
);
647 unblockClientWaitingData(c
);
652 void clientsCron(void) {
653 /* Make sure to process at least 1/100 of clients per call.
654 * Since this function is called 10 times per second we are sure that
655 * in the worst case we process all the clients in 10 seconds.
656 * In normal conditions (a reasonable number of clients) we process
657 * all the clients in a shorter time. */
658 int iterations
= listLength(server
.clients
)/100;
659 if (iterations
< 50) iterations
= 50;
661 while(listLength(server
.clients
) && iterations
--) {
665 /* Rotate the list, take the current head, process.
666 * This way if the client must be removed from the list it's the
667 * first element and we don't incur into O(N) computation. */
668 listRotate(server
.clients
);
669 head
= listFirst(server
.clients
);
670 c
= listNodeValue(head
);
671 closeTimedoutClient(c
);
675 int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
676 int j
, loops
= server
.cronloops
;
677 REDIS_NOTUSED(eventLoop
);
679 REDIS_NOTUSED(clientData
);
681 /* We take a cached value of the unix time in the global state because
682 * with virtual memory and aging there is to store the current time
683 * in objects at every object access, and accuracy is not needed.
684 * To access a global var is faster than calling time(NULL) */
685 server
.unixtime
= time(NULL
);
687 trackOperationsPerSecond();
689 /* We have just 22 bits per object for LRU information.
690 * So we use an (eventually wrapping) LRU clock with 10 seconds resolution.
691 * 2^22 bits with 10 seconds resoluton is more or less 1.5 years.
693 * Note that even if this will wrap after 1.5 years it's not a problem,
694 * everything will still work but just some object will appear younger
695 * to Redis. But for this to happen a given object should never be touched
698 * Note that you can change the resolution altering the
699 * REDIS_LRU_CLOCK_RESOLUTION define.
703 /* Record the max memory used since the server was started. */
704 if (zmalloc_used_memory() > server
.stat_peak_memory
)
705 server
.stat_peak_memory
= zmalloc_used_memory();
707 /* We received a SIGTERM, shutting down here in a safe way, as it is
708 * not ok doing so inside the signal handler. */
709 if (server
.shutdown_asap
) {
710 if (prepareForShutdown(0) == REDIS_OK
) exit(0);
711 redisLog(REDIS_WARNING
,"SIGTERM received but errors trying to shut down the server, check the logs for more information");
714 /* Show some info about non-empty databases */
715 for (j
= 0; j
< server
.dbnum
; j
++) {
716 long long size
, used
, vkeys
;
718 size
= dictSlots(server
.db
[j
].dict
);
719 used
= dictSize(server
.db
[j
].dict
);
720 vkeys
= dictSize(server
.db
[j
].expires
);
721 if (!(loops
% 50) && (used
|| vkeys
)) {
722 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
723 /* dictPrintStats(server.dict); */
727 /* We don't want to resize the hash tables while a bacground saving
728 * is in progress: the saving child is created using fork() that is
729 * implemented with a copy-on-write semantic in most modern systems, so
730 * if we resize the HT while there is the saving child at work actually
731 * a lot of memory movements in the parent will cause a lot of pages
733 if (server
.rdb_child_pid
== -1 && server
.aof_child_pid
== -1) {
734 if (!(loops
% 10)) tryResizeHashTables();
735 if (server
.activerehashing
) incrementallyRehash();
738 /* Show information about connected clients */
740 redisLog(REDIS_VERBOSE
,"%d clients connected (%d slaves), %zu bytes in use",
741 listLength(server
.clients
)-listLength(server
.slaves
),
742 listLength(server
.slaves
),
743 zmalloc_used_memory());
746 /* We need to do a few operations on clients asynchronously. */
749 /* Start a scheduled AOF rewrite if this was requested by the user while
750 * a BGSAVE was in progress. */
751 if (server
.rdb_child_pid
== -1 && server
.aof_child_pid
== -1 &&
752 server
.aof_rewrite_scheduled
)
754 rewriteAppendOnlyFileBackground();
757 /* Check if a background saving or AOF rewrite in progress terminated. */
758 if (server
.rdb_child_pid
!= -1 || server
.aof_child_pid
!= -1) {
762 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
763 int exitcode
= WEXITSTATUS(statloc
);
766 if (WIFSIGNALED(statloc
)) bysignal
= WTERMSIG(statloc
);
768 if (pid
== server
.rdb_child_pid
) {
769 backgroundSaveDoneHandler(exitcode
,bysignal
);
771 backgroundRewriteDoneHandler(exitcode
,bysignal
);
773 updateDictResizePolicy();
776 time_t now
= time(NULL
);
778 /* If there is not a background saving/rewrite in progress check if
779 * we have to save/rewrite now */
780 for (j
= 0; j
< server
.saveparamslen
; j
++) {
781 struct saveparam
*sp
= server
.saveparams
+j
;
783 if (server
.dirty
>= sp
->changes
&&
784 now
-server
.lastsave
> sp
->seconds
) {
785 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
786 sp
->changes
, sp
->seconds
);
787 rdbSaveBackground(server
.rdb_filename
);
792 /* Trigger an AOF rewrite if needed */
793 if (server
.rdb_child_pid
== -1 &&
794 server
.aof_child_pid
== -1 &&
795 server
.aof_rewrite_perc
&&
796 server
.aof_current_size
> server
.aof_rewrite_min_size
)
798 long long base
= server
.aof_rewrite_base_size
?
799 server
.aof_rewrite_base_size
: 1;
800 long long growth
= (server
.aof_current_size
*100/base
) - 100;
801 if (growth
>= server
.aof_rewrite_perc
) {
802 redisLog(REDIS_NOTICE
,"Starting automatic rewriting of AOF on %lld%% growth",growth
);
803 rewriteAppendOnlyFileBackground();
809 /* If we postponed an AOF buffer flush, let's try to do it every time the
810 * cron function is called. */
811 if (server
.aof_flush_postponed_start
) flushAppendOnlyFile(0);
813 /* Expire a few keys per cycle, only if this is a master.
814 * On slaves we wait for DEL operations synthesized by the master
815 * in order to guarantee a strict consistency. */
816 if (server
.masterhost
== NULL
) activeExpireCycle();
818 /* Close clients that need to be closed asynchronous */
819 freeClientsInAsyncFreeQueue();
821 /* Replication cron function -- used to reconnect to master and
822 * to detect transfer failures. */
823 if (!(loops
% 10)) replicationCron();
829 /* This function gets called every time Redis is entering the
830 * main loop of the event driven library, that is, before to sleep
831 * for ready file descriptors. */
832 void beforeSleep(struct aeEventLoop
*eventLoop
) {
833 REDIS_NOTUSED(eventLoop
);
837 /* Try to process pending commands for clients that were just unblocked. */
838 while (listLength(server
.unblocked_clients
)) {
839 ln
= listFirst(server
.unblocked_clients
);
840 redisAssert(ln
!= NULL
);
842 listDelNode(server
.unblocked_clients
,ln
);
843 c
->flags
&= ~REDIS_UNBLOCKED
;
845 /* Process remaining data in the input buffer. */
846 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) {
847 server
.current_client
= c
;
848 processInputBuffer(c
);
849 server
.current_client
= NULL
;
853 /* Write the AOF buffer on disk */
854 flushAppendOnlyFile(0);
857 /* =========================== Server initialization ======================== */
859 void createSharedObjects(void) {
862 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
863 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
864 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
865 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
866 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
867 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
868 shared
.cnegone
= createObject(REDIS_STRING
,sdsnew(":-1\r\n"));
869 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
870 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
871 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
872 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
873 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
874 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
875 "-ERR Operation against a key holding the wrong kind of value\r\n"));
876 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
877 "-ERR no such key\r\n"));
878 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
879 "-ERR syntax error\r\n"));
880 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
881 "-ERR source and destination objects are the same\r\n"));
882 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
883 "-ERR index out of range\r\n"));
884 shared
.noscripterr
= createObject(REDIS_STRING
,sdsnew(
885 "-NOSCRIPT No matching script. Please use EVAL.\r\n"));
886 shared
.loadingerr
= createObject(REDIS_STRING
,sdsnew(
887 "-LOADING Redis is loading the dataset in memory\r\n"));
888 shared
.slowscripterr
= createObject(REDIS_STRING
,sdsnew(
889 "-BUSY Redis is busy running a script. You can only call SCRIPT KILL or SHUTDOWN NOSAVE.\r\n"));
890 shared
.bgsaveerr
= createObject(REDIS_STRING
,sdsnew(
891 "-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"));
892 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
893 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
894 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
895 shared
.select0
= createStringObject("select 0\r\n",10);
896 shared
.select1
= createStringObject("select 1\r\n",10);
897 shared
.select2
= createStringObject("select 2\r\n",10);
898 shared
.select3
= createStringObject("select 3\r\n",10);
899 shared
.select4
= createStringObject("select 4\r\n",10);
900 shared
.select5
= createStringObject("select 5\r\n",10);
901 shared
.select6
= createStringObject("select 6\r\n",10);
902 shared
.select7
= createStringObject("select 7\r\n",10);
903 shared
.select8
= createStringObject("select 8\r\n",10);
904 shared
.select9
= createStringObject("select 9\r\n",10);
905 shared
.messagebulk
= createStringObject("$7\r\nmessage\r\n",13);
906 shared
.pmessagebulk
= createStringObject("$8\r\npmessage\r\n",14);
907 shared
.subscribebulk
= createStringObject("$9\r\nsubscribe\r\n",15);
908 shared
.unsubscribebulk
= createStringObject("$11\r\nunsubscribe\r\n",18);
909 shared
.psubscribebulk
= createStringObject("$10\r\npsubscribe\r\n",17);
910 shared
.punsubscribebulk
= createStringObject("$12\r\npunsubscribe\r\n",19);
911 shared
.del
= createStringObject("DEL",3);
912 shared
.rpop
= createStringObject("RPOP",4);
913 shared
.lpop
= createStringObject("LPOP",4);
914 for (j
= 0; j
< REDIS_SHARED_INTEGERS
; j
++) {
915 shared
.integers
[j
] = createObject(REDIS_STRING
,(void*)(long)j
);
916 shared
.integers
[j
]->encoding
= REDIS_ENCODING_INT
;
918 for (j
= 0; j
< REDIS_SHARED_BULKHDR_LEN
; j
++) {
919 shared
.mbulkhdr
[j
] = createObject(REDIS_STRING
,
920 sdscatprintf(sdsempty(),"*%d\r\n",j
));
921 shared
.bulkhdr
[j
] = createObject(REDIS_STRING
,
922 sdscatprintf(sdsempty(),"$%d\r\n",j
));
926 void initServerConfig() {
927 getRandomHexChars(server
.runid
,REDIS_RUN_ID_SIZE
);
928 server
.runid
[REDIS_RUN_ID_SIZE
] = '\0';
929 server
.arch_bits
= (sizeof(long) == 8) ? 64 : 32;
930 server
.port
= REDIS_SERVERPORT
;
931 server
.bindaddr
= NULL
;
932 server
.unixsocket
= NULL
;
933 server
.unixsocketperm
= 0;
936 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
937 server
.verbosity
= REDIS_NOTICE
;
938 server
.maxidletime
= REDIS_MAXIDLETIME
;
939 server
.client_max_querybuf_len
= REDIS_MAX_QUERYBUF_LEN
;
940 server
.saveparams
= NULL
;
942 server
.logfile
= NULL
; /* NULL = log on standard output */
943 server
.syslog_enabled
= 0;
944 server
.syslog_ident
= zstrdup("redis");
945 server
.syslog_facility
= LOG_LOCAL0
;
946 server
.daemonize
= 0;
947 server
.aof_state
= REDIS_AOF_OFF
;
948 server
.aof_fsync
= AOF_FSYNC_EVERYSEC
;
949 server
.aof_no_fsync_on_rewrite
= 0;
950 server
.aof_rewrite_perc
= REDIS_AOF_REWRITE_PERC
;
951 server
.aof_rewrite_min_size
= REDIS_AOF_REWRITE_MIN_SIZE
;
952 server
.aof_rewrite_base_size
= 0;
953 server
.aof_rewrite_scheduled
= 0;
954 server
.aof_last_fsync
= time(NULL
);
956 server
.aof_selected_db
= -1; /* Make sure the first time will not match */
957 server
.aof_flush_postponed_start
= 0;
958 server
.pidfile
= zstrdup("/var/run/redis.pid");
959 server
.rdb_filename
= zstrdup("dump.rdb");
960 server
.aof_filename
= zstrdup("appendonly.aof");
961 server
.requirepass
= NULL
;
962 server
.rdb_compression
= 1;
963 server
.activerehashing
= 1;
964 server
.maxclients
= REDIS_MAX_CLIENTS
;
965 server
.bpop_blocked_clients
= 0;
966 server
.maxmemory
= 0;
967 server
.maxmemory_policy
= REDIS_MAXMEMORY_VOLATILE_LRU
;
968 server
.maxmemory_samples
= 3;
969 server
.hash_max_ziplist_entries
= REDIS_HASH_MAX_ZIPLIST_ENTRIES
;
970 server
.hash_max_ziplist_value
= REDIS_HASH_MAX_ZIPLIST_VALUE
;
971 server
.list_max_ziplist_entries
= REDIS_LIST_MAX_ZIPLIST_ENTRIES
;
972 server
.list_max_ziplist_value
= REDIS_LIST_MAX_ZIPLIST_VALUE
;
973 server
.set_max_intset_entries
= REDIS_SET_MAX_INTSET_ENTRIES
;
974 server
.zset_max_ziplist_entries
= REDIS_ZSET_MAX_ZIPLIST_ENTRIES
;
975 server
.zset_max_ziplist_value
= REDIS_ZSET_MAX_ZIPLIST_VALUE
;
976 server
.shutdown_asap
= 0;
977 server
.repl_ping_slave_period
= REDIS_REPL_PING_SLAVE_PERIOD
;
978 server
.repl_timeout
= REDIS_REPL_TIMEOUT
;
979 server
.lua_caller
= NULL
;
980 server
.lua_time_limit
= REDIS_LUA_TIME_LIMIT
;
981 server
.lua_client
= NULL
;
982 server
.lua_timedout
= 0;
985 resetServerSaveParams();
987 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
988 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
989 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
990 /* Replication related */
991 server
.masterauth
= NULL
;
992 server
.masterhost
= NULL
;
993 server
.masterport
= 6379;
994 server
.master
= NULL
;
995 server
.repl_state
= REDIS_REPL_NONE
;
996 server
.repl_syncio_timeout
= REDIS_REPL_SYNCIO_TIMEOUT
;
997 server
.repl_serve_stale_data
= 1;
998 server
.repl_down_since
= -1;
1000 /* Client output buffer limits */
1001 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_NORMAL
].hard_limit_bytes
= 0;
1002 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_NORMAL
].soft_limit_bytes
= 0;
1003 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_NORMAL
].soft_limit_seconds
= 0;
1004 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_SLAVE
].hard_limit_bytes
= 1024*1024*256;
1005 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_SLAVE
].soft_limit_bytes
= 1024*1024*64;
1006 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_SLAVE
].soft_limit_seconds
= 60;
1007 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_PUBSUB
].hard_limit_bytes
= 1024*1024*32;
1008 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_PUBSUB
].soft_limit_bytes
= 1024*1024*8;
1009 server
.client_obuf_limits
[REDIS_CLIENT_LIMIT_CLASS_PUBSUB
].soft_limit_seconds
= 60;
1011 /* Double constants initialization */
1013 R_PosInf
= 1.0/R_Zero
;
1014 R_NegInf
= -1.0/R_Zero
;
1015 R_Nan
= R_Zero
/R_Zero
;
1017 /* Command table -- we intiialize it here as it is part of the
1018 * initial configuration, since command names may be changed via
1019 * redis.conf using the rename-command directive. */
1020 server
.commands
= dictCreate(&commandTableDictType
,NULL
);
1021 populateCommandTable();
1022 server
.delCommand
= lookupCommandByCString("del");
1023 server
.multiCommand
= lookupCommandByCString("multi");
1024 server
.lpushCommand
= lookupCommandByCString("lpush");
1027 server
.slowlog_log_slower_than
= REDIS_SLOWLOG_LOG_SLOWER_THAN
;
1028 server
.slowlog_max_len
= REDIS_SLOWLOG_MAX_LEN
;
1031 server
.assert_failed
= "<no assertion failed>";
1032 server
.assert_file
= "<no file>";
1033 server
.assert_line
= 0;
1034 server
.bug_report_start
= 0;
1037 /* This function will try to raise the max number of open files accordingly to
1038 * the configured max number of clients. It will also account for 32 additional
1039 * file descriptors as we need a few more for persistence, listening
1040 * sockets, log files and so forth.
1042 * If it will not be possible to set the limit accordingly to the configured
1043 * max number of clients, the function will do the reverse setting
1044 * server.maxclients to the value that we can actually handle. */
1045 void adjustOpenFilesLimit(void) {
1046 rlim_t maxfiles
= server
.maxclients
+32;
1047 struct rlimit limit
;
1049 if (maxfiles
< 1024) maxfiles
= 1024;
1050 if (getrlimit(RLIMIT_NOFILE
,&limit
) == -1) {
1051 redisLog(REDIS_WARNING
,"Unable to obtain the current NOFILE limit (%s), assuming 1024 and setting the max clients configuration accordingly.",
1053 server
.maxclients
= 1024-32;
1055 rlim_t oldlimit
= limit
.rlim_cur
;
1057 /* Set the max number of files if the current limit is not enough
1059 if (oldlimit
< maxfiles
) {
1060 limit
.rlim_cur
= maxfiles
;
1061 limit
.rlim_max
= maxfiles
;
1062 if (setrlimit(RLIMIT_NOFILE
,&limit
) == -1) {
1063 server
.maxclients
= oldlimit
-32;
1064 redisLog(REDIS_WARNING
,"Unable to set the max number of files limit to %d (%s), setting the max clients configuration to %d.",
1065 (int) maxfiles
, strerror(errno
), (int) server
.maxclients
);
1067 redisLog(REDIS_NOTICE
,"Max number of open files set to %d",
1077 signal(SIGHUP
, SIG_IGN
);
1078 signal(SIGPIPE
, SIG_IGN
);
1079 setupSignalHandlers();
1081 if (server
.syslog_enabled
) {
1082 openlog(server
.syslog_ident
, LOG_PID
| LOG_NDELAY
| LOG_NOWAIT
,
1083 server
.syslog_facility
);
1086 server
.current_client
= NULL
;
1087 server
.clients
= listCreate();
1088 server
.clients_to_close
= listCreate();
1089 server
.slaves
= listCreate();
1090 server
.monitors
= listCreate();
1091 server
.unblocked_clients
= listCreate();
1093 createSharedObjects();
1094 adjustOpenFilesLimit();
1095 server
.el
= aeCreateEventLoop(server
.maxclients
+1024);
1096 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1098 if (server
.port
!= 0) {
1099 server
.ipfd
= anetTcpServer(server
.neterr
,server
.port
,server
.bindaddr
);
1100 if (server
.ipfd
== ANET_ERR
) {
1101 redisLog(REDIS_WARNING
, "Opening port %d: %s",
1102 server
.port
, server
.neterr
);
1106 if (server
.unixsocket
!= NULL
) {
1107 unlink(server
.unixsocket
); /* don't care if this fails */
1108 server
.sofd
= anetUnixServer(server
.neterr
,server
.unixsocket
,server
.unixsocketperm
);
1109 if (server
.sofd
== ANET_ERR
) {
1110 redisLog(REDIS_WARNING
, "Opening socket: %s", server
.neterr
);
1114 if (server
.ipfd
< 0 && server
.sofd
< 0) {
1115 redisLog(REDIS_WARNING
, "Configured to not listen anywhere, exiting.");
1118 for (j
= 0; j
< server
.dbnum
; j
++) {
1119 server
.db
[j
].dict
= dictCreate(&dbDictType
,NULL
);
1120 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1121 server
.db
[j
].blocking_keys
= dictCreate(&keylistDictType
,NULL
);
1122 server
.db
[j
].watched_keys
= dictCreate(&keylistDictType
,NULL
);
1123 server
.db
[j
].id
= j
;
1125 server
.pubsub_channels
= dictCreate(&keylistDictType
,NULL
);
1126 server
.pubsub_patterns
= listCreate();
1127 listSetFreeMethod(server
.pubsub_patterns
,freePubsubPattern
);
1128 listSetMatchMethod(server
.pubsub_patterns
,listMatchPubsubPattern
);
1129 server
.cronloops
= 0;
1130 server
.rdb_child_pid
= -1;
1131 server
.aof_child_pid
= -1;
1132 server
.aof_rewrite_buf
= sdsempty();
1133 server
.aof_buf
= sdsempty();
1134 server
.lastsave
= time(NULL
);
1136 server
.stat_numcommands
= 0;
1137 server
.stat_numconnections
= 0;
1138 server
.stat_expiredkeys
= 0;
1139 server
.stat_evictedkeys
= 0;
1140 server
.stat_starttime
= time(NULL
);
1141 server
.stat_keyspace_misses
= 0;
1142 server
.stat_keyspace_hits
= 0;
1143 server
.stat_peak_memory
= 0;
1144 server
.stat_fork_time
= 0;
1145 server
.stat_rejected_conn
= 0;
1146 memset(server
.ops_sec_samples
,0,sizeof(server
.ops_sec_samples
));
1147 server
.ops_sec_idx
= 0;
1148 server
.ops_sec_last_sample_time
= mstime();
1149 server
.ops_sec_last_sample_ops
= 0;
1150 server
.unixtime
= time(NULL
);
1151 server
.lastbgsave_status
= REDIS_OK
;
1152 server
.stop_writes_on_bgsave_err
= 1;
1153 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1154 if (server
.ipfd
> 0 && aeCreateFileEvent(server
.el
,server
.ipfd
,AE_READABLE
,
1155 acceptTcpHandler
,NULL
) == AE_ERR
) oom("creating file event");
1156 if (server
.sofd
> 0 && aeCreateFileEvent(server
.el
,server
.sofd
,AE_READABLE
,
1157 acceptUnixHandler
,NULL
) == AE_ERR
) oom("creating file event");
1159 if (server
.aof_state
== REDIS_AOF_ON
) {
1160 server
.aof_fd
= open(server
.aof_filename
,
1161 O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1162 if (server
.aof_fd
== -1) {
1163 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1169 /* 32 bit instances are limited to 4GB of address space, so if there is
1170 * no explicit limit in the user provided configuration we set a limit
1171 * at 3.5GB using maxmemory with 'noeviction' policy'. This saves
1172 * useless crashes of the Redis instance. */
1173 if (server
.arch_bits
== 32 && server
.maxmemory
== 0) {
1174 redisLog(REDIS_WARNING
,"Warning: 32 bit instance detected but no memory limit set. Setting 3.5 GB maxmemory limit with 'noeviction' policy now.");
1175 server
.maxmemory
= 3584LL*(1024*1024); /* 3584 MB = 3.5 GB */
1176 server
.maxmemory_policy
= REDIS_MAXMEMORY_NO_EVICTION
;
1184 /* Populates the Redis Command Table starting from the hard coded list
1185 * we have on top of redis.c file. */
1186 void populateCommandTable(void) {
1188 int numcommands
= sizeof(redisCommandTable
)/sizeof(struct redisCommand
);
1190 for (j
= 0; j
< numcommands
; j
++) {
1191 struct redisCommand
*c
= redisCommandTable
+j
;
1192 char *f
= c
->sflags
;
1197 case 'w': c
->flags
|= REDIS_CMD_WRITE
; break;
1198 case 'r': c
->flags
|= REDIS_CMD_READONLY
; break;
1199 case 'm': c
->flags
|= REDIS_CMD_DENYOOM
; break;
1200 case 'a': c
->flags
|= REDIS_CMD_ADMIN
; break;
1201 case 'p': c
->flags
|= REDIS_CMD_PUBSUB
; break;
1202 case 'f': c
->flags
|= REDIS_CMD_FORCE_REPLICATION
; break;
1203 case 's': c
->flags
|= REDIS_CMD_NOSCRIPT
; break;
1204 case 'R': c
->flags
|= REDIS_CMD_RANDOM
; break;
1205 case 'S': c
->flags
|= REDIS_CMD_SORT_FOR_SCRIPT
; break;
1206 default: redisPanic("Unsupported command flag"); break;
1211 retval
= dictAdd(server
.commands
, sdsnew(c
->name
), c
);
1212 assert(retval
== DICT_OK
);
1216 void resetCommandTableStats(void) {
1217 int numcommands
= sizeof(redisCommandTable
)/sizeof(struct redisCommand
);
1220 for (j
= 0; j
< numcommands
; j
++) {
1221 struct redisCommand
*c
= redisCommandTable
+j
;
1223 c
->microseconds
= 0;
1228 /* ========================== Redis OP Array API ============================ */
1230 void redisOpArrayInit(redisOpArray
*oa
) {
1235 int redisOpArrayAppend(redisOpArray
*oa
, struct redisCommand
*cmd
, int dbid
,
1236 robj
**argv
, int argc
, int target
)
1240 oa
->ops
= zrealloc(oa
->ops
,sizeof(redisOp
)*(oa
->numops
+1));
1241 op
= oa
->ops
+oa
->numops
;
1246 op
->target
= target
;
1251 void redisOpArrayFree(redisOpArray
*oa
) {
1257 op
= oa
->ops
+oa
->numops
;
1258 for (j
= 0; j
< op
->argc
; j
++)
1259 decrRefCount(op
->argv
[j
]);
1265 /* ====================== Commands lookup and execution ===================== */
1267 struct redisCommand
*lookupCommand(sds name
) {
1268 return dictFetchValue(server
.commands
, name
);
1271 struct redisCommand
*lookupCommandByCString(char *s
) {
1272 struct redisCommand
*cmd
;
1273 sds name
= sdsnew(s
);
1275 cmd
= dictFetchValue(server
.commands
, name
);
1280 /* Propagate the specified command (in the context of the specified database id)
1281 * to AOF, Slaves and Monitors.
1283 * flags are an xor between:
1284 * + REDIS_PROPAGATE_NONE (no propagation of command at all)
1285 * + REDIS_PROPAGATE_AOF (propagate into the AOF file if is enabled)
1286 * + REDIS_PROPAGATE_REPL (propagate into the replication link)
1288 void propagate(struct redisCommand
*cmd
, int dbid
, robj
**argv
, int argc
,
1291 if (server
.aof_state
!= REDIS_AOF_OFF
&& flags
& REDIS_PROPAGATE_AOF
)
1292 feedAppendOnlyFile(cmd
,dbid
,argv
,argc
);
1293 if (flags
& REDIS_PROPAGATE_REPL
&& listLength(server
.slaves
))
1294 replicationFeedSlaves(server
.slaves
,dbid
,argv
,argc
);
1297 /* Used inside commands to schedule the propagation of additional commands
1298 * after the current command is propagated to AOF / Replication. */
1299 void alsoPropagate(struct redisCommand
*cmd
, int dbid
, robj
**argv
, int argc
,
1302 redisOpArrayAppend(&server
.also_propagate
,cmd
,dbid
,argv
,argc
,target
);
1305 /* Call() is the core of Redis execution of a command */
1306 void call(redisClient
*c
, int flags
) {
1307 long long dirty
, start
= ustime(), duration
;
1309 /* Sent the command to clients in MONITOR mode, only if the commands are
1310 * not geneated from reading an AOF. */
1311 if (listLength(server
.monitors
) && !server
.loading
)
1312 replicationFeedMonitors(c
,server
.monitors
,c
->db
->id
,c
->argv
,c
->argc
);
1314 /* Call the command. */
1315 redisOpArrayInit(&server
.also_propagate
);
1316 dirty
= server
.dirty
;
1318 dirty
= server
.dirty
-dirty
;
1319 duration
= ustime()-start
;
1321 /* When EVAL is called loading the AOF we don't want commands called
1322 * from Lua to go into the slowlog or to populate statistics. */
1323 if (server
.loading
&& c
->flags
& REDIS_LUA_CLIENT
)
1324 flags
&= ~(REDIS_CALL_SLOWLOG
| REDIS_CALL_STATS
);
1326 /* Log the command into the Slow log if needed, and populate the
1327 * per-command statistics that we show in INFO commandstats. */
1328 if (flags
& REDIS_CALL_SLOWLOG
)
1329 slowlogPushEntryIfNeeded(c
->argv
,c
->argc
,duration
);
1330 if (flags
& REDIS_CALL_STATS
) {
1331 c
->cmd
->microseconds
+= duration
;
1335 /* Propagate the command into the AOF and replication link */
1336 if (flags
& REDIS_CALL_PROPAGATE
) {
1337 int flags
= REDIS_PROPAGATE_NONE
;
1339 if (c
->cmd
->flags
& REDIS_CMD_FORCE_REPLICATION
)
1340 flags
|= REDIS_PROPAGATE_REPL
;
1342 flags
|= (REDIS_PROPAGATE_REPL
| REDIS_PROPAGATE_AOF
);
1343 if (flags
!= REDIS_PROPAGATE_NONE
)
1344 propagate(c
->cmd
,c
->db
->id
,c
->argv
,c
->argc
,flags
);
1346 /* Commands such as LPUSH or BRPOPLPUSH may propagate an additional
1348 if (server
.also_propagate
.numops
) {
1352 for (j
= 0; j
< server
.also_propagate
.numops
; j
++) {
1353 rop
= &server
.also_propagate
.ops
[j
];
1354 propagate(rop
->cmd
, rop
->dbid
, rop
->argv
, rop
->argc
, rop
->target
);
1356 redisOpArrayFree(&server
.also_propagate
);
1358 server
.stat_numcommands
++;
1361 /* If this function gets called we already read a whole
1362 * command, argments are in the client argv/argc fields.
1363 * processCommand() execute the command or prepare the
1364 * server for a bulk read from the client.
1366 * If 1 is returned the client is still alive and valid and
1367 * and other operations can be performed by the caller. Otherwise
1368 * if 0 is returned the client was destroied (i.e. after QUIT). */
1369 int processCommand(redisClient
*c
) {
1370 /* The QUIT command is handled separately. Normal command procs will
1371 * go through checking for replication and QUIT will cause trouble
1372 * when FORCE_REPLICATION is enabled and would be implemented in
1373 * a regular command proc. */
1374 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
1375 addReply(c
,shared
.ok
);
1376 c
->flags
|= REDIS_CLOSE_AFTER_REPLY
;
1380 /* Now lookup the command and check ASAP about trivial error conditions
1381 * such as wrong arity, bad command name and so forth. */
1382 c
->cmd
= c
->lastcmd
= lookupCommand(c
->argv
[0]->ptr
);
1384 addReplyErrorFormat(c
,"unknown command '%s'",
1385 (char*)c
->argv
[0]->ptr
);
1387 } else if ((c
->cmd
->arity
> 0 && c
->cmd
->arity
!= c
->argc
) ||
1388 (c
->argc
< -c
->cmd
->arity
)) {
1389 addReplyErrorFormat(c
,"wrong number of arguments for '%s' command",
1394 /* Check if the user is authenticated */
1395 if (server
.requirepass
&& !c
->authenticated
&& c
->cmd
->proc
!= authCommand
)
1397 addReplyError(c
,"operation not permitted");
1401 /* Handle the maxmemory directive.
1403 * First we try to free some memory if possible (if there are volatile
1404 * keys in the dataset). If there are not the only thing we can do
1405 * is returning an error. */
1406 if (server
.maxmemory
) {
1407 int retval
= freeMemoryIfNeeded();
1408 if ((c
->cmd
->flags
& REDIS_CMD_DENYOOM
) && retval
== REDIS_ERR
) {
1410 "command not allowed when used memory > 'maxmemory'");
1415 /* Don't accept write commands if there are problems persisting on disk. */
1416 if (server
.stop_writes_on_bgsave_err
&&
1417 server
.saveparamslen
> 0
1418 && server
.lastbgsave_status
== REDIS_ERR
&&
1419 c
->cmd
->flags
& REDIS_CMD_WRITE
)
1421 addReply(c
, shared
.bgsaveerr
);
1425 /* Only allow SUBSCRIBE and UNSUBSCRIBE in the context of Pub/Sub */
1426 if ((dictSize(c
->pubsub_channels
) > 0 || listLength(c
->pubsub_patterns
) > 0)
1428 c
->cmd
->proc
!= subscribeCommand
&&
1429 c
->cmd
->proc
!= unsubscribeCommand
&&
1430 c
->cmd
->proc
!= psubscribeCommand
&&
1431 c
->cmd
->proc
!= punsubscribeCommand
) {
1432 addReplyError(c
,"only (P)SUBSCRIBE / (P)UNSUBSCRIBE / QUIT allowed in this context");
1436 /* Only allow INFO and SLAVEOF when slave-serve-stale-data is no and
1437 * we are a slave with a broken link with master. */
1438 if (server
.masterhost
&& server
.repl_state
!= REDIS_REPL_CONNECTED
&&
1439 server
.repl_serve_stale_data
== 0 &&
1440 c
->cmd
->proc
!= infoCommand
&& c
->cmd
->proc
!= slaveofCommand
)
1443 "link with MASTER is down and slave-serve-stale-data is set to no");
1447 /* Loading DB? Return an error if the command is not INFO */
1448 if (server
.loading
&& c
->cmd
->proc
!= infoCommand
) {
1449 addReply(c
, shared
.loadingerr
);
1453 /* Lua script too slow? Only allow SHUTDOWN NOSAVE and SCRIPT KILL. */
1454 if (server
.lua_timedout
&&
1455 !(c
->cmd
->proc
!= shutdownCommand
&&
1457 tolower(((char*)c
->argv
[1]->ptr
)[0]) == 'n') &&
1458 !(c
->cmd
->proc
== scriptCommand
&&
1460 tolower(((char*)c
->argv
[1]->ptr
)[0]) == 'k'))
1462 addReply(c
, shared
.slowscripterr
);
1466 /* Exec the command */
1467 if (c
->flags
& REDIS_MULTI
&&
1468 c
->cmd
->proc
!= execCommand
&& c
->cmd
->proc
!= discardCommand
&&
1469 c
->cmd
->proc
!= multiCommand
&& c
->cmd
->proc
!= watchCommand
)
1471 queueMultiCommand(c
);
1472 addReply(c
,shared
.queued
);
1474 call(c
,REDIS_CALL_FULL
);
1479 /*================================== Shutdown =============================== */
1481 int prepareForShutdown(int flags
) {
1482 int save
= flags
& REDIS_SHUTDOWN_SAVE
;
1483 int nosave
= flags
& REDIS_SHUTDOWN_NOSAVE
;
1485 redisLog(REDIS_WARNING
,"User requested shutdown...");
1486 /* Kill the saving child if there is a background saving in progress.
1487 We want to avoid race conditions, for instance our saving child may
1488 overwrite the synchronous saving did by SHUTDOWN. */
1489 if (server
.rdb_child_pid
!= -1) {
1490 redisLog(REDIS_WARNING
,"There is a child saving an .rdb. Killing it!");
1491 kill(server
.rdb_child_pid
,SIGKILL
);
1492 rdbRemoveTempFile(server
.rdb_child_pid
);
1494 if (server
.aof_state
!= REDIS_AOF_OFF
) {
1495 /* Kill the AOF saving child as the AOF we already have may be longer
1496 * but contains the full dataset anyway. */
1497 if (server
.aof_child_pid
!= -1) {
1498 redisLog(REDIS_WARNING
,
1499 "There is a child rewriting the AOF. Killing it!");
1500 kill(server
.aof_child_pid
,SIGKILL
);
1502 /* Append only file: fsync() the AOF and exit */
1503 redisLog(REDIS_NOTICE
,"Calling fsync() on the AOF file.");
1504 aof_fsync(server
.aof_fd
);
1506 if ((server
.saveparamslen
> 0 && !nosave
) || save
) {
1507 redisLog(REDIS_NOTICE
,"Saving the final RDB snapshot before exiting.");
1508 /* Snapshotting. Perform a SYNC SAVE and exit */
1509 if (rdbSave(server
.rdb_filename
) != REDIS_OK
) {
1510 /* Ooops.. error saving! The best we can do is to continue
1511 * operating. Note that if there was a background saving process,
1512 * in the next cron() Redis will be notified that the background
1513 * saving aborted, handling special stuff like slaves pending for
1514 * synchronization... */
1515 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit.");
1519 if (server
.daemonize
) {
1520 redisLog(REDIS_NOTICE
,"Removing the pid file.");
1521 unlink(server
.pidfile
);
1523 /* Close the listening sockets. Apparently this allows faster restarts. */
1524 if (server
.ipfd
!= -1) close(server
.ipfd
);
1525 if (server
.sofd
!= -1) close(server
.sofd
);
1526 if (server
.unixsocket
) {
1527 redisLog(REDIS_NOTICE
,"Removing the unix socket file.");
1528 unlink(server
.unixsocket
); /* don't care if this fails */
1531 redisLog(REDIS_WARNING
,"Redis is now ready to exit, bye bye...");
1535 /*================================== Commands =============================== */
1537 void authCommand(redisClient
*c
) {
1538 if (!server
.requirepass
) {
1539 addReplyError(c
,"Client sent AUTH, but no password is set");
1540 } else if (!strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
1541 c
->authenticated
= 1;
1542 addReply(c
,shared
.ok
);
1544 c
->authenticated
= 0;
1545 addReplyError(c
,"invalid password");
1549 void pingCommand(redisClient
*c
) {
1550 addReply(c
,shared
.pong
);
1553 void echoCommand(redisClient
*c
) {
1554 addReplyBulk(c
,c
->argv
[1]);
1557 void timeCommand(redisClient
*c
) {
1560 /* gettimeofday() can only fail if &tv is a bad addresss so we
1561 * don't check for errors. */
1562 gettimeofday(&tv
,NULL
);
1563 addReplyMultiBulkLen(c
,2);
1564 addReplyBulkLongLong(c
,tv
.tv_sec
);
1565 addReplyBulkLongLong(c
,tv
.tv_usec
);
1568 /* Convert an amount of bytes into a human readable string in the form
1569 * of 100B, 2G, 100M, 4K, and so forth. */
1570 void bytesToHuman(char *s
, unsigned long long n
) {
1575 sprintf(s
,"%lluB",n
);
1577 } else if (n
< (1024*1024)) {
1578 d
= (double)n
/(1024);
1579 sprintf(s
,"%.2fK",d
);
1580 } else if (n
< (1024LL*1024*1024)) {
1581 d
= (double)n
/(1024*1024);
1582 sprintf(s
,"%.2fM",d
);
1583 } else if (n
< (1024LL*1024*1024*1024)) {
1584 d
= (double)n
/(1024LL*1024*1024);
1585 sprintf(s
,"%.2fG",d
);
1589 /* Create the string returned by the INFO command. This is decoupled
1590 * by the INFO command itself as we need to report the same information
1591 * on memory corruption problems. */
1592 sds
genRedisInfoString(char *section
) {
1593 sds info
= sdsempty();
1594 time_t uptime
= time(NULL
)-server
.stat_starttime
;
1596 struct rusage self_ru
, c_ru
;
1597 unsigned long lol
, bib
;
1598 int allsections
= 0, defsections
= 0;
1602 allsections
= strcasecmp(section
,"all") == 0;
1603 defsections
= strcasecmp(section
,"default") == 0;
1606 getrusage(RUSAGE_SELF
, &self_ru
);
1607 getrusage(RUSAGE_CHILDREN
, &c_ru
);
1608 getClientsMaxBuffers(&lol
,&bib
);
1611 if (allsections
|| defsections
|| !strcasecmp(section
,"server")) {
1612 if (sections
++) info
= sdscat(info
,"\r\n");
1613 info
= sdscatprintf(info
,
1615 "redis_version:%s\r\n"
1616 "redis_git_sha1:%s\r\n"
1617 "redis_git_dirty:%d\r\n"
1619 "multiplexing_api:%s\r\n"
1620 "gcc_version:%d.%d.%d\r\n"
1621 "process_id:%ld\r\n"
1624 "uptime_in_seconds:%ld\r\n"
1625 "uptime_in_days:%ld\r\n"
1626 "lru_clock:%ld\r\n",
1629 strtol(redisGitDirty(),NULL
,10) > 0,
1633 __GNUC__
,__GNUC_MINOR__
,__GNUC_PATCHLEVEL__
,
1642 (unsigned long) server
.lruclock
);
1646 if (allsections
|| defsections
|| !strcasecmp(section
,"clients")) {
1647 if (sections
++) info
= sdscat(info
,"\r\n");
1648 info
= sdscatprintf(info
,
1650 "connected_clients:%lu\r\n"
1651 "client_longest_output_list:%lu\r\n"
1652 "client_biggest_input_buf:%lu\r\n"
1653 "blocked_clients:%d\r\n",
1654 listLength(server
.clients
)-listLength(server
.slaves
),
1656 server
.bpop_blocked_clients
);
1660 if (allsections
|| defsections
|| !strcasecmp(section
,"memory")) {
1664 bytesToHuman(hmem
,zmalloc_used_memory());
1665 bytesToHuman(peak_hmem
,server
.stat_peak_memory
);
1666 if (sections
++) info
= sdscat(info
,"\r\n");
1667 info
= sdscatprintf(info
,
1669 "used_memory:%zu\r\n"
1670 "used_memory_human:%s\r\n"
1671 "used_memory_rss:%zu\r\n"
1672 "used_memory_peak:%zu\r\n"
1673 "used_memory_peak_human:%s\r\n"
1674 "used_memory_lua:%lld\r\n"
1675 "mem_fragmentation_ratio:%.2f\r\n"
1676 "mem_allocator:%s\r\n",
1677 zmalloc_used_memory(),
1680 server
.stat_peak_memory
,
1682 ((long long)lua_gc(server
.lua
,LUA_GCCOUNT
,0))*1024LL,
1683 zmalloc_get_fragmentation_ratio(),
1689 if (allsections
|| defsections
|| !strcasecmp(section
,"persistence")) {
1690 if (sections
++) info
= sdscat(info
,"\r\n");
1691 info
= sdscatprintf(info
,
1694 "aof_enabled:%d\r\n"
1695 "changes_since_last_save:%lld\r\n"
1696 "bgsave_in_progress:%d\r\n"
1697 "last_save_time:%ld\r\n"
1698 "last_bgsave_status:%s\r\n"
1699 "bgrewriteaof_in_progress:%d\r\n",
1701 server
.aof_state
!= REDIS_AOF_OFF
,
1703 server
.rdb_child_pid
!= -1,
1705 server
.lastbgsave_status
== REDIS_OK
? "ok" : "err",
1706 server
.aof_child_pid
!= -1);
1708 if (server
.aof_state
!= REDIS_AOF_OFF
) {
1709 info
= sdscatprintf(info
,
1710 "aof_current_size:%lld\r\n"
1711 "aof_base_size:%lld\r\n"
1712 "aof_pending_rewrite:%d\r\n"
1713 "aof_buffer_length:%zu\r\n"
1714 "aof_pending_bio_fsync:%llu\r\n",
1715 (long long) server
.aof_current_size
,
1716 (long long) server
.aof_rewrite_base_size
,
1717 server
.aof_rewrite_scheduled
,
1718 sdslen(server
.aof_buf
),
1719 bioPendingJobsOfType(REDIS_BIO_AOF_FSYNC
));
1722 if (server
.loading
) {
1724 time_t eta
, elapsed
;
1725 off_t remaining_bytes
= server
.loading_total_bytes
-
1726 server
.loading_loaded_bytes
;
1728 perc
= ((double)server
.loading_loaded_bytes
/
1729 server
.loading_total_bytes
) * 100;
1731 elapsed
= time(NULL
)-server
.loading_start_time
;
1733 eta
= 1; /* A fake 1 second figure if we don't have
1736 eta
= (elapsed
*remaining_bytes
)/server
.loading_loaded_bytes
;
1739 info
= sdscatprintf(info
,
1740 "loading_start_time:%ld\r\n"
1741 "loading_total_bytes:%llu\r\n"
1742 "loading_loaded_bytes:%llu\r\n"
1743 "loading_loaded_perc:%.2f\r\n"
1744 "loading_eta_seconds:%ld\r\n"
1745 ,(unsigned long) server
.loading_start_time
,
1746 (unsigned long long) server
.loading_total_bytes
,
1747 (unsigned long long) server
.loading_loaded_bytes
,
1755 if (allsections
|| defsections
|| !strcasecmp(section
,"stats")) {
1756 if (sections
++) info
= sdscat(info
,"\r\n");
1757 info
= sdscatprintf(info
,
1759 "total_connections_received:%lld\r\n"
1760 "total_commands_processed:%lld\r\n"
1761 "instantaneous_ops_per_sec:%lld\r\n"
1762 "rejected_connections:%lld\r\n"
1763 "expired_keys:%lld\r\n"
1764 "evicted_keys:%lld\r\n"
1765 "keyspace_hits:%lld\r\n"
1766 "keyspace_misses:%lld\r\n"
1767 "pubsub_channels:%ld\r\n"
1768 "pubsub_patterns:%lu\r\n"
1769 "latest_fork_usec:%lld\r\n",
1770 server
.stat_numconnections
,
1771 server
.stat_numcommands
,
1772 getOperationsPerSecond(),
1773 server
.stat_rejected_conn
,
1774 server
.stat_expiredkeys
,
1775 server
.stat_evictedkeys
,
1776 server
.stat_keyspace_hits
,
1777 server
.stat_keyspace_misses
,
1778 dictSize(server
.pubsub_channels
),
1779 listLength(server
.pubsub_patterns
),
1780 server
.stat_fork_time
);
1784 if (allsections
|| defsections
|| !strcasecmp(section
,"replication")) {
1785 if (sections
++) info
= sdscat(info
,"\r\n");
1786 info
= sdscatprintf(info
,
1789 server
.masterhost
== NULL
? "master" : "slave");
1790 if (server
.masterhost
) {
1791 info
= sdscatprintf(info
,
1792 "master_host:%s\r\n"
1793 "master_port:%d\r\n"
1794 "master_link_status:%s\r\n"
1795 "master_last_io_seconds_ago:%d\r\n"
1796 "master_sync_in_progress:%d\r\n"
1799 (server
.repl_state
== REDIS_REPL_CONNECTED
) ?
1802 ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1,
1803 server
.repl_state
== REDIS_REPL_TRANSFER
1806 if (server
.repl_state
== REDIS_REPL_TRANSFER
) {
1807 info
= sdscatprintf(info
,
1808 "master_sync_left_bytes:%ld\r\n"
1809 "master_sync_last_io_seconds_ago:%d\r\n"
1810 ,(long)server
.repl_transfer_left
,
1811 (int)(time(NULL
)-server
.repl_transfer_lastio
)
1815 if (server
.repl_state
!= REDIS_REPL_CONNECTED
) {
1816 info
= sdscatprintf(info
,
1817 "master_link_down_since_seconds:%ld\r\n",
1818 (long)time(NULL
)-server
.repl_down_since
);
1821 info
= sdscatprintf(info
,
1822 "connected_slaves:%lu\r\n",
1823 listLength(server
.slaves
));
1824 if (listLength(server
.slaves
)) {
1829 listRewind(server
.slaves
,&li
);
1830 while((ln
= listNext(&li
))) {
1831 redisClient
*slave
= listNodeValue(ln
);
1836 if (anetPeerToString(slave
->fd
,ip
,&port
) == -1) continue;
1837 switch(slave
->replstate
) {
1838 case REDIS_REPL_WAIT_BGSAVE_START
:
1839 case REDIS_REPL_WAIT_BGSAVE_END
:
1840 state
= "wait_bgsave";
1842 case REDIS_REPL_SEND_BULK
:
1843 state
= "send_bulk";
1845 case REDIS_REPL_ONLINE
:
1849 if (state
== NULL
) continue;
1850 info
= sdscatprintf(info
,"slave%d:%s,%d,%s\r\n",
1851 slaveid
,ip
,port
,state
);
1858 if (allsections
|| defsections
|| !strcasecmp(section
,"cpu")) {
1859 if (sections
++) info
= sdscat(info
,"\r\n");
1860 info
= sdscatprintf(info
,
1862 "used_cpu_sys:%.2f\r\n"
1863 "used_cpu_user:%.2f\r\n"
1864 "used_cpu_sys_children:%.2f\r\n"
1865 "used_cpu_user_children:%.2f\r\n",
1866 (float)self_ru
.ru_stime
.tv_sec
+(float)self_ru
.ru_stime
.tv_usec
/1000000,
1867 (float)self_ru
.ru_utime
.tv_sec
+(float)self_ru
.ru_utime
.tv_usec
/1000000,
1868 (float)c_ru
.ru_stime
.tv_sec
+(float)c_ru
.ru_stime
.tv_usec
/1000000,
1869 (float)c_ru
.ru_utime
.tv_sec
+(float)c_ru
.ru_utime
.tv_usec
/1000000);
1873 if (allsections
|| !strcasecmp(section
,"commandstats")) {
1874 if (sections
++) info
= sdscat(info
,"\r\n");
1875 info
= sdscatprintf(info
, "# Commandstats\r\n");
1876 numcommands
= sizeof(redisCommandTable
)/sizeof(struct redisCommand
);
1877 for (j
= 0; j
< numcommands
; j
++) {
1878 struct redisCommand
*c
= redisCommandTable
+j
;
1880 if (!c
->calls
) continue;
1881 info
= sdscatprintf(info
,
1882 "cmdstat_%s:calls=%lld,usec=%lld,usec_per_call=%.2f\r\n",
1883 c
->name
, c
->calls
, c
->microseconds
,
1884 (c
->calls
== 0) ? 0 : ((float)c
->microseconds
/c
->calls
));
1889 if (allsections
|| defsections
|| !strcasecmp(section
,"keyspace")) {
1890 if (sections
++) info
= sdscat(info
,"\r\n");
1891 info
= sdscatprintf(info
, "# Keyspace\r\n");
1892 for (j
= 0; j
< server
.dbnum
; j
++) {
1893 long long keys
, vkeys
;
1895 keys
= dictSize(server
.db
[j
].dict
);
1896 vkeys
= dictSize(server
.db
[j
].expires
);
1897 if (keys
|| vkeys
) {
1898 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
1906 void infoCommand(redisClient
*c
) {
1907 char *section
= c
->argc
== 2 ? c
->argv
[1]->ptr
: "default";
1910 addReply(c
,shared
.syntaxerr
);
1913 sds info
= genRedisInfoString(section
);
1914 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
1915 (unsigned long)sdslen(info
)));
1916 addReplySds(c
,info
);
1917 addReply(c
,shared
.crlf
);
1920 void monitorCommand(redisClient
*c
) {
1921 /* ignore MONITOR if aleady slave or in monitor mode */
1922 if (c
->flags
& REDIS_SLAVE
) return;
1924 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
1926 listAddNodeTail(server
.monitors
,c
);
1927 addReply(c
,shared
.ok
);
1930 /* ============================ Maxmemory directive ======================== */
1932 /* This function gets called when 'maxmemory' is set on the config file to limit
1933 * the max memory used by the server, before processing a command.
1935 * The goal of the function is to free enough memory to keep Redis under the
1936 * configured memory limit.
1938 * The function starts calculating how many bytes should be freed to keep
1939 * Redis under the limit, and enters a loop selecting the best keys to
1940 * evict accordingly to the configured policy.
1942 * If all the bytes needed to return back under the limit were freed the
1943 * function returns REDIS_OK, otherwise REDIS_ERR is returned, and the caller
1944 * should block the execution of commands that will result in more memory
1945 * used by the server.
1947 int freeMemoryIfNeeded(void) {
1948 size_t mem_used
, mem_tofree
, mem_freed
;
1949 int slaves
= listLength(server
.slaves
);
1951 /* Remove the size of slaves output buffers and AOF buffer from the
1952 * count of used memory. */
1953 mem_used
= zmalloc_used_memory();
1958 listRewind(server
.slaves
,&li
);
1959 while((ln
= listNext(&li
))) {
1960 redisClient
*slave
= listNodeValue(ln
);
1961 unsigned long obuf_bytes
= getClientOutputBufferMemoryUsage(slave
);
1962 if (obuf_bytes
> mem_used
)
1965 mem_used
-= obuf_bytes
;
1968 if (server
.aof_state
!= REDIS_AOF_OFF
) {
1969 mem_used
-= sdslen(server
.aof_buf
);
1970 mem_used
-= sdslen(server
.aof_rewrite_buf
);
1973 /* Check if we are over the memory limit. */
1974 if (mem_used
<= server
.maxmemory
) return REDIS_OK
;
1976 if (server
.maxmemory_policy
== REDIS_MAXMEMORY_NO_EVICTION
)
1977 return REDIS_ERR
; /* We need to free memory, but policy forbids. */
1979 /* Compute how much memory we need to free. */
1980 mem_tofree
= mem_used
- server
.maxmemory
;
1982 while (mem_freed
< mem_tofree
) {
1983 int j
, k
, keys_freed
= 0;
1985 for (j
= 0; j
< server
.dbnum
; j
++) {
1986 long bestval
= 0; /* just to prevent warning */
1988 struct dictEntry
*de
;
1989 redisDb
*db
= server
.db
+j
;
1992 if (server
.maxmemory_policy
== REDIS_MAXMEMORY_ALLKEYS_LRU
||
1993 server
.maxmemory_policy
== REDIS_MAXMEMORY_ALLKEYS_RANDOM
)
1995 dict
= server
.db
[j
].dict
;
1997 dict
= server
.db
[j
].expires
;
1999 if (dictSize(dict
) == 0) continue;
2001 /* volatile-random and allkeys-random policy */
2002 if (server
.maxmemory_policy
== REDIS_MAXMEMORY_ALLKEYS_RANDOM
||
2003 server
.maxmemory_policy
== REDIS_MAXMEMORY_VOLATILE_RANDOM
)
2005 de
= dictGetRandomKey(dict
);
2006 bestkey
= dictGetKey(de
);
2009 /* volatile-lru and allkeys-lru policy */
2010 else if (server
.maxmemory_policy
== REDIS_MAXMEMORY_ALLKEYS_LRU
||
2011 server
.maxmemory_policy
== REDIS_MAXMEMORY_VOLATILE_LRU
)
2013 for (k
= 0; k
< server
.maxmemory_samples
; k
++) {
2018 de
= dictGetRandomKey(dict
);
2019 thiskey
= dictGetKey(de
);
2020 /* When policy is volatile-lru we need an additonal lookup
2021 * to locate the real key, as dict is set to db->expires. */
2022 if (server
.maxmemory_policy
== REDIS_MAXMEMORY_VOLATILE_LRU
)
2023 de
= dictFind(db
->dict
, thiskey
);
2025 thisval
= estimateObjectIdleTime(o
);
2027 /* Higher idle time is better candidate for deletion */
2028 if (bestkey
== NULL
|| thisval
> bestval
) {
2036 else if (server
.maxmemory_policy
== REDIS_MAXMEMORY_VOLATILE_TTL
) {
2037 for (k
= 0; k
< server
.maxmemory_samples
; k
++) {
2041 de
= dictGetRandomKey(dict
);
2042 thiskey
= dictGetKey(de
);
2043 thisval
= (long) dictGetVal(de
);
2045 /* Expire sooner (minor expire unix timestamp) is better
2046 * candidate for deletion */
2047 if (bestkey
== NULL
|| thisval
< bestval
) {
2054 /* Finally remove the selected key. */
2058 robj
*keyobj
= createStringObject(bestkey
,sdslen(bestkey
));
2059 propagateExpire(db
,keyobj
);
2060 /* We compute the amount of memory freed by dbDelete() alone.
2061 * It is possible that actually the memory needed to propagate
2062 * the DEL in AOF and replication link is greater than the one
2063 * we are freeing removing the key, but we can't account for
2064 * that otherwise we would never exit the loop.
2066 * AOF and Output buffer memory will be freed eventually so
2067 * we only care about memory used by the key space. */
2068 delta
= (long long) zmalloc_used_memory();
2069 dbDelete(db
,keyobj
);
2070 delta
-= (long long) zmalloc_used_memory();
2072 server
.stat_evictedkeys
++;
2073 decrRefCount(keyobj
);
2076 /* When the memory to free starts to be big enough, we may
2077 * start spending so much time here that is impossible to
2078 * deliver data to the slaves fast enough, so we force the
2079 * transmission here inside the loop. */
2080 if (slaves
) flushSlavesOutputBuffers();
2083 if (!keys_freed
) return REDIS_ERR
; /* nothing to free... */
2088 /* =================================== Main! ================================ */
2091 int linuxOvercommitMemoryValue(void) {
2092 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
2096 if (fgets(buf
,64,fp
) == NULL
) {
2105 void linuxOvercommitMemoryWarning(void) {
2106 if (linuxOvercommitMemoryValue() == 0) {
2107 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.");
2110 #endif /* __linux__ */
2112 void createPidFile(void) {
2113 /* Try to write the pid file in a best-effort way. */
2114 FILE *fp
= fopen(server
.pidfile
,"w");
2116 fprintf(fp
,"%d\n",(int)getpid());
2121 void daemonize(void) {
2124 if (fork() != 0) exit(0); /* parent exits */
2125 setsid(); /* create a new session */
2127 /* Every output goes to /dev/null. If Redis is daemonized but
2128 * the 'logfile' is set to 'stdout' in the configuration file
2129 * it will not log at all. */
2130 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
2131 dup2(fd
, STDIN_FILENO
);
2132 dup2(fd
, STDOUT_FILENO
);
2133 dup2(fd
, STDERR_FILENO
);
2134 if (fd
> STDERR_FILENO
) close(fd
);
2139 printf("Redis server version %s (%s:%d)\n", REDIS_VERSION
,
2140 redisGitSHA1(), atoi(redisGitDirty()) > 0);
2145 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf] [options]\n");
2146 fprintf(stderr
," ./redis-server - (read config from stdin)\n");
2147 fprintf(stderr
," ./redis-server -v or --version\n");
2148 fprintf(stderr
," ./redis-server -h or --help\n\n");
2149 fprintf(stderr
,"Examples:\n");
2150 fprintf(stderr
," ./redis-server (run the server with default conf)\n");
2151 fprintf(stderr
," ./redis-server /etc/redis/6379.conf\n");
2152 fprintf(stderr
," ./redis-server --port 7777\n");
2153 fprintf(stderr
," ./redis-server --port 7777 --slaveof 127.0.0.1 8888\n");
2154 fprintf(stderr
," ./redis-server /etc/myredis.conf --loglevel verbose\n");
2158 void redisAsciiArt(void) {
2159 #include "asciilogo.h"
2160 char *buf
= zmalloc(1024*16);
2162 snprintf(buf
,1024*16,ascii_logo
,
2165 strtol(redisGitDirty(),NULL
,10) > 0,
2166 (sizeof(long) == 8) ? "64" : "32",
2171 redisLogRaw(REDIS_NOTICE
|REDIS_LOG_RAW
,buf
);
2175 static void sigtermHandler(int sig
) {
2178 redisLog(REDIS_WARNING
,"Received SIGTERM, scheduling shutdown...");
2179 server
.shutdown_asap
= 1;
2182 void setupSignalHandlers(void) {
2183 struct sigaction act
;
2185 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction is used.
2186 * Otherwise, sa_handler is used. */
2187 sigemptyset(&act
.sa_mask
);
2188 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
;
2189 act
.sa_handler
= sigtermHandler
;
2190 sigaction(SIGTERM
, &act
, NULL
);
2192 #ifdef HAVE_BACKTRACE
2193 sigemptyset(&act
.sa_mask
);
2194 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
2195 act
.sa_sigaction
= sigsegvHandler
;
2196 sigaction(SIGSEGV
, &act
, NULL
);
2197 sigaction(SIGBUS
, &act
, NULL
);
2198 sigaction(SIGFPE
, &act
, NULL
);
2199 sigaction(SIGILL
, &act
, NULL
);
2204 int main(int argc
, char **argv
) {
2208 /* We need to initialize our libraries, and the server configuration. */
2209 zmalloc_enable_thread_safeness();
2210 srand(time(NULL
)^getpid());
2211 gettimeofday(&tv
,NULL
);
2212 dictSetHashFunctionSeed(tv
.tv_sec
^tv
.tv_usec
^getpid());
2216 int j
= 1; /* First option to parse in argv[] */
2217 sds options
= sdsempty();
2218 char *configfile
= NULL
;
2220 /* Handle special options --help and --version */
2221 if (strcmp(argv
[1], "-v") == 0 ||
2222 strcmp(argv
[1], "--version") == 0) version();
2223 if (strcmp(argv
[1], "--help") == 0 ||
2224 strcmp(argv
[1], "-h") == 0) usage();
2225 /* First argument is the config file name? */
2226 if (argv
[j
][0] != '-' || argv
[j
][1] != '-')
2227 configfile
= argv
[j
++];
2228 /* All the other options are parsed and conceptually appended to the
2229 * configuration file. For instance --port 6380 will generate the
2230 * string "port 6380\n" to be parsed after the actual file name
2231 * is parsed, if any. */
2233 if (argv
[j
][0] == '-' && argv
[j
][1] == '-') {
2235 if (sdslen(options
)) options
= sdscat(options
,"\n");
2236 options
= sdscat(options
,argv
[j
]+2);
2237 options
= sdscat(options
," ");
2239 /* Option argument */
2240 options
= sdscatrepr(options
,argv
[j
],strlen(argv
[j
]));
2241 options
= sdscat(options
," ");
2245 resetServerSaveParams();
2246 loadServerConfig(configfile
,options
);
2249 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'");
2251 if (server
.daemonize
) daemonize();
2253 if (server
.daemonize
) createPidFile();
2255 redisLog(REDIS_WARNING
,"Server started, Redis version " REDIS_VERSION
);
2257 linuxOvercommitMemoryWarning();
2260 if (server
.aof_state
== REDIS_AOF_ON
) {
2261 if (loadAppendOnlyFile(server
.aof_filename
) == REDIS_OK
)
2262 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %.3f seconds",(float)(ustime()-start
)/1000000);
2264 if (rdbLoad(server
.rdb_filename
) == REDIS_OK
) {
2265 redisLog(REDIS_NOTICE
,"DB loaded from disk: %.3f seconds",
2266 (float)(ustime()-start
)/1000000);
2267 } else if (errno
!= ENOENT
) {
2268 redisLog(REDIS_WARNING
,"Fatal error loading the DB. Exiting.");
2272 if (server
.ipfd
> 0)
2273 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
2274 if (server
.sofd
> 0)
2275 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections at %s", server
.unixsocket
);
2276 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
2278 aeDeleteEventLoop(server
.el
);