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