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