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