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