]> git.saurik.com Git - redis.git/blame - src/redis.c
Sentinel: client reconfiguration script execution.
[redis.git] / src / redis.c
CommitLineData
e2641e09 1/*
2 * Copyright (c) 2009-2010, Salvatore Sanfilippo <antirez at gmail dot com>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
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.
16 *
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.
28 */
29
30#include "redis.h"
daa70b17 31#include "slowlog.h"
8f61a72f 32#include "bio.h"
e2641e09 33
e2641e09 34#include <time.h>
35#include <signal.h>
36#include <sys/wait.h>
37#include <errno.h>
38#include <assert.h>
39#include <ctype.h>
40#include <stdarg.h>
e2641e09 41#include <arpa/inet.h>
42#include <sys/stat.h>
43#include <fcntl.h>
44#include <sys/time.h>
45#include <sys/resource.h>
46#include <sys/uio.h>
47#include <limits.h>
48#include <float.h>
49#include <math.h>
2b00385d 50#include <sys/resource.h>
5ad1faa0 51#include <sys/utsname.h>
e2641e09 52
53/* Our shared "common" objects */
54
55struct sharedObjectsStruct shared;
56
c74b7c77 57/* Global vars that are actually used as constants. The following double
e2641e09 58 * values are used for double on-disk serialization, and are initialized
59 * at runtime to avoid strange compiler optimizations. */
60
61double R_Zero, R_PosInf, R_NegInf, R_Nan;
62
63/*================================= Globals ================================= */
64
65/* Global vars */
66struct redisServer server; /* server global state */
67struct redisCommand *commandTable;
5d02b00f 68
7501c66f 69/* Our command table.
70 *
71 * Every entry is composed of the following fields:
72 *
73 * name: a string representing the command name.
74 * function: pointer to the C function implementing the command.
75 * arity: number of arguments, it is possible to use -N to say >= N
76 * sflags: command flags as string. See below for a table of flags.
77 * flags: flags as bitmask. Computed by Redis using the 'sflags' field.
78 * get_keys_proc: an optional function to get key arguments from a command.
79 * This is only used when the following three fields are not
80 * enough to specify what arguments are keys.
81 * first_key_index: first argument that is a key
82 * last_key_index: last argument that is a key
83 * key_step: step to get all the keys from first to last argument. For instance
84 * in MSET the step is two since arguments are key,val,key,val,...
85 * microseconds: microseconds of total execution time for this command.
86 * calls: total number of calls of this command.
87 *
88 * The flags, microseconds and calls fields are computed by Redis and should
89 * always be set to zero.
90 *
91 * Command flags are expressed using strings where every character represents
92 * a flag. Later the populateCommandTable() function will take care of
93 * populating the real 'flags' field using this characters.
5d02b00f 94 *
95 * This is the meaning of the flags:
96 *
97 * w: write command (may modify the key space).
98 * r: read command (will never modify the key space).
99 * m: may increase memory usage once called. Don't allow if out of memory.
100 * a: admin command, like SAVE or SHUTDOWN.
101 * p: Pub/Sub related command.
b60ed6e8 102 * f: force replication of this command, regarless of server.dirty.
103 * s: command not allowed in scripts.
7e14a208 104 * R: random command. Command is not deterministic, that is, the same command
b60ed6e8 105 * with the same arguments, with the same key space, may have different
548efd91 106 * results. For instance SPOP and RANDOMKEY are two random commands.
107 * S: Sort command output array if called from script, so that the output
108 * is deterministic.
5d73073f 109 * l: Allow command while loading the database.
110 * t: Allow command while a slave has stale data but is not allowed to
111 * server this data. Normally no command is accepted in this condition
112 * but just a few.
548efd91 113 */
d7ed7fd2 114struct redisCommand redisCommandTable[] = {
5d02b00f 115 {"get",getCommand,2,"r",0,NULL,1,1,1,0,0},
116 {"set",setCommand,3,"wm",0,noPreloadGetKeys,1,1,1,0,0},
117 {"setnx",setnxCommand,3,"wm",0,noPreloadGetKeys,1,1,1,0,0},
39da5d1f 118 {"setex",setexCommand,4,"wm",0,noPreloadGetKeys,1,1,1,0,0},
119 {"psetex",psetexCommand,4,"wm",0,noPreloadGetKeys,1,1,1,0,0},
5d02b00f 120 {"append",appendCommand,3,"wm",0,NULL,1,1,1,0,0},
121 {"strlen",strlenCommand,2,"r",0,NULL,1,1,1,0,0},
122 {"del",delCommand,-2,"w",0,noPreloadGetKeys,1,-1,1,0,0},
123 {"exists",existsCommand,2,"r",0,NULL,1,1,1,0,0},
124 {"setbit",setbitCommand,4,"wm",0,NULL,1,1,1,0,0},
125 {"getbit",getbitCommand,3,"r",0,NULL,1,1,1,0,0},
126 {"setrange",setrangeCommand,4,"wm",0,NULL,1,1,1,0,0},
127 {"getrange",getrangeCommand,4,"r",0,NULL,1,1,1,0,0},
128 {"substr",getrangeCommand,4,"r",0,NULL,1,1,1,0,0},
129 {"incr",incrCommand,2,"wm",0,NULL,1,1,1,0,0},
130 {"decr",decrCommand,2,"wm",0,NULL,1,1,1,0,0},
131 {"mget",mgetCommand,-2,"r",0,NULL,1,-1,1,0,0},
132 {"rpush",rpushCommand,-3,"wm",0,NULL,1,1,1,0,0},
133 {"lpush",lpushCommand,-3,"wm",0,NULL,1,1,1,0,0},
134 {"rpushx",rpushxCommand,3,"wm",0,NULL,1,1,1,0,0},
135 {"lpushx",lpushxCommand,3,"wm",0,NULL,1,1,1,0,0},
136 {"linsert",linsertCommand,5,"wm",0,NULL,1,1,1,0,0},
137 {"rpop",rpopCommand,2,"w",0,NULL,1,1,1,0,0},
138 {"lpop",lpopCommand,2,"w",0,NULL,1,1,1,0,0},
e41677b4 139 {"brpop",brpopCommand,-3,"ws",0,NULL,1,1,1,0,0},
140 {"brpoplpush",brpoplpushCommand,4,"wms",0,NULL,1,2,1,0,0},
141 {"blpop",blpopCommand,-3,"ws",0,NULL,1,-2,1,0,0},
5d02b00f 142 {"llen",llenCommand,2,"r",0,NULL,1,1,1,0,0},
143 {"lindex",lindexCommand,3,"r",0,NULL,1,1,1,0,0},
144 {"lset",lsetCommand,4,"wm",0,NULL,1,1,1,0,0},
145 {"lrange",lrangeCommand,4,"r",0,NULL,1,1,1,0,0},
146 {"ltrim",ltrimCommand,4,"w",0,NULL,1,1,1,0,0},
147 {"lrem",lremCommand,4,"w",0,NULL,1,1,1,0,0},
148 {"rpoplpush",rpoplpushCommand,3,"wm",0,NULL,1,2,1,0,0},
149 {"sadd",saddCommand,-3,"wm",0,NULL,1,1,1,0,0},
150 {"srem",sremCommand,-3,"w",0,NULL,1,1,1,0,0},
151 {"smove",smoveCommand,4,"w",0,NULL,1,2,1,0,0},
152 {"sismember",sismemberCommand,3,"r",0,NULL,1,1,1,0,0},
153 {"scard",scardCommand,2,"r",0,NULL,1,1,1,0,0},
15ef6053 154 {"spop",spopCommand,2,"wRs",0,NULL,1,1,1,0,0},
b60ed6e8 155 {"srandmember",srandmemberCommand,2,"rR",0,NULL,1,1,1,0,0},
548efd91 156 {"sinter",sinterCommand,-2,"rS",0,NULL,1,-1,1,0,0},
1bcfa0f6 157 {"sinterstore",sinterstoreCommand,-3,"wm",0,NULL,1,-1,1,0,0},
548efd91 158 {"sunion",sunionCommand,-2,"rS",0,NULL,1,-1,1,0,0},
1bcfa0f6 159 {"sunionstore",sunionstoreCommand,-3,"wm",0,NULL,1,-1,1,0,0},
548efd91 160 {"sdiff",sdiffCommand,-2,"rS",0,NULL,1,-1,1,0,0},
1bcfa0f6 161 {"sdiffstore",sdiffstoreCommand,-3,"wm",0,NULL,1,-1,1,0,0},
548efd91 162 {"smembers",sinterCommand,2,"rS",0,NULL,1,1,1,0,0},
5d02b00f 163 {"zadd",zaddCommand,-4,"wm",0,NULL,1,1,1,0,0},
164 {"zincrby",zincrbyCommand,4,"wm",0,NULL,1,1,1,0,0},
165 {"zrem",zremCommand,-3,"w",0,NULL,1,1,1,0,0},
166 {"zremrangebyscore",zremrangebyscoreCommand,4,"w",0,NULL,1,1,1,0,0},
167 {"zremrangebyrank",zremrangebyrankCommand,4,"w",0,NULL,1,1,1,0,0},
168 {"zunionstore",zunionstoreCommand,-4,"wm",0,zunionInterGetKeys,0,0,0,0,0},
169 {"zinterstore",zinterstoreCommand,-4,"wm",0,zunionInterGetKeys,0,0,0,0,0},
170 {"zrange",zrangeCommand,-4,"r",0,NULL,1,1,1,0,0},
171 {"zrangebyscore",zrangebyscoreCommand,-4,"r",0,NULL,1,1,1,0,0},
172 {"zrevrangebyscore",zrevrangebyscoreCommand,-4,"r",0,NULL,1,1,1,0,0},
173 {"zcount",zcountCommand,4,"r",0,NULL,1,1,1,0,0},
174 {"zrevrange",zrevrangeCommand,-4,"r",0,NULL,1,1,1,0,0},
175 {"zcard",zcardCommand,2,"r",0,NULL,1,1,1,0,0},
176 {"zscore",zscoreCommand,3,"r",0,NULL,1,1,1,0,0},
177 {"zrank",zrankCommand,3,"r",0,NULL,1,1,1,0,0},
178 {"zrevrank",zrevrankCommand,3,"r",0,NULL,1,1,1,0,0},
179 {"hset",hsetCommand,4,"wm",0,NULL,1,1,1,0,0},
180 {"hsetnx",hsetnxCommand,4,"wm",0,NULL,1,1,1,0,0},
181 {"hget",hgetCommand,3,"r",0,NULL,1,1,1,0,0},
182 {"hmset",hmsetCommand,-4,"wm",0,NULL,1,1,1,0,0},
183 {"hmget",hmgetCommand,-3,"r",0,NULL,1,1,1,0,0},
184 {"hincrby",hincrbyCommand,4,"wm",0,NULL,1,1,1,0,0},
68bfe993 185 {"hincrbyfloat",hincrbyfloatCommand,4,"wm",0,NULL,1,1,1,0,0},
5d02b00f 186 {"hdel",hdelCommand,-3,"w",0,NULL,1,1,1,0,0},
187 {"hlen",hlenCommand,2,"r",0,NULL,1,1,1,0,0},
548efd91 188 {"hkeys",hkeysCommand,2,"rS",0,NULL,1,1,1,0,0},
189 {"hvals",hvalsCommand,2,"rS",0,NULL,1,1,1,0,0},
5d02b00f 190 {"hgetall",hgetallCommand,2,"r",0,NULL,1,1,1,0,0},
191 {"hexists",hexistsCommand,3,"r",0,NULL,1,1,1,0,0},
192 {"incrby",incrbyCommand,3,"wm",0,NULL,1,1,1,0,0},
193 {"decrby",decrbyCommand,3,"wm",0,NULL,1,1,1,0,0},
5574b53e 194 {"incrbyfloat",incrbyfloatCommand,3,"wm",0,NULL,1,1,1,0,0},
5d02b00f 195 {"getset",getsetCommand,3,"wm",0,NULL,1,1,1,0,0},
196 {"mset",msetCommand,-3,"wm",0,NULL,1,-1,2,0,0},
197 {"msetnx",msetnxCommand,-3,"wm",0,NULL,1,-1,2,0,0},
b60ed6e8 198 {"randomkey",randomkeyCommand,1,"rR",0,NULL,0,0,0,0,0},
5d02b00f 199 {"select",selectCommand,2,"r",0,NULL,0,0,0,0,0},
200 {"move",moveCommand,3,"w",0,NULL,1,1,1,0,0},
201 {"rename",renameCommand,3,"w",0,renameGetKeys,1,2,1,0,0},
202 {"renamenx",renamenxCommand,3,"w",0,renameGetKeys,1,2,1,0,0},
12d293ca 203 {"expire",expireCommand,3,"w",0,NULL,1,1,1,0,0},
204 {"expireat",expireatCommand,3,"w",0,NULL,1,1,1,0,0},
205 {"pexpire",pexpireCommand,3,"w",0,NULL,1,1,1,0,0},
206 {"pexpireat",pexpireatCommand,3,"w",0,NULL,1,1,1,0,0},
548efd91 207 {"keys",keysCommand,2,"rS",0,NULL,0,0,0,0,0},
5d02b00f 208 {"dbsize",dbsizeCommand,1,"r",0,NULL,0,0,0,0,0},
e41677b4 209 {"auth",authCommand,2,"rs",0,NULL,0,0,0,0,0},
5d02b00f 210 {"ping",pingCommand,1,"r",0,NULL,0,0,0,0,0},
211 {"echo",echoCommand,2,"r",0,NULL,0,0,0,0,0},
e41677b4 212 {"save",saveCommand,1,"ars",0,NULL,0,0,0,0,0},
5d02b00f 213 {"bgsave",bgsaveCommand,1,"ar",0,NULL,0,0,0,0,0},
214 {"bgrewriteaof",bgrewriteaofCommand,1,"ar",0,NULL,0,0,0,0,0},
4ab8695d 215 {"shutdown",shutdownCommand,-1,"ar",0,NULL,0,0,0,0,0},
5d02b00f 216 {"lastsave",lastsaveCommand,1,"r",0,NULL,0,0,0,0,0},
217 {"type",typeCommand,2,"r",0,NULL,1,1,1,0,0},
b60ed6e8 218 {"multi",multiCommand,1,"rs",0,NULL,0,0,0,0,0},
f3fd419f 219 {"exec",execCommand,1,"s",0,NULL,0,0,0,0,0},
b60ed6e8 220 {"discard",discardCommand,1,"rs",0,NULL,0,0,0,0,0},
221 {"sync",syncCommand,1,"ars",0,NULL,0,0,0,0,0},
3a328978 222 {"replconf",replconfCommand,-1,"ars",0,NULL,0,0,0,0,0},
5d02b00f 223 {"flushdb",flushdbCommand,1,"w",0,NULL,0,0,0,0,0},
224 {"flushall",flushallCommand,1,"w",0,NULL,0,0,0,0,0},
2c861050 225 {"sort",sortCommand,-2,"wmS",0,NULL,1,1,1,0,0},
5d73073f 226 {"info",infoCommand,-1,"rlt",0,NULL,0,0,0,0,0},
b60ed6e8 227 {"monitor",monitorCommand,1,"ars",0,NULL,0,0,0,0,0},
12d293ca 228 {"ttl",ttlCommand,2,"r",0,NULL,1,1,1,0,0},
229 {"pttl",pttlCommand,2,"r",0,NULL,1,1,1,0,0},
5d02b00f 230 {"persist",persistCommand,2,"w",0,NULL,1,1,1,0,0},
5d73073f 231 {"slaveof",slaveofCommand,3,"ast",0,NULL,0,0,0,0,0},
7dcdd281 232 {"debug",debugCommand,-2,"as",0,NULL,0,0,0,0,0},
5d02b00f 233 {"config",configCommand,-2,"ar",0,NULL,0,0,0,0,0},
5d73073f 234 {"subscribe",subscribeCommand,-2,"rpslt",0,NULL,0,0,0,0,0},
235 {"unsubscribe",unsubscribeCommand,-1,"rpslt",0,NULL,0,0,0,0,0},
236 {"psubscribe",psubscribeCommand,-2,"rpslt",0,NULL,0,0,0,0,0},
237 {"punsubscribe",punsubscribeCommand,-1,"rpslt",0,NULL,0,0,0,0,0},
238 {"publish",publishCommand,3,"pflt",0,NULL,0,0,0,0,0},
b60ed6e8 239 {"watch",watchCommand,-2,"rs",0,noPreloadGetKeys,1,-1,1,0,0},
240 {"unwatch",unwatchCommand,1,"rs",0,NULL,0,0,0,0,0},
5d02b00f 241 {"cluster",clusterCommand,-2,"ar",0,NULL,0,0,0,0,0},
7afc3a96 242 {"restore",restoreCommand,4,"awm",0,NULL,1,1,1,0,0},
5d02b00f 243 {"migrate",migrateCommand,6,"aw",0,NULL,0,0,0,0,0},
6856c7b4 244 {"asking",askingCommand,1,"r",0,NULL,0,0,0,0,0},
1bcfa0f6 245 {"dump",dumpCommand,2,"ar",0,NULL,1,1,1,0,0},
246 {"object",objectCommand,-2,"r",0,NULL,2,2,2,0,0},
5d02b00f 247 {"client",clientCommand,-2,"ar",0,NULL,0,0,0,0,0},
f3fd419f 248 {"eval",evalCommand,-3,"s",0,zunionInterGetKeys,0,0,0,0,0},
249 {"evalsha",evalShaCommand,-3,"s",0,zunionInterGetKeys,0,0,0,0,0},
070e3945 250 {"slowlog",slowlogCommand,-2,"r",0,NULL,0,0,0,0,0},
9494f1f1 251 {"script",scriptCommand,-2,"ras",0,NULL,0,0,0,0,0},
0bd6d68e 252 {"time",timeCommand,1,"rR",0,NULL,0,0,0,0,0},
253 {"bitop",bitopCommand,-4,"wm",0,NULL,2,-1,1,0,0},
254 {"bitcount",bitcountCommand,-2,"r",0,NULL,1,1,1,0,0}
e2641e09 255};
256
257/*============================ Utility functions ============================ */
258
9c104c68 259/* Low level logging. To use only for very big messages, otherwise
260 * redisLog() is to prefer. */
261void redisLogRaw(int level, const char *msg) {
e1a586ee
JH
262 const int syslogLevelMap[] = { LOG_DEBUG, LOG_INFO, LOG_NOTICE, LOG_WARNING };
263 const char *c = ".-*#";
e2641e09 264 FILE *fp;
23072961 265 char buf[64];
996d503d 266 int rawmode = (level & REDIS_LOG_RAW);
23072961 267
996d503d 268 level &= 0xff; /* clear flags */
23072961 269 if (level < server.verbosity) return;
e2641e09 270
271 fp = (server.logfile == NULL) ? stdout : fopen(server.logfile,"a");
272 if (!fp) return;
273
996d503d 274 if (rawmode) {
275 fprintf(fp,"%s",msg);
276 } else {
9a322ab7 277 int off;
278 struct timeval tv;
279
280 gettimeofday(&tv,NULL);
281 off = strftime(buf,sizeof(buf),"%d %b %H:%M:%S.",localtime(&tv.tv_sec));
282 snprintf(buf+off,sizeof(buf)-off,"%03d",(int)tv.tv_usec/1000);
996d503d 283 fprintf(fp,"[%d] %s %c %s\n",(int)getpid(),buf,c[level],msg);
284 }
e1a586ee
JH
285 fflush(fp);
286
e2641e09 287 if (server.logfile) fclose(fp);
e1a586ee
JH
288
289 if (server.syslog_enabled) syslog(syslogLevelMap[level], "%s", msg);
e2641e09 290}
291
9c104c68 292/* Like redisLogRaw() but with printf-alike support. This is the funciton that
293 * is used across the code. The raw version is only used in order to dump
294 * the INFO output on crash. */
295void redisLog(int level, const char *fmt, ...) {
296 va_list ap;
297 char msg[REDIS_MAX_LOGMSG_LEN];
298
996d503d 299 if ((level&0xff) < server.verbosity) return;
9c104c68 300
301 va_start(ap, fmt);
302 vsnprintf(msg, sizeof(msg), fmt, ap);
303 va_end(ap);
304
305 redisLogRaw(level,msg);
306}
307
a7d12cba 308/* Log a fixed message without printf-alike capabilities, in a way that is
309 * safe to call from a signal handler.
310 *
311 * We actually use this only for signals that are not fatal from the point
312 * of view of Redis. Signals that are going to kill the server anyway and
313 * where we need printf-alike features are served by redisLog(). */
314void redisLogFromHandler(int level, const char *msg) {
315 int fd;
316 char buf[64];
317
318 if ((level&0xff) < server.verbosity ||
319 (server.logfile == NULL && server.daemonize)) return;
320 fd = server.logfile ?
321 open(server.logfile, O_APPEND|O_CREAT|O_WRONLY, 0644) :
5471b8ba 322 STDOUT_FILENO;
a7d12cba 323 if (fd == -1) return;
324 ll2string(buf,sizeof(buf),getpid());
0b913c65 325 if (write(fd,"[",1) == -1) goto err;
326 if (write(fd,buf,strlen(buf)) == -1) goto err;
327 if (write(fd," | signal handler] (",20) == -1) goto err;
a7d12cba 328 ll2string(buf,sizeof(buf),time(NULL));
0b913c65 329 if (write(fd,buf,strlen(buf)) == -1) goto err;
330 if (write(fd,") ",2) == -1) goto err;
331 if (write(fd,msg,strlen(msg)) == -1) goto err;
332 if (write(fd,"\n",1) == -1) goto err;
333err:
5471b8ba 334 if (server.logfile) close(fd);
a7d12cba 335}
336
e2641e09 337/* Redis generally does not try to recover from out of memory conditions
338 * when allocating objects or strings, it is not clear if it will be possible
339 * to report this condition to the client since the networking layer itself
340 * is based on heap allocation for send buffers, so we simply abort.
341 * At least the code will be simpler to read... */
342void oom(const char *msg) {
343 redisLog(REDIS_WARNING, "%s: Out of memory\n",msg);
344 sleep(1);
345 abort();
346}
347
d9cb288c 348/* Return the UNIX time in microseconds */
349long long ustime(void) {
350 struct timeval tv;
351 long long ust;
352
353 gettimeofday(&tv, NULL);
354 ust = ((long long)tv.tv_sec)*1000000;
355 ust += tv.tv_usec;
356 return ust;
357}
358
2c2b2085 359/* Return the UNIX time in milliseconds */
360long long mstime(void) {
361 return ustime()/1000;
362}
363
2cbdab90 364/* After an RDB dump or AOF rewrite we exit from children using _exit() instead of
365 * exit(), because the latter may interact with the same file objects used by
366 * the parent process. However if we are testing the coverage normal exit() is
367 * used in order to obtain the right coverage information. */
368void exitFromChild(int retcode) {
369#ifdef COVERAGE_TEST
370 exit(retcode);
371#else
372 _exit(retcode);
373#endif
374}
375
e2641e09 376/*====================== Hash table type implementation ==================== */
377
378/* This is an hash table type that uses the SDS dynamic strings libary as
379 * keys and radis objects as values (objects can hold SDS strings,
380 * lists, sets). */
381
382void dictVanillaFree(void *privdata, void *val)
383{
384 DICT_NOTUSED(privdata);
385 zfree(val);
386}
387
388void dictListDestructor(void *privdata, void *val)
389{
390 DICT_NOTUSED(privdata);
391 listRelease((list*)val);
392}
393
394int dictSdsKeyCompare(void *privdata, const void *key1,
395 const void *key2)
396{
397 int l1,l2;
398 DICT_NOTUSED(privdata);
399
400 l1 = sdslen((sds)key1);
401 l2 = sdslen((sds)key2);
402 if (l1 != l2) return 0;
403 return memcmp(key1, key2, l1) == 0;
404}
405
1b1f47c9 406/* A case insensitive version used for the command lookup table. */
407int dictSdsKeyCaseCompare(void *privdata, const void *key1,
408 const void *key2)
409{
410 DICT_NOTUSED(privdata);
411
412 return strcasecmp(key1, key2) == 0;
413}
414
e2641e09 415void dictRedisObjectDestructor(void *privdata, void *val)
416{
417 DICT_NOTUSED(privdata);
418
419 if (val == NULL) return; /* Values of swapped out keys as set to NULL */
420 decrRefCount(val);
421}
422
423void dictSdsDestructor(void *privdata, void *val)
424{
425 DICT_NOTUSED(privdata);
426
427 sdsfree(val);
428}
429
430int dictObjKeyCompare(void *privdata, const void *key1,
431 const void *key2)
432{
433 const robj *o1 = key1, *o2 = key2;
434 return dictSdsKeyCompare(privdata,o1->ptr,o2->ptr);
435}
436
437unsigned int dictObjHash(const void *key) {
438 const robj *o = key;
439 return dictGenHashFunction(o->ptr, sdslen((sds)o->ptr));
440}
441
442unsigned int dictSdsHash(const void *key) {
443 return dictGenHashFunction((unsigned char*)key, sdslen((char*)key));
444}
445
1b1f47c9 446unsigned int dictSdsCaseHash(const void *key) {
447 return dictGenCaseHashFunction((unsigned char*)key, sdslen((char*)key));
448}
449
e2641e09 450int dictEncObjKeyCompare(void *privdata, const void *key1,
451 const void *key2)
452{
453 robj *o1 = (robj*) key1, *o2 = (robj*) key2;
454 int cmp;
455
456 if (o1->encoding == REDIS_ENCODING_INT &&
457 o2->encoding == REDIS_ENCODING_INT)
458 return o1->ptr == o2->ptr;
459
460 o1 = getDecodedObject(o1);
461 o2 = getDecodedObject(o2);
462 cmp = dictSdsKeyCompare(privdata,o1->ptr,o2->ptr);
463 decrRefCount(o1);
464 decrRefCount(o2);
465 return cmp;
466}
467
468unsigned int dictEncObjHash(const void *key) {
469 robj *o = (robj*) key;
470
471 if (o->encoding == REDIS_ENCODING_RAW) {
472 return dictGenHashFunction(o->ptr, sdslen((sds)o->ptr));
473 } else {
474 if (o->encoding == REDIS_ENCODING_INT) {
475 char buf[32];
476 int len;
477
478 len = ll2string(buf,32,(long)o->ptr);
479 return dictGenHashFunction((unsigned char*)buf, len);
480 } else {
481 unsigned int hash;
482
483 o = getDecodedObject(o);
484 hash = dictGenHashFunction(o->ptr, sdslen((sds)o->ptr));
485 decrRefCount(o);
486 return hash;
487 }
488 }
489}
490
4dd444bb 491/* Sets type hash table */
e2641e09 492dictType setDictType = {
493 dictEncObjHash, /* hash function */
494 NULL, /* key dup */
495 NULL, /* val dup */
496 dictEncObjKeyCompare, /* key compare */
497 dictRedisObjectDestructor, /* key destructor */
498 NULL /* val destructor */
499};
500
501/* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
502dictType zsetDictType = {
503 dictEncObjHash, /* hash function */
504 NULL, /* key dup */
505 NULL, /* val dup */
506 dictEncObjKeyCompare, /* key compare */
507 dictRedisObjectDestructor, /* key destructor */
69ef89f2 508 NULL /* val destructor */
e2641e09 509};
510
511/* Db->dict, keys are sds strings, vals are Redis objects. */
512dictType dbDictType = {
513 dictSdsHash, /* hash function */
514 NULL, /* key dup */
515 NULL, /* val dup */
516 dictSdsKeyCompare, /* key compare */
517 dictSdsDestructor, /* key destructor */
518 dictRedisObjectDestructor /* val destructor */
519};
520
521/* Db->expires */
522dictType keyptrDictType = {
523 dictSdsHash, /* hash function */
524 NULL, /* key dup */
525 NULL, /* val dup */
526 dictSdsKeyCompare, /* key compare */
527 NULL, /* key destructor */
528 NULL /* val destructor */
529};
530
1b1f47c9 531/* Command table. sds string -> command struct pointer. */
532dictType commandTableDictType = {
533 dictSdsCaseHash, /* hash function */
534 NULL, /* key dup */
535 NULL, /* val dup */
536 dictSdsKeyCaseCompare, /* key compare */
537 dictSdsDestructor, /* key destructor */
538 NULL /* val destructor */
539};
540
e2641e09 541/* Hash type hash table (note that small hashes are represented with zimpaps) */
542dictType hashDictType = {
543 dictEncObjHash, /* hash function */
544 NULL, /* key dup */
545 NULL, /* val dup */
546 dictEncObjKeyCompare, /* key compare */
547 dictRedisObjectDestructor, /* key destructor */
548 dictRedisObjectDestructor /* val destructor */
549};
550
551/* Keylist hash table type has unencoded redis objects as keys and
552 * lists as values. It's used for blocking operations (BLPOP) and to
553 * map swapped keys to a list of clients waiting for this keys to be loaded. */
554dictType keylistDictType = {
555 dictObjHash, /* hash function */
556 NULL, /* key dup */
557 NULL, /* val dup */
558 dictObjKeyCompare, /* key compare */
559 dictRedisObjectDestructor, /* key destructor */
560 dictListDestructor /* val destructor */
561};
562
ecc91094 563/* Cluster nodes hash table, mapping nodes addresses 1.2.3.4:6379 to
564 * clusterNode structures. */
565dictType clusterNodesDictType = {
566 dictSdsHash, /* hash function */
567 NULL, /* key dup */
568 NULL, /* val dup */
569 dictSdsKeyCompare, /* key compare */
570 dictSdsDestructor, /* key destructor */
571 NULL /* val destructor */
572};
573
e2641e09 574int htNeedsResize(dict *dict) {
575 long long size, used;
576
577 size = dictSlots(dict);
578 used = dictSize(dict);
579 return (size && used && size > DICT_HT_INITIAL_SIZE &&
580 (used*100/size < REDIS_HT_MINFILL));
581}
582
583/* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
584 * we resize the hash table to save memory */
585void tryResizeHashTables(void) {
586 int j;
587
588 for (j = 0; j < server.dbnum; j++) {
589 if (htNeedsResize(server.db[j].dict))
590 dictResize(server.db[j].dict);
591 if (htNeedsResize(server.db[j].expires))
592 dictResize(server.db[j].expires);
593 }
594}
595
596/* Our hash table implementation performs rehashing incrementally while
597 * we write/read from the hash table. Still if the server is idle, the hash
598 * table will use two tables for a long time. So we try to use 1 millisecond
599 * of CPU time at every serverCron() loop in order to rehash some key. */
600void incrementallyRehash(void) {
601 int j;
602
603 for (j = 0; j < server.dbnum; j++) {
61daf891 604 /* Keys dictionary */
e2641e09 605 if (dictIsRehashing(server.db[j].dict)) {
606 dictRehashMilliseconds(server.db[j].dict,1);
607 break; /* already used our millisecond for this loop... */
608 }
61daf891 609 /* Expires */
610 if (dictIsRehashing(server.db[j].expires)) {
611 dictRehashMilliseconds(server.db[j].expires,1);
612 break; /* already used our millisecond for this loop... */
613 }
e2641e09 614 }
615}
616
617/* This function is called once a background process of some kind terminates,
618 * as we want to avoid resizing the hash tables when there is a child in order
619 * to play well with copy-on-write (otherwise when a resize happens lots of
620 * memory pages are copied). The goal of this function is to update the ability
621 * for dict.c to resize the hash tables accordingly to the fact we have o not
622 * running childs. */
623void updateDictResizePolicy(void) {
f48cd4b9 624 if (server.rdb_child_pid == -1 && server.aof_child_pid == -1)
e2641e09 625 dictEnableResize();
626 else
627 dictDisableResize();
628}
629
630/* ======================= Cron: called every 100 ms ======================== */
631
bcf2995c 632/* Try to expire a few timed out keys. The algorithm used is adaptive and
633 * will use few CPU cycles if there are few expiring keys, otherwise
634 * it will get more aggressive to avoid that too much memory is used by
635 * keys that can be removed from the keyspace. */
636void activeExpireCycle(void) {
b3624f5a 637 int j, iteration = 0;
61daf891 638 long long start = ustime(), timelimit;
94343492 639
640 /* We can use at max REDIS_EXPIRELOOKUPS_TIME_PERC percentage of CPU time
641 * per iteration. Since this function gets called with a frequency of
642 * REDIS_HZ times per second, the following is the max amount of
61daf891 643 * microseconds we can spend in this function. */
644 timelimit = 1000000*REDIS_EXPIRELOOKUPS_TIME_PERC/REDIS_HZ/100;
94343492 645 if (timelimit <= 0) timelimit = 1;
bcf2995c 646
647 for (j = 0; j < server.dbnum; j++) {
b3624f5a 648 int expired;
bcf2995c 649 redisDb *db = server.db+j;
650
651 /* Continue to expire if at the end of the cycle more than 25%
652 * of the keys were expired. */
653 do {
61daf891 654 unsigned long num = dictSize(db->expires);
655 unsigned long slots = dictSlots(db->expires);
4be855e7 656 long long now = mstime();
bcf2995c 657
61daf891 658 /* When there are less than 1% filled slots getting random
659 * keys is expensive, so stop here waiting for better times...
660 * The dictionary will be resized asap. */
661 if (num && slots > DICT_HT_INITIAL_SIZE &&
662 (num*100/slots < 1)) break;
663
b3624f5a 664 /* The main collection cycle. Sample random keys among keys
665 * with an expire set, checking for expired ones. */
bcf2995c 666 expired = 0;
667 if (num > REDIS_EXPIRELOOKUPS_PER_CRON)
668 num = REDIS_EXPIRELOOKUPS_PER_CRON;
669 while (num--) {
670 dictEntry *de;
4be855e7 671 long long t;
bcf2995c 672
673 if ((de = dictGetRandomKey(db->expires)) == NULL) break;
4be855e7 674 t = dictGetSignedIntegerVal(de);
bcf2995c 675 if (now > t) {
c0ba9ebe 676 sds key = dictGetKey(de);
bcf2995c 677 robj *keyobj = createStringObject(key,sdslen(key));
678
679 propagateExpire(db,keyobj);
680 dbDelete(db,keyobj);
681 decrRefCount(keyobj);
682 expired++;
683 server.stat_expiredkeys++;
684 }
685 }
1dcc95d0 686 /* We can't block forever here even if there are many keys to
687 * expire. So after a given amount of milliseconds return to the
688 * caller waiting for the other active expire cycle. */
689 iteration++;
b3624f5a 690 if ((iteration & 0xf) == 0 && /* check once every 16 cycles. */
61daf891 691 (ustime()-start) > timelimit) return;
bcf2995c 692 } while (expired > REDIS_EXPIRELOOKUPS_PER_CRON/4);
693 }
694}
695
165346ca 696void updateLRUClock(void) {
d1949054 697 server.lruclock = (server.unixtime/REDIS_LRU_CLOCK_RESOLUTION) &
165346ca 698 REDIS_LRU_CLOCK_MAX;
699}
bcf2995c 700
250e7f69 701
702/* Add a sample to the operations per second array of samples. */
703void trackOperationsPerSecond(void) {
704 long long t = mstime() - server.ops_sec_last_sample_time;
705 long long ops = server.stat_numcommands - server.ops_sec_last_sample_ops;
706 long long ops_sec;
707
708 ops_sec = t > 0 ? (ops*1000/t) : 0;
709
710 server.ops_sec_samples[server.ops_sec_idx] = ops_sec;
711 server.ops_sec_idx = (server.ops_sec_idx+1) % REDIS_OPS_SEC_SAMPLES;
712 server.ops_sec_last_sample_time = mstime();
713 server.ops_sec_last_sample_ops = server.stat_numcommands;
714}
715
716/* Return the mean of all the samples. */
717long long getOperationsPerSecond(void) {
718 int j;
719 long long sum = 0;
720
721 for (j = 0; j < REDIS_OPS_SEC_SAMPLES; j++)
722 sum += server.ops_sec_samples[j];
723 return sum / REDIS_OPS_SEC_SAMPLES;
724}
725
c9d3dda2 726/* Check for timeouts. Returns non-zero if the client was terminated */
727int clientsCronHandleTimeout(redisClient *c) {
ae22bf1e 728 time_t now = server.unixtime;
d19015be 729
730 if (server.maxidletime &&
731 !(c->flags & REDIS_SLAVE) && /* no timeout for slaves */
732 !(c->flags & REDIS_MASTER) && /* no timeout for masters */
733 !(c->flags & REDIS_BLOCKED) && /* no timeout for BLPOP */
734 dictSize(c->pubsub_channels) == 0 && /* no timeout for pubsub */
735 listLength(c->pubsub_patterns) == 0 &&
736 (now - c->lastinteraction > server.maxidletime))
737 {
738 redisLog(REDIS_VERBOSE,"Closing idle client");
739 freeClient(c);
c9d3dda2 740 return 1;
d19015be 741 } else if (c->flags & REDIS_BLOCKED) {
742 if (c->bpop.timeout != 0 && c->bpop.timeout < now) {
743 addReply(c,shared.nullmultibulk);
744 unblockClientWaitingData(c);
745 }
746 }
c9d3dda2 747 return 0;
d19015be 748}
749
ae22bf1e 750/* The client query buffer is an sds.c string that can end with a lot of
c9d3dda2 751 * free space not used, this function reclaims space if needed.
752 *
753 * The funciton always returns 0 as it never terminates the client. */
754int clientsCronResizeQueryBuffer(redisClient *c) {
ae22bf1e 755 size_t querybuf_size = sdsAllocSize(c->querybuf);
756 time_t idletime = server.unixtime - c->lastinteraction;
757
758 /* There are two conditions to resize the query buffer:
759 * 1) Query buffer is > BIG_ARG and too big for latest peak.
760 * 2) Client is inactive and the buffer is bigger than 1k. */
761 if (((querybuf_size > REDIS_MBULK_BIG_ARG) &&
762 (querybuf_size/(c->querybuf_peak+1)) > 2) ||
763 (querybuf_size > 1024 && idletime > 2))
764 {
765 /* Only resize the query buffer if it is actually wasting space. */
766 if (sdsavail(c->querybuf) > 1024) {
767 c->querybuf = sdsRemoveFreeSpace(c->querybuf);
768 }
769 }
770 /* Reset the peak again to capture the peak memory usage in the next
771 * cycle. */
772 c->querybuf_peak = 0;
c9d3dda2 773 return 0;
ae22bf1e 774}
775
d19015be 776void clientsCron(void) {
94343492 777 /* Make sure to process at least 1/(REDIS_HZ*10) of clients per call.
778 * Since this function is called REDIS_HZ times per second we are sure that
d19015be 779 * in the worst case we process all the clients in 10 seconds.
780 * In normal conditions (a reasonable number of clients) we process
781 * all the clients in a shorter time. */
ae22bf1e 782 int numclients = listLength(server.clients);
94343492 783 int iterations = numclients/(REDIS_HZ*10);
d19015be 784
ae22bf1e 785 if (iterations < 50)
786 iterations = (numclients < 50) ? numclients : 50;
d19015be 787 while(listLength(server.clients) && iterations--) {
788 redisClient *c;
789 listNode *head;
790
791 /* Rotate the list, take the current head, process.
792 * This way if the client must be removed from the list it's the
793 * first element and we don't incur into O(N) computation. */
794 listRotate(server.clients);
795 head = listFirst(server.clients);
796 c = listNodeValue(head);
c9d3dda2 797 /* The following functions do different service checks on the client.
798 * The protocol is that they return non-zero if the client was
799 * terminated. */
800 if (clientsCronHandleTimeout(c)) continue;
801 if (clientsCronResizeQueryBuffer(c)) continue;
d19015be 802 }
803}
804
94343492 805/* This is our timer interrupt, called REDIS_HZ times per second.
806 * Here is where we do a number of things that need to be done asynchronously.
807 * For instance:
808 *
809 * - Active expired keys collection (it is also performed in a lazy way on
810 * lookup).
811 * - Software watchdong.
812 * - Update some statistic.
813 * - Incremental rehashing of the DBs hash tables.
814 * - Triggering BGSAVE / AOF rewrite, and handling of terminated children.
815 * - Clients timeout of differnet kinds.
816 * - Replication reconnection.
817 * - Many more...
818 *
819 * Everything directly called here will be called REDIS_HZ times per second,
820 * so in order to throttle execution of things we want to do less frequently
821 * a macro is used: run_with_period(milliseconds) { .... }
822 */
823
e2641e09 824int serverCron(struct aeEventLoop *eventLoop, long long id, void *clientData) {
6b5daa2d 825 int j;
e2641e09 826 REDIS_NOTUSED(eventLoop);
827 REDIS_NOTUSED(id);
828 REDIS_NOTUSED(clientData);
829
39bd025c 830 /* Software watchdog: deliver the SIGALRM that will reach the signal
831 * handler if we don't return here fast enough. */
832 if (server.watchdog_period) watchdogScheduleSignal(server.watchdog_period);
833
e2641e09 834 /* We take a cached value of the unix time in the global state because
835 * with virtual memory and aging there is to store the current time
836 * in objects at every object access, and accuracy is not needed.
837 * To access a global var is faster than calling time(NULL) */
838 server.unixtime = time(NULL);
4f06867a 839
94343492 840 run_with_period(100) trackOperationsPerSecond();
250e7f69 841
ef59a8bc 842 /* We have just 22 bits per object for LRU information.
165346ca 843 * So we use an (eventually wrapping) LRU clock with 10 seconds resolution.
844 * 2^22 bits with 10 seconds resoluton is more or less 1.5 years.
e2641e09 845 *
165346ca 846 * Note that even if this will wrap after 1.5 years it's not a problem,
ef59a8bc 847 * everything will still work but just some object will appear younger
165346ca 848 * to Redis. But for this to happen a given object should never be touched
849 * for 1.5 years.
850 *
851 * Note that you can change the resolution altering the
852 * REDIS_LRU_CLOCK_RESOLUTION define.
e2641e09 853 */
165346ca 854 updateLRUClock();
e2641e09 855
17b24ff3 856 /* Record the max memory used since the server was started. */
857 if (zmalloc_used_memory() > server.stat_peak_memory)
858 server.stat_peak_memory = zmalloc_used_memory();
859
e2641e09 860 /* We received a SIGTERM, shutting down here in a safe way, as it is
861 * not ok doing so inside the signal handler. */
862 if (server.shutdown_asap) {
4ab8695d 863 if (prepareForShutdown(0) == REDIS_OK) exit(0);
e2641e09 864 redisLog(REDIS_WARNING,"SIGTERM received but errors trying to shut down the server, check the logs for more information");
865 }
866
867 /* Show some info about non-empty databases */
94343492 868 run_with_period(5000) {
869 for (j = 0; j < server.dbnum; j++) {
870 long long size, used, vkeys;
871
872 size = dictSlots(server.db[j].dict);
873 used = dictSize(server.db[j].dict);
874 vkeys = dictSize(server.db[j].expires);
875 if (used || vkeys) {
876 redisLog(REDIS_VERBOSE,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j,used,vkeys,size);
877 /* dictPrintStats(server.dict); */
878 }
e2641e09 879 }
880 }
881
882 /* We don't want to resize the hash tables while a bacground saving
883 * is in progress: the saving child is created using fork() that is
884 * implemented with a copy-on-write semantic in most modern systems, so
885 * if we resize the HT while there is the saving child at work actually
886 * a lot of memory movements in the parent will cause a lot of pages
887 * copied. */
f48cd4b9 888 if (server.rdb_child_pid == -1 && server.aof_child_pid == -1) {
61daf891 889 tryResizeHashTables();
e2641e09 890 if (server.activerehashing) incrementallyRehash();
891 }
892
893 /* Show information about connected clients */
6b5daa2d 894 if (!server.sentinel_mode) {
895 run_with_period(5000) {
896 redisLog(REDIS_VERBOSE,
897 "%d clients connected (%d slaves), %zu bytes in use",
898 listLength(server.clients)-listLength(server.slaves),
899 listLength(server.slaves),
900 zmalloc_used_memory());
901 }
e2641e09 902 }
903
d19015be 904 /* We need to do a few operations on clients asynchronously. */
905 clientsCron();
e2641e09 906
b333e239 907 /* Start a scheduled AOF rewrite if this was requested by the user while
908 * a BGSAVE was in progress. */
f48cd4b9 909 if (server.rdb_child_pid == -1 && server.aof_child_pid == -1 &&
2c915bcf 910 server.aof_rewrite_scheduled)
b333e239 911 {
912 rewriteAppendOnlyFileBackground();
913 }
914
f03fe802 915 /* Check if a background saving or AOF rewrite in progress terminated. */
f48cd4b9 916 if (server.rdb_child_pid != -1 || server.aof_child_pid != -1) {
e2641e09 917 int statloc;
918 pid_t pid;
919
920 if ((pid = wait3(&statloc,WNOHANG,NULL)) != 0) {
36c17a53 921 int exitcode = WEXITSTATUS(statloc);
922 int bysignal = 0;
923
924 if (WIFSIGNALED(statloc)) bysignal = WTERMSIG(statloc);
925
f48cd4b9 926 if (pid == server.rdb_child_pid) {
36c17a53 927 backgroundSaveDoneHandler(exitcode,bysignal);
e2641e09 928 } else {
36c17a53 929 backgroundRewriteDoneHandler(exitcode,bysignal);
e2641e09 930 }
931 updateDictResizePolicy();
932 }
c9d0c362 933 } else {
b333e239 934 /* If there is not a background saving/rewrite in progress check if
935 * we have to save/rewrite now */
e2641e09 936 for (j = 0; j < server.saveparamslen; j++) {
937 struct saveparam *sp = server.saveparams+j;
938
939 if (server.dirty >= sp->changes &&
d1949054 940 server.unixtime-server.lastsave > sp->seconds) {
e2641e09 941 redisLog(REDIS_NOTICE,"%d changes in %d seconds. Saving...",
942 sp->changes, sp->seconds);
f48cd4b9 943 rdbSaveBackground(server.rdb_filename);
e2641e09 944 break;
945 }
946 }
b333e239 947
948 /* Trigger an AOF rewrite if needed */
f48cd4b9 949 if (server.rdb_child_pid == -1 &&
ff2145ad 950 server.aof_child_pid == -1 &&
2c915bcf 951 server.aof_rewrite_perc &&
952 server.aof_current_size > server.aof_rewrite_min_size)
b333e239 953 {
2c915bcf 954 long long base = server.aof_rewrite_base_size ?
955 server.aof_rewrite_base_size : 1;
956 long long growth = (server.aof_current_size*100/base) - 100;
957 if (growth >= server.aof_rewrite_perc) {
19b46c9a 958 redisLog(REDIS_NOTICE,"Starting automatic rewriting of AOF on %lld%% growth",growth);
b333e239 959 rewriteAppendOnlyFileBackground();
960 }
961 }
e2641e09 962 }
963
db3c2a4f 964
965 /* If we postponed an AOF buffer flush, let's try to do it every time the
966 * cron function is called. */
967 if (server.aof_flush_postponed_start) flushAppendOnlyFile(0);
968
bcf2995c 969 /* Expire a few keys per cycle, only if this is a master.
970 * On slaves we wait for DEL operations synthesized by the master
971 * in order to guarantee a strict consistency. */
972 if (server.masterhost == NULL) activeExpireCycle();
e2641e09 973
8c43e663 974 /* Close clients that need to be closed asynchronous */
975 freeClientsInAsyncFreeQueue();
976
f4aa600b 977 /* Replication cron function -- used to reconnect to master and
978 * to detect transfer failures. */
94343492 979 run_with_period(1000) replicationCron();
f4aa600b 980
ecc91094 981 /* Run other sub-systems specific cron jobs */
94343492 982 run_with_period(1000) {
983 if (server.cluster_enabled) clusterCron();
984 }
ecc91094 985
6b5daa2d 986 /* Run the sentinel timer if we are in sentinel mode. */
987 run_with_period(100) {
988 if (server.sentinel_mode) sentinelTimer();
989 }
990
89a1433e 991 server.cronloops++;
94343492 992 return 1000/REDIS_HZ;
e2641e09 993}
994
995/* This function gets called every time Redis is entering the
996 * main loop of the event driven library, that is, before to sleep
997 * for ready file descriptors. */
998void beforeSleep(struct aeEventLoop *eventLoop) {
999 REDIS_NOTUSED(eventLoop);
a4ce7581
PN
1000 listNode *ln;
1001 redisClient *c;
e2641e09 1002
a4ce7581
PN
1003 /* Try to process pending commands for clients that were just unblocked. */
1004 while (listLength(server.unblocked_clients)) {
1005 ln = listFirst(server.unblocked_clients);
1006 redisAssert(ln != NULL);
1007 c = ln->value;
1008 listDelNode(server.unblocked_clients,ln);
3bcffcbe 1009 c->flags &= ~REDIS_UNBLOCKED;
a4ce7581
PN
1010
1011 /* Process remaining data in the input buffer. */
00010fa9 1012 if (c->querybuf && sdslen(c->querybuf) > 0) {
1013 server.current_client = c;
a4ce7581 1014 processInputBuffer(c);
00010fa9 1015 server.current_client = NULL;
1016 }
a4ce7581
PN
1017 }
1018
e2641e09 1019 /* Write the AOF buffer on disk */
db3c2a4f 1020 flushAppendOnlyFile(0);
e2641e09 1021}
1022
1023/* =========================== Server initialization ======================== */
1024
1025void createSharedObjects(void) {
1026 int j;
1027
1028 shared.crlf = createObject(REDIS_STRING,sdsnew("\r\n"));
1029 shared.ok = createObject(REDIS_STRING,sdsnew("+OK\r\n"));
1030 shared.err = createObject(REDIS_STRING,sdsnew("-ERR\r\n"));
1031 shared.emptybulk = createObject(REDIS_STRING,sdsnew("$0\r\n\r\n"));
1032 shared.czero = createObject(REDIS_STRING,sdsnew(":0\r\n"));
1033 shared.cone = createObject(REDIS_STRING,sdsnew(":1\r\n"));
1034 shared.cnegone = createObject(REDIS_STRING,sdsnew(":-1\r\n"));
1035 shared.nullbulk = createObject(REDIS_STRING,sdsnew("$-1\r\n"));
1036 shared.nullmultibulk = createObject(REDIS_STRING,sdsnew("*-1\r\n"));
1037 shared.emptymultibulk = createObject(REDIS_STRING,sdsnew("*0\r\n"));
1038 shared.pong = createObject(REDIS_STRING,sdsnew("+PONG\r\n"));
1039 shared.queued = createObject(REDIS_STRING,sdsnew("+QUEUED\r\n"));
1040 shared.wrongtypeerr = createObject(REDIS_STRING,sdsnew(
1041 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1042 shared.nokeyerr = createObject(REDIS_STRING,sdsnew(
1043 "-ERR no such key\r\n"));
1044 shared.syntaxerr = createObject(REDIS_STRING,sdsnew(
1045 "-ERR syntax error\r\n"));
1046 shared.sameobjecterr = createObject(REDIS_STRING,sdsnew(
1047 "-ERR source and destination objects are the same\r\n"));
1048 shared.outofrangeerr = createObject(REDIS_STRING,sdsnew(
1049 "-ERR index out of range\r\n"));
7229d60d 1050 shared.noscripterr = createObject(REDIS_STRING,sdsnew(
1051 "-NOSCRIPT No matching script. Please use EVAL.\r\n"));
97e7f8ae 1052 shared.loadingerr = createObject(REDIS_STRING,sdsnew(
1053 "-LOADING Redis is loading the dataset in memory\r\n"));
115e3ff3 1054 shared.slowscripterr = createObject(REDIS_STRING,sdsnew(
4ab8695d 1055 "-BUSY Redis is busy running a script. You can only call SCRIPT KILL or SHUTDOWN NOSAVE.\r\n"));
ae62d29d 1056 shared.masterdownerr = createObject(REDIS_STRING,sdsnew(
1057 "-MASTERDOWN Link with MASTER is down and slave-serve-stale-data is set to 'no'.\r\n"));
c25e7eaf 1058 shared.bgsaveerr = createObject(REDIS_STRING,sdsnew(
f3fd419f 1059 "-MISCONF Redis is configured to save RDB snapshots, but is currently not able to persist on disk. Commands that may modify the data set are disabled. Please check Redis logs for details about the error.\r\n"));
1060 shared.roslaveerr = createObject(REDIS_STRING,sdsnew(
1061 "-READONLY You can't write against a read only slave.\r\n"));
b22eab8f 1062 shared.oomerr = createObject(REDIS_STRING,sdsnew(
1063 "-OOM command not allowed when used memory > 'maxmemory'.\r\n"));
e2641e09 1064 shared.space = createObject(REDIS_STRING,sdsnew(" "));
1065 shared.colon = createObject(REDIS_STRING,sdsnew(":"));
1066 shared.plus = createObject(REDIS_STRING,sdsnew("+"));
f892797e
JJ
1067
1068 for (j = 0; j < REDIS_SHARED_SELECT_CMDS; j++) {
1069 shared.select[j] = createObject(REDIS_STRING,
1070 sdscatprintf(sdsempty(),"select %d\r\n", j));
1071 }
e2641e09 1072 shared.messagebulk = createStringObject("$7\r\nmessage\r\n",13);
1073 shared.pmessagebulk = createStringObject("$8\r\npmessage\r\n",14);
1074 shared.subscribebulk = createStringObject("$9\r\nsubscribe\r\n",15);
1075 shared.unsubscribebulk = createStringObject("$11\r\nunsubscribe\r\n",18);
1076 shared.psubscribebulk = createStringObject("$10\r\npsubscribe\r\n",17);
1077 shared.punsubscribebulk = createStringObject("$12\r\npunsubscribe\r\n",19);
355f8591 1078 shared.del = createStringObject("DEL",3);
c1db214e 1079 shared.rpop = createStringObject("RPOP",4);
1080 shared.lpop = createStringObject("LPOP",4);
e2641e09 1081 for (j = 0; j < REDIS_SHARED_INTEGERS; j++) {
1082 shared.integers[j] = createObject(REDIS_STRING,(void*)(long)j);
1083 shared.integers[j]->encoding = REDIS_ENCODING_INT;
1084 }
355f8591 1085 for (j = 0; j < REDIS_SHARED_BULKHDR_LEN; j++) {
1086 shared.mbulkhdr[j] = createObject(REDIS_STRING,
1087 sdscatprintf(sdsempty(),"*%d\r\n",j));
1088 shared.bulkhdr[j] = createObject(REDIS_STRING,
1089 sdscatprintf(sdsempty(),"$%d\r\n",j));
1090 }
e2641e09 1091}
1092
1093void initServerConfig() {
91d664d6 1094 getRandomHexChars(server.runid,REDIS_RUN_ID_SIZE);
1095 server.runid[REDIS_RUN_ID_SIZE] = '\0';
75eaac5c 1096 server.arch_bits = (sizeof(long) == 8) ? 64 : 32;
e2641e09 1097 server.port = REDIS_SERVERPORT;
a5639e7d 1098 server.bindaddr = NULL;
5d10923f 1099 server.unixsocket = NULL;
85238765 1100 server.unixsocketperm = 0;
a5639e7d
PN
1101 server.ipfd = -1;
1102 server.sofd = -1;
1103 server.dbnum = REDIS_DEFAULT_DBNUM;
c6f9ee88 1104 server.verbosity = REDIS_NOTICE;
e2641e09 1105 server.maxidletime = REDIS_MAXIDLETIME;
becf5fdb 1106 server.client_max_querybuf_len = REDIS_MAX_QUERYBUF_LEN;
e2641e09 1107 server.saveparams = NULL;
97e7f8ae 1108 server.loading = 0;
e2641e09 1109 server.logfile = NULL; /* NULL = log on standard output */
e1a586ee
JH
1110 server.syslog_enabled = 0;
1111 server.syslog_ident = zstrdup("redis");
1112 server.syslog_facility = LOG_LOCAL0;
e2641e09 1113 server.daemonize = 0;
e394114d 1114 server.aof_state = REDIS_AOF_OFF;
2c915bcf 1115 server.aof_fsync = AOF_FSYNC_EVERYSEC;
1116 server.aof_no_fsync_on_rewrite = 0;
1117 server.aof_rewrite_perc = REDIS_AOF_REWRITE_PERC;
1118 server.aof_rewrite_min_size = REDIS_AOF_REWRITE_MIN_SIZE;
1119 server.aof_rewrite_base_size = 0;
1120 server.aof_rewrite_scheduled = 0;
ff2145ad 1121 server.aof_last_fsync = time(NULL);
33e1db36 1122 server.aof_rewrite_time_last = -1;
1123 server.aof_rewrite_time_start = -1;
48553a29 1124 server.aof_lastbgrewrite_status = REDIS_OK;
c1d01b3c 1125 server.aof_delayed_fsync = 0;
ff2145ad 1126 server.aof_fd = -1;
1127 server.aof_selected_db = -1; /* Make sure the first time will not match */
db3c2a4f 1128 server.aof_flush_postponed_start = 0;
e2641e09 1129 server.pidfile = zstrdup("/var/run/redis.pid");
f48cd4b9 1130 server.rdb_filename = zstrdup("dump.rdb");
2c915bcf 1131 server.aof_filename = zstrdup("appendonly.aof");
e2641e09 1132 server.requirepass = NULL;
f48cd4b9 1133 server.rdb_compression = 1;
84bcd3aa 1134 server.rdb_checksum = 1;
e2641e09 1135 server.activerehashing = 1;
58732c23 1136 server.maxclients = REDIS_MAX_CLIENTS;
5fa95ad7 1137 server.bpop_blocked_clients = 0;
e2641e09 1138 server.maxmemory = 0;
165346ca 1139 server.maxmemory_policy = REDIS_MAXMEMORY_VOLATILE_LRU;
1140 server.maxmemory_samples = 3;
ebd85e9a
PN
1141 server.hash_max_ziplist_entries = REDIS_HASH_MAX_ZIPLIST_ENTRIES;
1142 server.hash_max_ziplist_value = REDIS_HASH_MAX_ZIPLIST_VALUE;
e2641e09 1143 server.list_max_ziplist_entries = REDIS_LIST_MAX_ZIPLIST_ENTRIES;
1144 server.list_max_ziplist_value = REDIS_LIST_MAX_ZIPLIST_VALUE;
96ffb2fe 1145 server.set_max_intset_entries = REDIS_SET_MAX_INTSET_ENTRIES;
3ea204e1
PN
1146 server.zset_max_ziplist_entries = REDIS_ZSET_MAX_ZIPLIST_ENTRIES;
1147 server.zset_max_ziplist_value = REDIS_ZSET_MAX_ZIPLIST_VALUE;
e2641e09 1148 server.shutdown_asap = 0;
aeecbdfa 1149 server.repl_ping_slave_period = REDIS_REPL_PING_SLAVE_PERIOD;
1150 server.repl_timeout = REDIS_REPL_TIMEOUT;
ecc91094 1151 server.cluster_enabled = 0;
ef21ab96 1152 server.cluster.configfile = zstrdup("nodes.conf");
4ab8695d 1153 server.lua_caller = NULL;
eeffcf38 1154 server.lua_time_limit = REDIS_LUA_TIME_LIMIT;
070e3945 1155 server.lua_client = NULL;
115e3ff3 1156 server.lua_timedout = 0;
e2641e09 1157
95506e46 1158 updateLRUClock();
e2641e09 1159 resetServerSaveParams();
1160
1161 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1162 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1163 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1164 /* Replication related */
e2641e09 1165 server.masterauth = NULL;
1166 server.masterhost = NULL;
1167 server.masterport = 6379;
1168 server.master = NULL;
1844f990 1169 server.repl_state = REDIS_REPL_NONE;
890a2ed9 1170 server.repl_syncio_timeout = REDIS_REPL_SYNCIO_TIMEOUT;
4ebfc455 1171 server.repl_serve_stale_data = 1;
f3fd419f 1172 server.repl_slave_ro = 1;
4b8c9661 1173 server.repl_down_since = time(NULL);
e2641e09 1174
7eac2a75 1175 /* Client output buffer limits */
1176 server.client_obuf_limits[REDIS_CLIENT_LIMIT_CLASS_NORMAL].hard_limit_bytes = 0;
1177 server.client_obuf_limits[REDIS_CLIENT_LIMIT_CLASS_NORMAL].soft_limit_bytes = 0;
1178 server.client_obuf_limits[REDIS_CLIENT_LIMIT_CLASS_NORMAL].soft_limit_seconds = 0;
c8a607f2 1179 server.client_obuf_limits[REDIS_CLIENT_LIMIT_CLASS_SLAVE].hard_limit_bytes = 1024*1024*256;
1180 server.client_obuf_limits[REDIS_CLIENT_LIMIT_CLASS_SLAVE].soft_limit_bytes = 1024*1024*64;
7eac2a75 1181 server.client_obuf_limits[REDIS_CLIENT_LIMIT_CLASS_SLAVE].soft_limit_seconds = 60;
c8a607f2 1182 server.client_obuf_limits[REDIS_CLIENT_LIMIT_CLASS_PUBSUB].hard_limit_bytes = 1024*1024*32;
1183 server.client_obuf_limits[REDIS_CLIENT_LIMIT_CLASS_PUBSUB].soft_limit_bytes = 1024*1024*8;
7eac2a75 1184 server.client_obuf_limits[REDIS_CLIENT_LIMIT_CLASS_PUBSUB].soft_limit_seconds = 60;
1185
e2641e09 1186 /* Double constants initialization */
1187 R_Zero = 0.0;
1188 R_PosInf = 1.0/R_Zero;
1189 R_NegInf = -1.0/R_Zero;
1190 R_Nan = R_Zero/R_Zero;
8d3e063a 1191
1192 /* Command table -- we intiialize it here as it is part of the
1193 * initial configuration, since command names may be changed via
1194 * redis.conf using the rename-command directive. */
1195 server.commands = dictCreate(&commandTableDictType,NULL);
1196 populateCommandTable();
1197 server.delCommand = lookupCommandByCString("del");
1198 server.multiCommand = lookupCommandByCString("multi");
eeb34eff 1199 server.lpushCommand = lookupCommandByCString("lpush");
daa70b17 1200
1201 /* Slow log */
1202 server.slowlog_log_slower_than = REDIS_SLOWLOG_LOG_SLOWER_THAN;
1203 server.slowlog_max_len = REDIS_SLOWLOG_MAX_LEN;
fa5af017 1204
39bd025c 1205 /* Debugging */
fa5af017 1206 server.assert_failed = "<no assertion failed>";
1207 server.assert_file = "<no file>";
1208 server.assert_line = 0;
1209 server.bug_report_start = 0;
39bd025c 1210 server.watchdog_period = 0;
e2641e09 1211}
1212
e074416b 1213/* This function will try to raise the max number of open files accordingly to
1214 * the configured max number of clients. It will also account for 32 additional
1215 * file descriptors as we need a few more for persistence, listening
1216 * sockets, log files and so forth.
1217 *
1218 * If it will not be possible to set the limit accordingly to the configured
1219 * max number of clients, the function will do the reverse setting
1220 * server.maxclients to the value that we can actually handle. */
1221void adjustOpenFilesLimit(void) {
1222 rlim_t maxfiles = server.maxclients+32;
1223 struct rlimit limit;
1224
e074416b 1225 if (getrlimit(RLIMIT_NOFILE,&limit) == -1) {
1226 redisLog(REDIS_WARNING,"Unable to obtain the current NOFILE limit (%s), assuming 1024 and setting the max clients configuration accordingly.",
1227 strerror(errno));
1228 server.maxclients = 1024-32;
1229 } else {
1230 rlim_t oldlimit = limit.rlim_cur;
1231
1232 /* Set the max number of files if the current limit is not enough
1233 * for our needs. */
1234 if (oldlimit < maxfiles) {
e7957ca6 1235 rlim_t f;
1236
1237 f = maxfiles;
1238 while(f > oldlimit) {
1239 limit.rlim_cur = f;
1240 limit.rlim_max = f;
1241 if (setrlimit(RLIMIT_NOFILE,&limit) != -1) break;
1242 f -= 128;
1243 }
1244 if (f < oldlimit) f = oldlimit;
1245 if (f != maxfiles) {
1246 server.maxclients = f-32;
e074416b 1247 redisLog(REDIS_WARNING,"Unable to set the max number of files limit to %d (%s), setting the max clients configuration to %d.",
1248 (int) maxfiles, strerror(errno), (int) server.maxclients);
1249 } else {
1250 redisLog(REDIS_NOTICE,"Max number of open files set to %d",
1251 (int) maxfiles);
1252 }
1253 }
1254 }
1255}
1256
e2641e09 1257void initServer() {
1258 int j;
1259
1260 signal(SIGHUP, SIG_IGN);
1261 signal(SIGPIPE, SIG_IGN);
633a9410 1262 setupSignalHandlers();
e2641e09 1263
e1a586ee
JH
1264 if (server.syslog_enabled) {
1265 openlog(server.syslog_ident, LOG_PID | LOG_NDELAY | LOG_NOWAIT,
1266 server.syslog_facility);
1267 }
1268
00010fa9 1269 server.current_client = NULL;
e2641e09 1270 server.clients = listCreate();
7eac2a75 1271 server.clients_to_close = listCreate();
e2641e09 1272 server.slaves = listCreate();
1273 server.monitors = listCreate();
a4ce7581 1274 server.unblocked_clients = listCreate();
cea8c5cd 1275
e2641e09 1276 createSharedObjects();
e074416b 1277 adjustOpenFilesLimit();
1278 server.el = aeCreateEventLoop(server.maxclients+1024);
e2641e09 1279 server.db = zmalloc(sizeof(redisDb)*server.dbnum);
68d6345d 1280
a53b4c24 1281 if (server.port != 0) {
68d6345d 1282 server.ipfd = anetTcpServer(server.neterr,server.port,server.bindaddr);
a53b4c24 1283 if (server.ipfd == ANET_ERR) {
eef17490 1284 redisLog(REDIS_WARNING, "Opening port %d: %s",
1285 server.port, server.neterr);
a53b4c24 1286 exit(1);
1287 }
a5639e7d 1288 }
5d10923f
PN
1289 if (server.unixsocket != NULL) {
1290 unlink(server.unixsocket); /* don't care if this fails */
85238765 1291 server.sofd = anetUnixServer(server.neterr,server.unixsocket,server.unixsocketperm);
a5639e7d
PN
1292 if (server.sofd == ANET_ERR) {
1293 redisLog(REDIS_WARNING, "Opening socket: %s", server.neterr);
1294 exit(1);
1295 }
c61e6925 1296 }
a5639e7d
PN
1297 if (server.ipfd < 0 && server.sofd < 0) {
1298 redisLog(REDIS_WARNING, "Configured to not listen anywhere, exiting.");
e2641e09 1299 exit(1);
1300 }
1301 for (j = 0; j < server.dbnum; j++) {
1302 server.db[j].dict = dictCreate(&dbDictType,NULL);
1303 server.db[j].expires = dictCreate(&keyptrDictType,NULL);
1304 server.db[j].blocking_keys = dictCreate(&keylistDictType,NULL);
1305 server.db[j].watched_keys = dictCreate(&keylistDictType,NULL);
e2641e09 1306 server.db[j].id = j;
1307 }
1308 server.pubsub_channels = dictCreate(&keylistDictType,NULL);
1309 server.pubsub_patterns = listCreate();
1310 listSetFreeMethod(server.pubsub_patterns,freePubsubPattern);
1311 listSetMatchMethod(server.pubsub_patterns,listMatchPubsubPattern);
1312 server.cronloops = 0;
f48cd4b9 1313 server.rdb_child_pid = -1;
ff2145ad 1314 server.aof_child_pid = -1;
47ca4b6e 1315 aofRewriteBufferReset();
ff2145ad 1316 server.aof_buf = sdsempty();
e2641e09 1317 server.lastsave = time(NULL);
33e1db36 1318 server.rdb_save_time_last = -1;
1319 server.rdb_save_time_start = -1;
e2641e09 1320 server.dirty = 0;
1321 server.stat_numcommands = 0;
1322 server.stat_numconnections = 0;
1323 server.stat_expiredkeys = 0;
f21779ff 1324 server.stat_evictedkeys = 0;
e2641e09 1325 server.stat_starttime = time(NULL);
53eeeaff 1326 server.stat_keyspace_misses = 0;
1327 server.stat_keyspace_hits = 0;
17b24ff3 1328 server.stat_peak_memory = 0;
615e414c 1329 server.stat_fork_time = 0;
3c95e721 1330 server.stat_rejected_conn = 0;
250e7f69 1331 memset(server.ops_sec_samples,0,sizeof(server.ops_sec_samples));
1332 server.ops_sec_idx = 0;
1333 server.ops_sec_last_sample_time = mstime();
1334 server.ops_sec_last_sample_ops = 0;
e2641e09 1335 server.unixtime = time(NULL);
c25e7eaf 1336 server.lastbgsave_status = REDIS_OK;
4d3bbf35 1337 server.stop_writes_on_bgsave_err = 1;
e2641e09 1338 aeCreateTimeEvent(server.el, 1, serverCron, NULL, NULL);
a5639e7d 1339 if (server.ipfd > 0 && aeCreateFileEvent(server.el,server.ipfd,AE_READABLE,
ab17b909 1340 acceptTcpHandler,NULL) == AE_ERR) oom("creating file event");
a5639e7d 1341 if (server.sofd > 0 && aeCreateFileEvent(server.el,server.sofd,AE_READABLE,
ab17b909 1342 acceptUnixHandler,NULL) == AE_ERR) oom("creating file event");
e2641e09 1343
e394114d 1344 if (server.aof_state == REDIS_AOF_ON) {
ff2145ad 1345 server.aof_fd = open(server.aof_filename,
e394114d 1346 O_WRONLY|O_APPEND|O_CREAT,0644);
ff2145ad 1347 if (server.aof_fd == -1) {
e2641e09 1348 redisLog(REDIS_WARNING, "Can't open the append-only file: %s",
1349 strerror(errno));
1350 exit(1);
1351 }
1352 }
1353
d876678b 1354 /* 32 bit instances are limited to 4GB of address space, so if there is
1355 * no explicit limit in the user provided configuration we set a limit
1356 * at 3.5GB using maxmemory with 'noeviction' policy'. This saves
1357 * useless crashes of the Redis instance. */
1358 if (server.arch_bits == 32 && server.maxmemory == 0) {
1359 redisLog(REDIS_WARNING,"Warning: 32 bit instance detected but no memory limit set. Setting 3.5 GB maxmemory limit with 'noeviction' policy now.");
1360 server.maxmemory = 3584LL*(1024*1024); /* 3584 MB = 3.5 GB */
1361 server.maxmemory_policy = REDIS_MAXMEMORY_NO_EVICTION;
1362 }
1363
ecc91094 1364 if (server.cluster_enabled) clusterInit();
7585836e 1365 scriptingInit();
daa70b17 1366 slowlogInit();
8f61a72f 1367 bioInit();
e2641e09 1368}
1369
1b1f47c9 1370/* Populates the Redis Command Table starting from the hard coded list
1371 * we have on top of redis.c file. */
1372void populateCommandTable(void) {
1373 int j;
d7ed7fd2 1374 int numcommands = sizeof(redisCommandTable)/sizeof(struct redisCommand);
1b1f47c9 1375
1376 for (j = 0; j < numcommands; j++) {
d7ed7fd2 1377 struct redisCommand *c = redisCommandTable+j;
5d02b00f 1378 char *f = c->sflags;
1b1f47c9 1379 int retval;
e2641e09 1380
5d02b00f 1381 while(*f != '\0') {
1382 switch(*f) {
1383 case 'w': c->flags |= REDIS_CMD_WRITE; break;
1384 case 'r': c->flags |= REDIS_CMD_READONLY; break;
1385 case 'm': c->flags |= REDIS_CMD_DENYOOM; break;
1386 case 'a': c->flags |= REDIS_CMD_ADMIN; break;
1387 case 'p': c->flags |= REDIS_CMD_PUBSUB; break;
1388 case 'f': c->flags |= REDIS_CMD_FORCE_REPLICATION; break;
b60ed6e8 1389 case 's': c->flags |= REDIS_CMD_NOSCRIPT; break;
1390 case 'R': c->flags |= REDIS_CMD_RANDOM; break;
548efd91 1391 case 'S': c->flags |= REDIS_CMD_SORT_FOR_SCRIPT; break;
5d73073f 1392 case 'l': c->flags |= REDIS_CMD_LOADING; break;
1393 case 't': c->flags |= REDIS_CMD_STALE; break;
5d02b00f 1394 default: redisPanic("Unsupported command flag"); break;
1395 }
1396 f++;
1397 }
1398
1b1f47c9 1399 retval = dictAdd(server.commands, sdsnew(c->name), c);
1400 assert(retval == DICT_OK);
1401 }
e2641e09 1402}
1403
d7ed7fd2 1404void resetCommandTableStats(void) {
1405 int numcommands = sizeof(redisCommandTable)/sizeof(struct redisCommand);
1406 int j;
1407
1408 for (j = 0; j < numcommands; j++) {
1409 struct redisCommand *c = redisCommandTable+j;
1410
1411 c->microseconds = 0;
1412 c->calls = 0;
1413 }
1414}
1415
78d6a22d 1416/* ========================== Redis OP Array API ============================ */
1417
1418void redisOpArrayInit(redisOpArray *oa) {
1419 oa->ops = NULL;
1420 oa->numops = 0;
1421}
1422
1423int redisOpArrayAppend(redisOpArray *oa, struct redisCommand *cmd, int dbid,
1424 robj **argv, int argc, int target)
1425{
1426 redisOp *op;
1427
1428 oa->ops = zrealloc(oa->ops,sizeof(redisOp)*(oa->numops+1));
1429 op = oa->ops+oa->numops;
1430 op->cmd = cmd;
1431 op->dbid = dbid;
1432 op->argv = argv;
1433 op->argc = argc;
1434 op->target = target;
1435 oa->numops++;
1436 return oa->numops;
1437}
1438
1439void redisOpArrayFree(redisOpArray *oa) {
1440 while(oa->numops) {
1441 int j;
1442 redisOp *op;
1443
1444 oa->numops--;
1445 op = oa->ops+oa->numops;
1446 for (j = 0; j < op->argc; j++)
1447 decrRefCount(op->argv[j]);
1448 zfree(op->argv);
1449 }
1450 zfree(oa->ops);
1451}
1452
e2641e09 1453/* ====================== Commands lookup and execution ===================== */
1454
1b1f47c9 1455struct redisCommand *lookupCommand(sds name) {
1456 return dictFetchValue(server.commands, name);
1457}
1458
1459struct redisCommand *lookupCommandByCString(char *s) {
1460 struct redisCommand *cmd;
1461 sds name = sdsnew(s);
1462
1463 cmd = dictFetchValue(server.commands, name);
1464 sdsfree(name);
1465 return cmd;
e2641e09 1466}
1467
ad08d059 1468/* Propagate the specified command (in the context of the specified database id)
1469 * to AOF, Slaves and Monitors.
1470 *
1471 * flags are an xor between:
1472 * + REDIS_PROPAGATE_NONE (no propagation of command at all)
1473 * + REDIS_PROPAGATE_AOF (propagate into the AOF file if is enabled)
1474 * + REDIS_PROPAGATE_REPL (propagate into the replication link)
1475 */
1476void propagate(struct redisCommand *cmd, int dbid, robj **argv, int argc,
1477 int flags)
1478{
1479 if (server.aof_state != REDIS_AOF_OFF && flags & REDIS_PROPAGATE_AOF)
1480 feedAppendOnlyFile(cmd,dbid,argv,argc);
1481 if (flags & REDIS_PROPAGATE_REPL && listLength(server.slaves))
1482 replicationFeedSlaves(server.slaves,dbid,argv,argc);
1483}
1484
78d6a22d 1485/* Used inside commands to schedule the propagation of additional commands
1486 * after the current command is propagated to AOF / Replication. */
eeb34eff 1487void alsoPropagate(struct redisCommand *cmd, int dbid, robj **argv, int argc,
1488 int target)
1489{
78d6a22d 1490 redisOpArrayAppend(&server.also_propagate,cmd,dbid,argv,argc,target);
eeb34eff 1491}
1492
e2641e09 1493/* Call() is the core of Redis execution of a command */
ce8b772b 1494void call(redisClient *c, int flags) {
daa70b17 1495 long long dirty, start = ustime(), duration;
e2641e09 1496
ad08d059 1497 /* Sent the command to clients in MONITOR mode, only if the commands are
1498 * not geneated from reading an AOF. */
1499 if (listLength(server.monitors) && !server.loading)
e31b615e 1500 replicationFeedMonitors(c,server.monitors,c->db->id,c->argv,c->argc);
ad08d059 1501
1502 /* Call the command. */
78d6a22d 1503 redisOpArrayInit(&server.also_propagate);
e2641e09 1504 dirty = server.dirty;
09e2d9ee 1505 c->cmd->proc(c);
e2641e09 1506 dirty = server.dirty-dirty;
daa70b17 1507 duration = ustime()-start;
ce8b772b 1508
1509 /* When EVAL is called loading the AOF we don't want commands called
1510 * from Lua to go into the slowlog or to populate statistics. */
1511 if (server.loading && c->flags & REDIS_LUA_CLIENT)
1512 flags &= ~(REDIS_CALL_SLOWLOG | REDIS_CALL_STATS);
1513
ad08d059 1514 /* Log the command into the Slow log if needed, and populate the
1515 * per-command statistics that we show in INFO commandstats. */
ce8b772b 1516 if (flags & REDIS_CALL_SLOWLOG)
1517 slowlogPushEntryIfNeeded(c->argv,c->argc,duration);
1518 if (flags & REDIS_CALL_STATS) {
1519 c->cmd->microseconds += duration;
1520 c->cmd->calls++;
1521 }
ad08d059 1522
1523 /* Propagate the command into the AOF and replication link */
ce8b772b 1524 if (flags & REDIS_CALL_PROPAGATE) {
ad08d059 1525 int flags = REDIS_PROPAGATE_NONE;
1526
1527 if (c->cmd->flags & REDIS_CMD_FORCE_REPLICATION)
1528 flags |= REDIS_PROPAGATE_REPL;
1529 if (dirty)
1530 flags |= (REDIS_PROPAGATE_REPL | REDIS_PROPAGATE_AOF);
1531 if (flags != REDIS_PROPAGATE_NONE)
1532 propagate(c->cmd,c->db->id,c->argv,c->argc,flags);
ce8b772b 1533 }
eeb34eff 1534 /* Commands such as LPUSH or BRPOPLPUSH may propagate an additional
1535 * PUSH command. */
78d6a22d 1536 if (server.also_propagate.numops) {
eeb34eff 1537 int j;
78d6a22d 1538 redisOp *rop;
eeb34eff 1539
78d6a22d 1540 for (j = 0; j < server.also_propagate.numops; j++) {
1541 rop = &server.also_propagate.ops[j];
1542 propagate(rop->cmd, rop->dbid, rop->argv, rop->argc, rop->target);
1543 }
1544 redisOpArrayFree(&server.also_propagate);
eeb34eff 1545 }
e2641e09 1546 server.stat_numcommands++;
1547}
1548
1549/* If this function gets called we already read a whole
1550 * command, argments are in the client argv/argc fields.
1551 * processCommand() execute the command or prepare the
1552 * server for a bulk read from the client.
1553 *
1554 * If 1 is returned the client is still alive and valid and
1555 * and other operations can be performed by the caller. Otherwise
1556 * if 0 is returned the client was destroied (i.e. after QUIT). */
1557int processCommand(redisClient *c) {
941c9fa2
PN
1558 /* The QUIT command is handled separately. Normal command procs will
1559 * go through checking for replication and QUIT will cause trouble
1560 * when FORCE_REPLICATION is enabled and would be implemented in
1561 * a regular command proc. */
e2641e09 1562 if (!strcasecmp(c->argv[0]->ptr,"quit")) {
941c9fa2 1563 addReply(c,shared.ok);
5e78edb3 1564 c->flags |= REDIS_CLOSE_AFTER_REPLY;
cd8788f2 1565 return REDIS_ERR;
e2641e09 1566 }
1567
1568 /* Now lookup the command and check ASAP about trivial error conditions
09e2d9ee 1569 * such as wrong arity, bad command name and so forth. */
2c74a9f9 1570 c->cmd = c->lastcmd = lookupCommand(c->argv[0]->ptr);
09e2d9ee 1571 if (!c->cmd) {
3ab20376
PN
1572 addReplyErrorFormat(c,"unknown command '%s'",
1573 (char*)c->argv[0]->ptr);
cd8788f2 1574 return REDIS_OK;
09e2d9ee 1575 } else if ((c->cmd->arity > 0 && c->cmd->arity != c->argc) ||
1576 (c->argc < -c->cmd->arity)) {
3ab20376 1577 addReplyErrorFormat(c,"wrong number of arguments for '%s' command",
09e2d9ee 1578 c->cmd->name);
cd8788f2 1579 return REDIS_OK;
e2641e09 1580 }
e2641e09 1581
1582 /* Check if the user is authenticated */
09e2d9ee 1583 if (server.requirepass && !c->authenticated && c->cmd->proc != authCommand)
1584 {
3ab20376 1585 addReplyError(c,"operation not permitted");
cd8788f2 1586 return REDIS_OK;
e2641e09 1587 }
1588
ecc91094 1589 /* If cluster is enabled, redirect here */
1590 if (server.cluster_enabled &&
09e2d9ee 1591 !(c->cmd->getkeys_proc == NULL && c->cmd->firstkey == 0)) {
ecc91094 1592 int hashslot;
1593
1594 if (server.cluster.state != REDIS_CLUSTER_OK) {
1595 addReplyError(c,"The cluster is down. Check with CLUSTER INFO for more information");
1596 return REDIS_OK;
1597 } else {
eda827f8 1598 int ask;
09e2d9ee 1599 clusterNode *n = getNodeByQuery(c,c->cmd,c->argv,c->argc,&hashslot,&ask);
ecc91094 1600 if (n == NULL) {
eda827f8 1601 addReplyError(c,"Multi keys request invalid in cluster");
ecc91094 1602 return REDIS_OK;
1603 } else if (n != server.cluster.myself) {
1604 addReplySds(c,sdscatprintf(sdsempty(),
eda827f8 1605 "-%s %d %s:%d\r\n", ask ? "ASK" : "MOVED",
1606 hashslot,n->ip,n->port));
ecc91094 1607 return REDIS_OK;
1608 }
1609 }
1610 }
1611
1dd10ca2 1612 /* Handle the maxmemory directive.
1613 *
1614 * First we try to free some memory if possible (if there are volatile
1615 * keys in the dataset). If there are not the only thing we can do
1616 * is returning an error. */
f6b32c14 1617 if (server.maxmemory) {
1618 int retval = freeMemoryIfNeeded();
1619 if ((c->cmd->flags & REDIS_CMD_DENYOOM) && retval == REDIS_ERR) {
f3fd419f 1620 addReply(c, shared.oomerr);
f6b32c14 1621 return REDIS_OK;
1622 }
e2641e09 1623 }
1624
c25e7eaf 1625 /* Don't accept write commands if there are problems persisting on disk. */
4d3bbf35 1626 if (server.stop_writes_on_bgsave_err &&
1627 server.saveparamslen > 0
1628 && server.lastbgsave_status == REDIS_ERR &&
c25e7eaf 1629 c->cmd->flags & REDIS_CMD_WRITE)
1630 {
1631 addReply(c, shared.bgsaveerr);
1632 return REDIS_OK;
1633 }
1634
5d73073f 1635 /* Don't accept write commands if this is a read only slave. But
f3fd419f 1636 * accept write commands if this is our master. */
1637 if (server.masterhost && server.repl_slave_ro &&
1638 !(c->flags & REDIS_MASTER) &&
1639 c->cmd->flags & REDIS_CMD_WRITE)
1640 {
1641 addReply(c, shared.roslaveerr);
1642 return REDIS_OK;
1643 }
1644
e2641e09 1645 /* Only allow SUBSCRIBE and UNSUBSCRIBE in the context of Pub/Sub */
1646 if ((dictSize(c->pubsub_channels) > 0 || listLength(c->pubsub_patterns) > 0)
1647 &&
09e2d9ee 1648 c->cmd->proc != subscribeCommand &&
1649 c->cmd->proc != unsubscribeCommand &&
1650 c->cmd->proc != psubscribeCommand &&
1651 c->cmd->proc != punsubscribeCommand) {
3ab20376 1652 addReplyError(c,"only (P)SUBSCRIBE / (P)UNSUBSCRIBE / QUIT allowed in this context");
cd8788f2 1653 return REDIS_OK;
e2641e09 1654 }
1655
4ebfc455 1656 /* Only allow INFO and SLAVEOF when slave-serve-stale-data is no and
1657 * we are a slave with a broken link with master. */
1844f990 1658 if (server.masterhost && server.repl_state != REDIS_REPL_CONNECTED &&
4ebfc455 1659 server.repl_serve_stale_data == 0 &&
5d73073f 1660 !(c->cmd->flags & REDIS_CMD_STALE))
4ebfc455 1661 {
ae62d29d 1662 addReply(c, shared.masterdownerr);
4ebfc455 1663 return REDIS_OK;
1664 }
1665
5d73073f 1666 /* Loading DB? Return an error if the command has not the
1667 * REDIS_CMD_LOADING flag. */
1668 if (server.loading && !(c->cmd->flags & REDIS_CMD_LOADING)) {
97e7f8ae 1669 addReply(c, shared.loadingerr);
1670 return REDIS_OK;
1671 }
1672
5d73073f 1673 /* Lua script too slow? Only allow commands with REDIS_CMD_STALE flag. */
4ab8695d 1674 if (server.lua_timedout &&
e3923a35 1675 !(c->cmd->proc == shutdownCommand &&
4ab8695d 1676 c->argc == 2 &&
1677 tolower(((char*)c->argv[1]->ptr)[0]) == 'n') &&
1678 !(c->cmd->proc == scriptCommand &&
1679 c->argc == 2 &&
1680 tolower(((char*)c->argv[1]->ptr)[0]) == 'k'))
1681 {
115e3ff3 1682 addReply(c, shared.slowscripterr);
1683 return REDIS_OK;
1684 }
1685
e2641e09 1686 /* Exec the command */
1687 if (c->flags & REDIS_MULTI &&
09e2d9ee 1688 c->cmd->proc != execCommand && c->cmd->proc != discardCommand &&
1689 c->cmd->proc != multiCommand && c->cmd->proc != watchCommand)
e2641e09 1690 {
09e2d9ee 1691 queueMultiCommand(c);
e2641e09 1692 addReply(c,shared.queued);
1693 } else {
ce8b772b 1694 call(c,REDIS_CALL_FULL);
e2641e09 1695 }
cd8788f2 1696 return REDIS_OK;
e2641e09 1697}
1698
1699/*================================== Shutdown =============================== */
1700
4ab8695d 1701int prepareForShutdown(int flags) {
1702 int save = flags & REDIS_SHUTDOWN_SAVE;
1703 int nosave = flags & REDIS_SHUTDOWN_NOSAVE;
1704
adae85cd 1705 redisLog(REDIS_WARNING,"User requested shutdown...");
e2641e09 1706 /* Kill the saving child if there is a background saving in progress.
1707 We want to avoid race conditions, for instance our saving child may
1708 overwrite the synchronous saving did by SHUTDOWN. */
f48cd4b9 1709 if (server.rdb_child_pid != -1) {
adae85cd 1710 redisLog(REDIS_WARNING,"There is a child saving an .rdb. Killing it!");
f48cd4b9 1711 kill(server.rdb_child_pid,SIGKILL);
1712 rdbRemoveTempFile(server.rdb_child_pid);
e2641e09 1713 }
e394114d 1714 if (server.aof_state != REDIS_AOF_OFF) {
adae85cd 1715 /* Kill the AOF saving child as the AOF we already have may be longer
1716 * but contains the full dataset anyway. */
ff2145ad 1717 if (server.aof_child_pid != -1) {
adae85cd 1718 redisLog(REDIS_WARNING,
1719 "There is a child rewriting the AOF. Killing it!");
ff2145ad 1720 kill(server.aof_child_pid,SIGKILL);
adae85cd 1721 }
e2641e09 1722 /* Append only file: fsync() the AOF and exit */
adae85cd 1723 redisLog(REDIS_NOTICE,"Calling fsync() on the AOF file.");
ff2145ad 1724 aof_fsync(server.aof_fd);
adae85cd 1725 }
4ab8695d 1726 if ((server.saveparamslen > 0 && !nosave) || save) {
adae85cd 1727 redisLog(REDIS_NOTICE,"Saving the final RDB snapshot before exiting.");
e2641e09 1728 /* Snapshotting. Perform a SYNC SAVE and exit */
f48cd4b9 1729 if (rdbSave(server.rdb_filename) != REDIS_OK) {
e2641e09 1730 /* Ooops.. error saving! The best we can do is to continue
1731 * operating. Note that if there was a background saving process,
1732 * in the next cron() Redis will be notified that the background
1733 * saving aborted, handling special stuff like slaves pending for
1734 * synchronization... */
adae85cd 1735 redisLog(REDIS_WARNING,"Error trying to save the DB, can't exit.");
e2641e09 1736 return REDIS_ERR;
1737 }
1738 }
adae85cd 1739 if (server.daemonize) {
1740 redisLog(REDIS_NOTICE,"Removing the pid file.");
1741 unlink(server.pidfile);
1742 }
80e87a46 1743 /* Close the listening sockets. Apparently this allows faster restarts. */
1744 if (server.ipfd != -1) close(server.ipfd);
1745 if (server.sofd != -1) close(server.sofd);
56209f72
NF
1746 if (server.unixsocket) {
1747 redisLog(REDIS_NOTICE,"Removing the unix socket file.");
1748 unlink(server.unixsocket); /* don't care if this fails */
1749 }
80e87a46 1750
adae85cd 1751 redisLog(REDIS_WARNING,"Redis is now ready to exit, bye bye...");
e2641e09 1752 return REDIS_OK;
1753}
1754
1755/*================================== Commands =============================== */
1756
5410168c 1757/* Return zero if strings are the same, non-zero if they are not.
31a1439b 1758 * The comparison is performed in a way that prevents an attacker to obtain
1759 * information about the nature of the strings just monitoring the execution
1760 * time of the function.
1761 *
1762 * Note that limiting the comparison length to strings up to 512 bytes we
1763 * can avoid leaking any information about the password length and any
1764 * possible branch misprediction related leak.
1765 */
1766int time_independent_strcmp(char *a, char *b) {
1767 char bufa[REDIS_AUTHPASS_MAX_LEN], bufb[REDIS_AUTHPASS_MAX_LEN];
1768 /* The above two strlen perform len(a) + len(b) operations where either
1769 * a or b are fixed (our password) length, and the difference is only
1770 * relative to the length of the user provided string, so no information
1771 * leak is possible in the following two lines of code. */
1772 int alen = strlen(a);
1773 int blen = strlen(b);
1774 int j;
1775 int diff = 0;
1776
1777 /* We can't compare strings longer than our static buffers.
1778 * Note that this will never pass the first test in practical circumstances
1779 * so there is no info leak. */
1780 if (alen > sizeof(bufa) || blen > sizeof(bufb)) return 1;
1781
1782 memset(bufa,0,sizeof(bufa)); /* Constant time. */
1783 memset(bufb,0,sizeof(bufb)); /* Constant time. */
1784 /* Again the time of the following two copies is proportional to
1785 * len(a) + len(b) so no info is leaked. */
1786 memcpy(bufa,a,alen);
1787 memcpy(bufb,b,blen);
1788
1789 /* Always compare all the chars in the two buffers without
1790 * conditional expressions. */
1791 for (j = 0; j < sizeof(bufa); j++) {
1792 diff |= (bufa[j] ^ bufb[j]);
1793 }
1794 /* Length must be equal as well. */
1795 diff |= alen ^ blen;
1796 return diff; /* If zero strings are the same. */
1797}
1798
e2641e09 1799void authCommand(redisClient *c) {
ab52d1f4 1800 if (!server.requirepass) {
1801 addReplyError(c,"Client sent AUTH, but no password is set");
31a1439b 1802 } else if (!time_independent_strcmp(c->argv[1]->ptr, server.requirepass)) {
e2641e09 1803 c->authenticated = 1;
1804 addReply(c,shared.ok);
1805 } else {
1806 c->authenticated = 0;
3ab20376 1807 addReplyError(c,"invalid password");
e2641e09 1808 }
1809}
1810
1811void pingCommand(redisClient *c) {
1812 addReply(c,shared.pong);
1813}
1814
1815void echoCommand(redisClient *c) {
1816 addReplyBulk(c,c->argv[1]);
1817}
1818
9494f1f1 1819void timeCommand(redisClient *c) {
1820 struct timeval tv;
1821
1822 /* gettimeofday() can only fail if &tv is a bad addresss so we
1823 * don't check for errors. */
1824 gettimeofday(&tv,NULL);
1825 addReplyMultiBulkLen(c,2);
1826 addReplyBulkLongLong(c,tv.tv_sec);
1827 addReplyBulkLongLong(c,tv.tv_usec);
1828}
1829
e2641e09 1830/* Convert an amount of bytes into a human readable string in the form
1831 * of 100B, 2G, 100M, 4K, and so forth. */
1832void bytesToHuman(char *s, unsigned long long n) {
1833 double d;
1834
1835 if (n < 1024) {
1836 /* Bytes */
1837 sprintf(s,"%lluB",n);
1838 return;
1839 } else if (n < (1024*1024)) {
1840 d = (double)n/(1024);
1841 sprintf(s,"%.2fK",d);
1842 } else if (n < (1024LL*1024*1024)) {
1843 d = (double)n/(1024*1024);
1844 sprintf(s,"%.2fM",d);
1845 } else if (n < (1024LL*1024*1024*1024)) {
1846 d = (double)n/(1024LL*1024*1024);
1847 sprintf(s,"%.2fG",d);
1848 }
1849}
1850
1851/* Create the string returned by the INFO command. This is decoupled
1852 * by the INFO command itself as we need to report the same information
1853 * on memory corruption problems. */
1b085c9f 1854sds genRedisInfoString(char *section) {
1855 sds info = sdsempty();
d1949054 1856 time_t uptime = server.unixtime-server.stat_starttime;
d9cb288c 1857 int j, numcommands;
2b00385d 1858 struct rusage self_ru, c_ru;
7a1fd61e 1859 unsigned long lol, bib;
1b085c9f 1860 int allsections = 0, defsections = 0;
1861 int sections = 0;
1862
1863 if (section) {
1864 allsections = strcasecmp(section,"all") == 0;
0d808ef2 1865 defsections = strcasecmp(section,"default") == 0;
1b085c9f 1866 }
2b00385d 1867
1868 getrusage(RUSAGE_SELF, &self_ru);
1869 getrusage(RUSAGE_CHILDREN, &c_ru);
7a1fd61e 1870 getClientsMaxBuffers(&lol,&bib);
1b085c9f 1871
1872 /* Server */
1873 if (allsections || defsections || !strcasecmp(section,"server")) {
5ad1faa0 1874 struct utsname name;
1875
1b085c9f 1876 if (sections++) info = sdscat(info,"\r\n");
5ad1faa0 1877 uname(&name);
e2641e09 1878 info = sdscatprintf(info,
1b085c9f 1879 "# Server\r\n"
1880 "redis_version:%s\r\n"
1881 "redis_git_sha1:%s\r\n"
1882 "redis_git_dirty:%d\r\n"
5ad1faa0 1883 "os:%s %s %s\r\n"
75eaac5c 1884 "arch_bits:%d\r\n"
1b085c9f 1885 "multiplexing_api:%s\r\n"
5db904bd 1886 "gcc_version:%d.%d.%d\r\n"
1b085c9f 1887 "process_id:%ld\r\n"
91d664d6 1888 "run_id:%s\r\n"
1b085c9f 1889 "tcp_port:%d\r\n"
1890 "uptime_in_seconds:%ld\r\n"
1891 "uptime_in_days:%ld\r\n"
1892 "lru_clock:%ld\r\n",
1893 REDIS_VERSION,
1894 redisGitSHA1(),
1895 strtol(redisGitDirty(),NULL,10) > 0,
5ad1faa0 1896 name.sysname, name.release, name.machine,
75eaac5c 1897 server.arch_bits,
1b085c9f 1898 aeGetApiName(),
5db904bd 1899#ifdef __GNUC__
1900 __GNUC__,__GNUC_MINOR__,__GNUC_PATCHLEVEL__,
1901#else
1902 0,0,0,
1903#endif
1b085c9f 1904 (long) getpid(),
91d664d6 1905 server.runid,
1b085c9f 1906 server.port,
1907 uptime,
1908 uptime/(3600*24),
1909 (unsigned long) server.lruclock);
1910 }
1911
1912 /* Clients */
1913 if (allsections || defsections || !strcasecmp(section,"clients")) {
1914 if (sections++) info = sdscat(info,"\r\n");
1915 info = sdscatprintf(info,
1916 "# Clients\r\n"
3c08fdae 1917 "connected_clients:%lu\r\n"
1b085c9f 1918 "client_longest_output_list:%lu\r\n"
1919 "client_biggest_input_buf:%lu\r\n"
1920 "blocked_clients:%d\r\n",
1921 listLength(server.clients)-listLength(server.slaves),
1922 lol, bib,
1923 server.bpop_blocked_clients);
1924 }
1925
1926 /* Memory */
1927 if (allsections || defsections || !strcasecmp(section,"memory")) {
17b24ff3 1928 char hmem[64];
1929 char peak_hmem[64];
1930
1931 bytesToHuman(hmem,zmalloc_used_memory());
1932 bytesToHuman(peak_hmem,server.stat_peak_memory);
1b085c9f 1933 if (sections++) info = sdscat(info,"\r\n");
1934 info = sdscatprintf(info,
1935 "# Memory\r\n"
1936 "used_memory:%zu\r\n"
1937 "used_memory_human:%s\r\n"
1938 "used_memory_rss:%zu\r\n"
17b24ff3 1939 "used_memory_peak:%zu\r\n"
1940 "used_memory_peak_human:%s\r\n"
8c3402df 1941 "used_memory_lua:%lld\r\n"
1b085c9f 1942 "mem_fragmentation_ratio:%.2f\r\n"
32f99c51 1943 "mem_allocator:%s\r\n",
1b085c9f 1944 zmalloc_used_memory(),
1945 hmem,
1946 zmalloc_get_rss(),
17b24ff3 1947 server.stat_peak_memory,
1948 peak_hmem,
8c3402df 1949 ((long long)lua_gc(server.lua,LUA_GCCOUNT,0))*1024LL,
1b085c9f 1950 zmalloc_get_fragmentation_ratio(),
fec5a664 1951 ZMALLOC_LIB
12ebe2ac 1952 );
0d808ef2 1953 }
1954
1b085c9f 1955 /* Persistence */
1956 if (allsections || defsections || !strcasecmp(section,"persistence")) {
1957 if (sections++) info = sdscat(info,"\r\n");
e2641e09 1958 info = sdscatprintf(info,
1b085c9f 1959 "# Persistence\r\n"
1960 "loading:%d\r\n"
33e1db36 1961 "rdb_changes_since_last_save:%lld\r\n"
1962 "rdb_bgsave_in_progress:%d\r\n"
1963 "rdb_last_save_time:%ld\r\n"
1964 "rdb_last_bgsave_status:%s\r\n"
1965 "rdb_last_bgsave_time_sec:%ld\r\n"
1966 "rdb_current_bgsave_time_sec:%ld\r\n"
1b085c9f 1967 "aof_enabled:%d\r\n"
33e1db36 1968 "aof_rewrite_in_progress:%d\r\n"
1969 "aof_rewrite_scheduled:%d\r\n"
1970 "aof_last_rewrite_time_sec:%ld\r\n"
48553a29
SG
1971 "aof_current_rewrite_time_sec:%ld\r\n"
1972 "aof_last_bgrewrite_status:%s\r\n",
1b085c9f 1973 server.loading,
1b085c9f 1974 server.dirty,
f48cd4b9 1975 server.rdb_child_pid != -1,
1b085c9f 1976 server.lastsave,
48553a29 1977 (server.lastbgsave_status == REDIS_OK) ? "ok" : "err",
33e1db36 1978 server.rdb_save_time_last,
1979 (server.rdb_child_pid == -1) ?
1980 -1 : time(NULL)-server.rdb_save_time_start,
1981 server.aof_state != REDIS_AOF_OFF,
618a9229 1982 server.aof_child_pid != -1,
33e1db36 1983 server.aof_rewrite_scheduled,
1984 server.aof_rewrite_time_last,
1985 (server.aof_child_pid == -1) ?
48553a29
SG
1986 -1 : time(NULL)-server.aof_rewrite_time_start,
1987 (server.aof_lastbgrewrite_status == REDIS_OK) ? "ok" : "err");
1b085c9f 1988
e394114d 1989 if (server.aof_state != REDIS_AOF_OFF) {
d630abcd 1990 info = sdscatprintf(info,
1991 "aof_current_size:%lld\r\n"
1992 "aof_base_size:%lld\r\n"
e7ef418c 1993 "aof_pending_rewrite:%d\r\n"
1994 "aof_buffer_length:%zu\r\n"
6f05a653 1995 "aof_rewrite_buffer_length:%zu\r\n"
c1d01b3c 1996 "aof_pending_bio_fsync:%llu\r\n"
1997 "aof_delayed_fsync:%lu\r\n",
2c915bcf 1998 (long long) server.aof_current_size,
1999 (long long) server.aof_rewrite_base_size,
2000 server.aof_rewrite_scheduled,
ff2145ad 2001 sdslen(server.aof_buf),
6f05a653 2002 aofRewriteBufferSize(),
c1d01b3c 2003 bioPendingJobsOfType(REDIS_BIO_AOF_FSYNC),
2004 server.aof_delayed_fsync);
d630abcd 2005 }
2006
1b085c9f 2007 if (server.loading) {
2008 double perc;
2009 time_t eta, elapsed;
2010 off_t remaining_bytes = server.loading_total_bytes-
2011 server.loading_loaded_bytes;
2012
2013 perc = ((double)server.loading_loaded_bytes /
2014 server.loading_total_bytes) * 100;
2015
d1949054 2016 elapsed = server.unixtime-server.loading_start_time;
1b085c9f 2017 if (elapsed == 0) {
2018 eta = 1; /* A fake 1 second figure if we don't have
2019 enough info */
2020 } else {
2021 eta = (elapsed*remaining_bytes)/server.loading_loaded_bytes;
2022 }
2023
2024 info = sdscatprintf(info,
2025 "loading_start_time:%ld\r\n"
2026 "loading_total_bytes:%llu\r\n"
2027 "loading_loaded_bytes:%llu\r\n"
2028 "loading_loaded_perc:%.2f\r\n"
2029 "loading_eta_seconds:%ld\r\n"
2030 ,(unsigned long) server.loading_start_time,
2031 (unsigned long long) server.loading_total_bytes,
2032 (unsigned long long) server.loading_loaded_bytes,
2033 perc,
2034 eta
2035 );
2036 }
e2641e09 2037 }
1b085c9f 2038
1b085c9f 2039 /* Stats */
2040 if (allsections || defsections || !strcasecmp(section,"stats")) {
2041 if (sections++) info = sdscat(info,"\r\n");
97e7f8ae 2042 info = sdscatprintf(info,
1b085c9f 2043 "# Stats\r\n"
2044 "total_connections_received:%lld\r\n"
2045 "total_commands_processed:%lld\r\n"
250e7f69 2046 "instantaneous_ops_per_sec:%lld\r\n"
3c95e721 2047 "rejected_connections:%lld\r\n"
1b085c9f 2048 "expired_keys:%lld\r\n"
2049 "evicted_keys:%lld\r\n"
2050 "keyspace_hits:%lld\r\n"
2051 "keyspace_misses:%lld\r\n"
2052 "pubsub_channels:%ld\r\n"
3c08fdae 2053 "pubsub_patterns:%lu\r\n"
615e414c 2054 "latest_fork_usec:%lld\r\n",
1b085c9f 2055 server.stat_numconnections,
2056 server.stat_numcommands,
250e7f69 2057 getOperationsPerSecond(),
3c95e721 2058 server.stat_rejected_conn,
1b085c9f 2059 server.stat_expiredkeys,
2060 server.stat_evictedkeys,
2061 server.stat_keyspace_hits,
2062 server.stat_keyspace_misses,
2063 dictSize(server.pubsub_channels),
615e414c 2064 listLength(server.pubsub_patterns),
2065 server.stat_fork_time);
97e7f8ae 2066 }
67a1810b 2067
1b085c9f 2068 /* Replication */
2069 if (allsections || defsections || !strcasecmp(section,"replication")) {
2070 if (sections++) info = sdscat(info,"\r\n");
2071 info = sdscatprintf(info,
2072 "# Replication\r\n"
2073 "role:%s\r\n",
2074 server.masterhost == NULL ? "master" : "slave");
2075 if (server.masterhost) {
2076 info = sdscatprintf(info,
2077 "master_host:%s\r\n"
2078 "master_port:%d\r\n"
2079 "master_link_status:%s\r\n"
2080 "master_last_io_seconds_ago:%d\r\n"
2081 "master_sync_in_progress:%d\r\n"
2082 ,server.masterhost,
2083 server.masterport,
1844f990 2084 (server.repl_state == REDIS_REPL_CONNECTED) ?
1b085c9f 2085 "up" : "down",
2086 server.master ?
d1949054 2087 ((int)(server.unixtime-server.master->lastinteraction)) : -1,
1844f990 2088 server.repl_state == REDIS_REPL_TRANSFER
1b085c9f 2089 );
2090
1844f990 2091 if (server.repl_state == REDIS_REPL_TRANSFER) {
1b085c9f 2092 info = sdscatprintf(info,
2093 "master_sync_left_bytes:%ld\r\n"
2094 "master_sync_last_io_seconds_ago:%d\r\n"
2095 ,(long)server.repl_transfer_left,
d1949054 2096 (int)(server.unixtime-server.repl_transfer_lastio)
1b085c9f 2097 );
2098 }
07486df6 2099
1844f990 2100 if (server.repl_state != REDIS_REPL_CONNECTED) {
07486df6 2101 info = sdscatprintf(info,
2102 "master_link_down_since_seconds:%ld\r\n",
d1949054 2103 (long)server.unixtime-server.repl_down_since);
07486df6 2104 }
67a1810b 2105 }
1b085c9f 2106 info = sdscatprintf(info,
3c08fdae 2107 "connected_slaves:%lu\r\n",
1b085c9f 2108 listLength(server.slaves));
503d87a8 2109 if (listLength(server.slaves)) {
2110 int slaveid = 0;
2111 listNode *ln;
2112 listIter li;
2113
2114 listRewind(server.slaves,&li);
2115 while((ln = listNext(&li))) {
2116 redisClient *slave = listNodeValue(ln);
2117 char *state = NULL;
2118 char ip[32];
2119 int port;
2120
2121 if (anetPeerToString(slave->fd,ip,&port) == -1) continue;
2122 switch(slave->replstate) {
2123 case REDIS_REPL_WAIT_BGSAVE_START:
2124 case REDIS_REPL_WAIT_BGSAVE_END:
2125 state = "wait_bgsave";
2126 break;
2127 case REDIS_REPL_SEND_BULK:
2128 state = "send_bulk";
2129 break;
2130 case REDIS_REPL_ONLINE:
2131 state = "online";
2132 break;
2133 }
2134 if (state == NULL) continue;
2135 info = sdscatprintf(info,"slave%d:%s,%d,%s\r\n",
3a328978 2136 slaveid,ip,slave->slave_listening_port,state);
503d87a8 2137 slaveid++;
2138 }
2139 }
67a1810b 2140 }
67a1810b 2141
0d808ef2 2142 /* CPU */
2143 if (allsections || defsections || !strcasecmp(section,"cpu")) {
1b085c9f 2144 if (sections++) info = sdscat(info,"\r\n");
2145 info = sdscatprintf(info,
0d808ef2 2146 "# CPU\r\n"
1b085c9f 2147 "used_cpu_sys:%.2f\r\n"
2148 "used_cpu_user:%.2f\r\n"
5a9dd97c 2149 "used_cpu_sys_children:%.2f\r\n"
2150 "used_cpu_user_children:%.2f\r\n",
1b085c9f 2151 (float)self_ru.ru_stime.tv_sec+(float)self_ru.ru_stime.tv_usec/1000000,
d83eda48 2152 (float)self_ru.ru_utime.tv_sec+(float)self_ru.ru_utime.tv_usec/1000000,
2153 (float)c_ru.ru_stime.tv_sec+(float)c_ru.ru_stime.tv_usec/1000000,
2154 (float)c_ru.ru_utime.tv_sec+(float)c_ru.ru_utime.tv_usec/1000000);
0d808ef2 2155 }
1b085c9f 2156
0d808ef2 2157 /* cmdtime */
2158 if (allsections || !strcasecmp(section,"commandstats")) {
2159 if (sections++) info = sdscat(info,"\r\n");
2160 info = sdscatprintf(info, "# Commandstats\r\n");
d7ed7fd2 2161 numcommands = sizeof(redisCommandTable)/sizeof(struct redisCommand);
1b085c9f 2162 for (j = 0; j < numcommands; j++) {
d7ed7fd2 2163 struct redisCommand *c = redisCommandTable+j;
0d808ef2 2164
d7ed7fd2 2165 if (!c->calls) continue;
2166 info = sdscatprintf(info,
2167 "cmdstat_%s:calls=%lld,usec=%lld,usec_per_call=%.2f\r\n",
2168 c->name, c->calls, c->microseconds,
2169 (c->calls == 0) ? 0 : ((float)c->microseconds/c->calls));
1b085c9f 2170 }
d9cb288c 2171 }
2172
f2f2ba1b 2173 /* Cluster */
1c708b25
SS
2174 if (allsections || defsections || !strcasecmp(section,"cluster")) {
2175 if (sections++) info = sdscat(info,"\r\n");
2176 info = sdscatprintf(info,
2177 "# Cluster\r\n"
2178 "cluster_enabled:%d\r\n",
2179 server.cluster_enabled);
2180 }
2181
1b085c9f 2182 /* Key space */
2183 if (allsections || defsections || !strcasecmp(section,"keyspace")) {
2184 if (sections++) info = sdscat(info,"\r\n");
2185 info = sdscatprintf(info, "# Keyspace\r\n");
2186 for (j = 0; j < server.dbnum; j++) {
2187 long long keys, vkeys;
e2641e09 2188
1b085c9f 2189 keys = dictSize(server.db[j].dict);
2190 vkeys = dictSize(server.db[j].expires);
2191 if (keys || vkeys) {
2192 info = sdscatprintf(info, "db%d:keys=%lld,expires=%lld\r\n",
2193 j, keys, vkeys);
2194 }
e2641e09 2195 }
2196 }
2197 return info;
2198}
2199
2200void infoCommand(redisClient *c) {
1b085c9f 2201 char *section = c->argc == 2 ? c->argv[1]->ptr : "default";
2202
2203 if (c->argc > 2) {
2204 addReply(c,shared.syntaxerr);
2205 return;
2206 }
2207 sds info = genRedisInfoString(section);
e2641e09 2208 addReplySds(c,sdscatprintf(sdsempty(),"$%lu\r\n",
2209 (unsigned long)sdslen(info)));
2210 addReplySds(c,info);
2211 addReply(c,shared.crlf);
2212}
2213
2214void monitorCommand(redisClient *c) {
2215 /* ignore MONITOR if aleady slave or in monitor mode */
2216 if (c->flags & REDIS_SLAVE) return;
2217
2218 c->flags |= (REDIS_SLAVE|REDIS_MONITOR);
2219 c->slaveseldb = 0;
2220 listAddNodeTail(server.monitors,c);
2221 addReply(c,shared.ok);
2222}
2223
2224/* ============================ Maxmemory directive ======================== */
2225
e2641e09 2226/* This function gets called when 'maxmemory' is set on the config file to limit
f6b32c14 2227 * the max memory used by the server, before processing a command.
e2641e09 2228 *
f6b32c14 2229 * The goal of the function is to free enough memory to keep Redis under the
2230 * configured memory limit.
e2641e09 2231 *
f6b32c14 2232 * The function starts calculating how many bytes should be freed to keep
2233 * Redis under the limit, and enters a loop selecting the best keys to
2234 * evict accordingly to the configured policy.
2235 *
2236 * If all the bytes needed to return back under the limit were freed the
2237 * function returns REDIS_OK, otherwise REDIS_ERR is returned, and the caller
2238 * should block the execution of commands that will result in more memory
2239 * used by the server.
e2641e09 2240 */
f6b32c14 2241int freeMemoryIfNeeded(void) {
2242 size_t mem_used, mem_tofree, mem_freed;
2243 int slaves = listLength(server.slaves);
2244
c1ef6ffe 2245 /* Remove the size of slaves output buffers and AOF buffer from the
2246 * count of used memory. */
f6b32c14 2247 mem_used = zmalloc_used_memory();
2248 if (slaves) {
2249 listIter li;
2250 listNode *ln;
2251
2252 listRewind(server.slaves,&li);
2253 while((ln = listNext(&li))) {
2254 redisClient *slave = listNodeValue(ln);
2255 unsigned long obuf_bytes = getClientOutputBufferMemoryUsage(slave);
2256 if (obuf_bytes > mem_used)
2257 mem_used = 0;
2258 else
2259 mem_used -= obuf_bytes;
2260 }
2261 }
c1ef6ffe 2262 if (server.aof_state != REDIS_AOF_OFF) {
2263 mem_used -= sdslen(server.aof_buf);
47ca4b6e 2264 mem_used -= aofRewriteBufferSize();
c1ef6ffe 2265 }
5402c426 2266
f6b32c14 2267 /* Check if we are over the memory limit. */
2268 if (mem_used <= server.maxmemory) return REDIS_OK;
2269
2270 if (server.maxmemory_policy == REDIS_MAXMEMORY_NO_EVICTION)
2271 return REDIS_ERR; /* We need to free memory, but policy forbids. */
2272
2273 /* Compute how much memory we need to free. */
2274 mem_tofree = mem_used - server.maxmemory;
f6b32c14 2275 mem_freed = 0;
2276 while (mem_freed < mem_tofree) {
2277 int j, k, keys_freed = 0;
e2641e09 2278
165346ca 2279 for (j = 0; j < server.dbnum; j++) {
10c12171 2280 long bestval = 0; /* just to prevent warning */
165346ca 2281 sds bestkey = NULL;
2282 struct dictEntry *de;
2283 redisDb *db = server.db+j;
2284 dict *dict;
2285
2286 if (server.maxmemory_policy == REDIS_MAXMEMORY_ALLKEYS_LRU ||
2287 server.maxmemory_policy == REDIS_MAXMEMORY_ALLKEYS_RANDOM)
2288 {
2289 dict = server.db[j].dict;
2290 } else {
2291 dict = server.db[j].expires;
2292 }
2293 if (dictSize(dict) == 0) continue;
2294
2295 /* volatile-random and allkeys-random policy */
2296 if (server.maxmemory_policy == REDIS_MAXMEMORY_ALLKEYS_RANDOM ||
2297 server.maxmemory_policy == REDIS_MAXMEMORY_VOLATILE_RANDOM)
2298 {
2299 de = dictGetRandomKey(dict);
c0ba9ebe 2300 bestkey = dictGetKey(de);
165346ca 2301 }
2302
2303 /* volatile-lru and allkeys-lru policy */
2304 else if (server.maxmemory_policy == REDIS_MAXMEMORY_ALLKEYS_LRU ||
2305 server.maxmemory_policy == REDIS_MAXMEMORY_VOLATILE_LRU)
2306 {
2307 for (k = 0; k < server.maxmemory_samples; k++) {
2308 sds thiskey;
2309 long thisval;
2310 robj *o;
2311
2312 de = dictGetRandomKey(dict);
c0ba9ebe 2313 thiskey = dictGetKey(de);
0c2f75c6 2314 /* When policy is volatile-lru we need an additonal lookup
2315 * to locate the real key, as dict is set to db->expires. */
2316 if (server.maxmemory_policy == REDIS_MAXMEMORY_VOLATILE_LRU)
2317 de = dictFind(db->dict, thiskey);
c0ba9ebe 2318 o = dictGetVal(de);
165346ca 2319 thisval = estimateObjectIdleTime(o);
2320
2321 /* Higher idle time is better candidate for deletion */
2322 if (bestkey == NULL || thisval > bestval) {
2323 bestkey = thiskey;
2324 bestval = thisval;
2325 }
2326 }
2327 }
2328
2329 /* volatile-ttl */
2330 else if (server.maxmemory_policy == REDIS_MAXMEMORY_VOLATILE_TTL) {
2331 for (k = 0; k < server.maxmemory_samples; k++) {
2332 sds thiskey;
2333 long thisval;
2334
2335 de = dictGetRandomKey(dict);
c0ba9ebe 2336 thiskey = dictGetKey(de);
2337 thisval = (long) dictGetVal(de);
165346ca 2338
2339 /* Expire sooner (minor expire unix timestamp) is better
2340 * candidate for deletion */
2341 if (bestkey == NULL || thisval < bestval) {
2342 bestkey = thiskey;
2343 bestval = thisval;
2344 }
2345 }
2346 }
2347
2348 /* Finally remove the selected key. */
2349 if (bestkey) {
f6b32c14 2350 long long delta;
2351
165346ca 2352 robj *keyobj = createStringObject(bestkey,sdslen(bestkey));
452229b6 2353 propagateExpire(db,keyobj);
f6b32c14 2354 /* We compute the amount of memory freed by dbDelete() alone.
2355 * It is possible that actually the memory needed to propagate
2356 * the DEL in AOF and replication link is greater than the one
2357 * we are freeing removing the key, but we can't account for
2358 * that otherwise we would never exit the loop.
2359 *
2360 * AOF and Output buffer memory will be freed eventually so
2361 * we only care about memory used by the key space. */
2362 delta = (long long) zmalloc_used_memory();
165346ca 2363 dbDelete(db,keyobj);
f6b32c14 2364 delta -= (long long) zmalloc_used_memory();
f6b32c14 2365 mem_freed += delta;
f21779ff 2366 server.stat_evictedkeys++;
165346ca 2367 decrRefCount(keyobj);
f6b32c14 2368 keys_freed++;
2369
2370 /* When the memory to free starts to be big enough, we may
2371 * start spending so much time here that is impossible to
2372 * deliver data to the slaves fast enough, so we force the
2373 * transmission here inside the loop. */
8b7c3455 2374 if (slaves) flushSlavesOutputBuffers();
165346ca 2375 }
2376 }
b129c6df 2377 if (!keys_freed) return REDIS_ERR; /* nothing to free... */
165346ca 2378 }
f6b32c14 2379 return REDIS_OK;
e2641e09 2380}
2381
2382/* =================================== Main! ================================ */
2383
2384#ifdef __linux__
2385int linuxOvercommitMemoryValue(void) {
2386 FILE *fp = fopen("/proc/sys/vm/overcommit_memory","r");
2387 char buf[64];
2388
2389 if (!fp) return -1;
2390 if (fgets(buf,64,fp) == NULL) {
2391 fclose(fp);
2392 return -1;
2393 }
2394 fclose(fp);
2395
2396 return atoi(buf);
2397}
2398
2399void linuxOvercommitMemoryWarning(void) {
2400 if (linuxOvercommitMemoryValue() == 0) {
2401 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.");
2402 }
2403}
2404#endif /* __linux__ */
2405
695fe874 2406void createPidFile(void) {
2407 /* Try to write the pid file in a best-effort way. */
2408 FILE *fp = fopen(server.pidfile,"w");
2409 if (fp) {
8ce39260 2410 fprintf(fp,"%d\n",(int)getpid());
695fe874 2411 fclose(fp);
2412 }
2413}
2414
e2641e09 2415void daemonize(void) {
2416 int fd;
e2641e09 2417
2418 if (fork() != 0) exit(0); /* parent exits */
2419 setsid(); /* create a new session */
2420
2421 /* Every output goes to /dev/null. If Redis is daemonized but
2422 * the 'logfile' is set to 'stdout' in the configuration file
2423 * it will not log at all. */
2424 if ((fd = open("/dev/null", O_RDWR, 0)) != -1) {
2425 dup2(fd, STDIN_FILENO);
2426 dup2(fd, STDOUT_FILENO);
2427 dup2(fd, STDERR_FILENO);
2428 if (fd > STDERR_FILENO) close(fd);
2429 }
e2641e09 2430}
2431
2432void version() {
6e05f333 2433 printf("Redis server v=%s sha=%s:%d malloc=%s bits=%d\n",
2434 REDIS_VERSION,
2435 redisGitSHA1(),
2436 atoi(redisGitDirty()) > 0,
2437 ZMALLOC_LIB,
2438 sizeof(long) == 4 ? 32 : 64);
e2641e09 2439 exit(0);
2440}
2441
2442void usage() {
9268a5b5 2443 fprintf(stderr,"Usage: ./redis-server [/path/to/redis.conf] [options]\n");
e2641e09 2444 fprintf(stderr," ./redis-server - (read config from stdin)\n");
9268a5b5 2445 fprintf(stderr," ./redis-server -v or --version\n");
c5166e3f 2446 fprintf(stderr," ./redis-server -h or --help\n");
2447 fprintf(stderr," ./redis-server --test-memory <megabytes>\n\n");
9268a5b5 2448 fprintf(stderr,"Examples:\n");
2449 fprintf(stderr," ./redis-server (run the server with default conf)\n");
2450 fprintf(stderr," ./redis-server /etc/redis/6379.conf\n");
2451 fprintf(stderr," ./redis-server --port 7777\n");
2452 fprintf(stderr," ./redis-server --port 7777 --slaveof 127.0.0.1 8888\n");
6b5daa2d 2453 fprintf(stderr," ./redis-server /etc/myredis.conf --loglevel verbose\n\n");
2454 fprintf(stderr,"Sentinel mode:\n");
2455 fprintf(stderr," ./redis-server /etc/sentinel.conf --sentinel\n");
e2641e09 2456 exit(1);
2457}
2458
996d503d 2459void redisAsciiArt(void) {
2460#include "asciilogo.h"
2461 char *buf = zmalloc(1024*16);
6b5daa2d 2462 char *mode = "stand alone";
2463
2464 if (server.cluster_enabled) mode = "cluster";
2465 else if (server.sentinel_mode) mode = "sentinel";
996d503d 2466
2467 snprintf(buf,1024*16,ascii_logo,
2468 REDIS_VERSION,
2469 redisGitSHA1(),
2470 strtol(redisGitDirty(),NULL,10) > 0,
2471 (sizeof(long) == 8) ? "64" : "32",
6b5daa2d 2472 mode, server.port,
996d503d 2473 (long) getpid()
2474 );
2475 redisLogRaw(REDIS_NOTICE|REDIS_LOG_RAW,buf);
2476 zfree(buf);
2477}
2478
633a9410 2479static void sigtermHandler(int sig) {
e2641e09 2480 REDIS_NOTUSED(sig);
2481
a7d12cba 2482 redisLogFromHandler(REDIS_WARNING,"Received SIGTERM, scheduling shutdown...");
e2641e09 2483 server.shutdown_asap = 1;
2484}
2485
633a9410 2486void setupSignalHandlers(void) {
e2641e09 2487 struct sigaction act;
2488
633a9410
PN
2489 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction is used.
2490 * Otherwise, sa_handler is used. */
2491 sigemptyset(&act.sa_mask);
c5757662 2492 act.sa_flags = 0;
e2641e09 2493 act.sa_handler = sigtermHandler;
633a9410 2494 sigaction(SIGTERM, &act, NULL);
e2641e09 2495
633a9410
PN
2496#ifdef HAVE_BACKTRACE
2497 sigemptyset(&act.sa_mask);
3ada43e7 2498 act.sa_flags = SA_NODEFER | SA_RESETHAND | SA_SIGINFO;
633a9410
PN
2499 act.sa_sigaction = sigsegvHandler;
2500 sigaction(SIGSEGV, &act, NULL);
2501 sigaction(SIGBUS, &act, NULL);
2502 sigaction(SIGFPE, &act, NULL);
2503 sigaction(SIGILL, &act, NULL);
2504#endif
2505 return;
e2641e09 2506}
e2641e09 2507
c5166e3f 2508void memtest(size_t megabytes, int passes);
2509
6b5daa2d 2510/* Returns 1 if there is --sentinel among the arguments or if
2511 * argv[0] is exactly "redis-sentinel". */
2512int checkForSentinelMode(int argc, char **argv) {
2513 int j;
2514
2515 if (strstr(argv[0],"redis-sentinel") != NULL) return 1;
2516 for (j = 1; j < argc; j++)
2517 if (!strcmp(argv[j],"--sentinel")) return 1;
2518 return 0;
2519}
2520
2521/* Function called at startup to load RDB or AOF file in memory. */
2522void loadDataFromDisk(void) {
2523 long long start = ustime();
2524 if (server.aof_state == REDIS_AOF_ON) {
2525 if (loadAppendOnlyFile(server.aof_filename) == REDIS_OK)
2526 redisLog(REDIS_NOTICE,"DB loaded from append only file: %.3f seconds",(float)(ustime()-start)/1000000);
2527 } else {
2528 if (rdbLoad(server.rdb_filename) == REDIS_OK) {
2529 redisLog(REDIS_NOTICE,"DB loaded from disk: %.3f seconds",
2530 (float)(ustime()-start)/1000000);
2531 } else if (errno != ENOENT) {
2532 redisLog(REDIS_WARNING,"Fatal error loading the DB. Exiting.");
2533 exit(1);
2534 }
2535 }
2536}
2537
39ca1713 2538int main(int argc, char **argv) {
a48c8d87 2539 struct timeval tv;
39ca1713 2540
06c5523a 2541 /* We need to initialize our libraries, and the server configuration. */
39ca1713 2542 zmalloc_enable_thread_safeness();
a48c8d87 2543 srand(time(NULL)^getpid());
2544 gettimeofday(&tv,NULL);
2545 dictSetHashFunctionSeed(tv.tv_sec^tv.tv_usec^getpid());
6b5daa2d 2546 server.sentinel_mode = checkForSentinelMode(argc,argv);
39ca1713 2547 initServerConfig();
a48c8d87 2548
6b5daa2d 2549 /* We need to init sentinel right now as parsing the configuration file
2550 * in sentinel mode will have the effect of populating the sentinel
2551 * data structures with master nodes to monitor. */
2552 if (server.sentinel_mode) {
2553 initSentinelConfig();
2554 initSentinel();
2555 }
2556
67c6f0f6 2557 if (argc >= 2) {
2558 int j = 1; /* First option to parse in argv[] */
2559 sds options = sdsempty();
2560 char *configfile = NULL;
2561
2562 /* Handle special options --help and --version */
39ca1713 2563 if (strcmp(argv[1], "-v") == 0 ||
2564 strcmp(argv[1], "--version") == 0) version();
4c8bd905 2565 if (strcmp(argv[1], "--help") == 0 ||
2566 strcmp(argv[1], "-h") == 0) usage();
c5166e3f 2567 if (strcmp(argv[1], "--test-memory") == 0) {
2568 if (argc == 3) {
d033ccb0 2569 memtest(atoi(argv[2]),50);
c5166e3f 2570 exit(0);
2571 } else {
2572 fprintf(stderr,"Please specify the amount of memory to test in megabytes.\n");
2573 fprintf(stderr,"Example: ./redis-server --test-memory 4096\n\n");
2574 exit(1);
2575 }
2576 }
2577
67c6f0f6 2578 /* First argument is the config file name? */
2579 if (argv[j][0] != '-' || argv[j][1] != '-')
2580 configfile = argv[j++];
2581 /* All the other options are parsed and conceptually appended to the
2582 * configuration file. For instance --port 6380 will generate the
2583 * string "port 6380\n" to be parsed after the actual file name
2584 * is parsed, if any. */
2585 while(j != argc) {
2586 if (argv[j][0] == '-' && argv[j][1] == '-') {
2587 /* Option name */
2588 if (sdslen(options)) options = sdscat(options,"\n");
2589 options = sdscat(options,argv[j]+2);
2590 options = sdscat(options," ");
2591 } else {
2592 /* Option argument */
2593 options = sdscatrepr(options,argv[j],strlen(argv[j]));
2594 options = sdscat(options," ");
2595 }
2596 j++;
2597 }
39ca1713 2598 resetServerSaveParams();
67c6f0f6 2599 loadServerConfig(configfile,options);
2600 sdsfree(options);
39ca1713 2601 } else {
f1c8661e 2602 redisLog(REDIS_WARNING, "Warning: no config file specified, using the default config. In order to specify a config file use %s /path/to/%s.conf", argv[0], server.sentinel_mode ? "sentinel" : "redis");
39ca1713 2603 }
2604 if (server.daemonize) daemonize();
2605 initServer();
2606 if (server.daemonize) createPidFile();
2607 redisAsciiArt();
6b5daa2d 2608
2609 if (!server.sentinel_mode) {
2610 /* Things only needed when not runnign in Sentinel mode. */
2611 redisLog(REDIS_WARNING,"Server started, Redis version " REDIS_VERSION);
2612 #ifdef __linux__
2613 linuxOvercommitMemoryWarning();
2614 #endif
2615 loadDataFromDisk();
2616 if (server.ipfd > 0)
2617 redisLog(REDIS_NOTICE,"The server is now ready to accept connections on port %d", server.port);
2618 if (server.sofd > 0)
2619 redisLog(REDIS_NOTICE,"The server is now ready to accept connections at %s", server.unixsocket);
39ca1713 2620 }
6b5daa2d 2621
39ca1713 2622 aeSetBeforeSleepProc(server.el,beforeSleep);
2623 aeMain(server.el);
2624 aeDeleteEventLoop(server.el);
2625 return 0;
2626}
2627
e2641e09 2628/* The End */