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