]> git.saurik.com Git - redis.git/blob - src/aof.c
changed license to gpl BSD. LOL
[redis.git] / src / aof.c
1 #include "redis.h"
2 #include "bio.h"
3 #include "rio.h"
4
5 #include <signal.h>
6 #include <fcntl.h>
7 #include <sys/stat.h>
8 #include <sys/types.h>
9 #include <sys/time.h>
10 #include <sys/resource.h>
11 #include <sys/wait.h>
12
13 void aofUpdateCurrentSize(void);
14
15 void aof_background_fsync(int fd) {
16 bioCreateBackgroundJob(REDIS_BIO_AOF_FSYNC,(void*)(long)fd,NULL,NULL);
17 }
18
19 /* Called when the user switches from "appendonly yes" to "appendonly no"
20 * at runtime using the CONFIG command. */
21 void stopAppendOnly(void) {
22 flushAppendOnlyFile(1);
23 aof_fsync(server.appendfd);
24 close(server.appendfd);
25
26 server.appendfd = -1;
27 server.appendseldb = -1;
28 server.appendonly = 0;
29 /* rewrite operation in progress? kill it, wait child exit */
30 if (server.bgrewritechildpid != -1) {
31 int statloc;
32
33 if (kill(server.bgrewritechildpid,SIGKILL) != -1)
34 wait3(&statloc,0,NULL);
35 /* reset the buffer accumulating changes while the child saves */
36 sdsfree(server.bgrewritebuf);
37 server.bgrewritebuf = sdsempty();
38 server.bgrewritechildpid = -1;
39 }
40 }
41
42 /* Called when the user switches from "appendonly no" to "appendonly yes"
43 * at runtime using the CONFIG command. */
44 int startAppendOnly(void) {
45 server.appendonly = 1;
46 server.lastfsync = time(NULL);
47 server.appendfd = open(server.appendfilename,O_WRONLY|O_APPEND|O_CREAT,0644);
48 if (server.appendfd == -1) {
49 redisLog(REDIS_WARNING,"Used tried to switch on AOF via CONFIG, but I can't open the AOF file: %s",strerror(errno));
50 return REDIS_ERR;
51 }
52 if (rewriteAppendOnlyFileBackground() == REDIS_ERR) {
53 server.appendonly = 0;
54 close(server.appendfd);
55 redisLog(REDIS_WARNING,"Used tried to switch on AOF via CONFIG, I can't trigger a background AOF rewrite operation. Check the above logs for more info about the error.",strerror(errno));
56 return REDIS_ERR;
57 }
58 return REDIS_OK;
59 }
60
61 /* Write the append only file buffer on disk.
62 *
63 * Since we are required to write the AOF before replying to the client,
64 * and the only way the client socket can get a write is entering when the
65 * the event loop, we accumulate all the AOF writes in a memory
66 * buffer and write it on disk using this function just before entering
67 * the event loop again.
68 *
69 * About the 'force' argument:
70 *
71 * When the fsync policy is set to 'everysec' we may delay the flush if there
72 * is still an fsync() going on in the background thread, since for instance
73 * on Linux write(2) will be blocked by the background fsync anyway.
74 * When this happens we remember that there is some aof buffer to be
75 * flushed ASAP, and will try to do that in the serverCron() function.
76 *
77 * However if force is set to 1 we'll write regardless of the background
78 * fsync. */
79 void flushAppendOnlyFile(int force) {
80 ssize_t nwritten;
81 int sync_in_progress = 0;
82
83 if (sdslen(server.aofbuf) == 0) return;
84
85 if (server.appendfsync == APPENDFSYNC_EVERYSEC)
86 sync_in_progress = bioPendingJobsOfType(REDIS_BIO_AOF_FSYNC) != 0;
87
88 if (server.appendfsync == APPENDFSYNC_EVERYSEC && !force) {
89 /* With this append fsync policy we do background fsyncing.
90 * If the fsync is still in progress we can try to delay
91 * the write for a couple of seconds. */
92 if (sync_in_progress) {
93 if (server.aof_flush_postponed_start == 0) {
94 /* No previous write postponinig, remember that we are
95 * postponing the flush and return. */
96 server.aof_flush_postponed_start = server.unixtime;
97 return;
98 } else if (server.unixtime - server.aof_flush_postponed_start < 2) {
99 /* We were already waiting for fsync to finish, but for less
100 * than two seconds this is still ok. Postpone again. */
101 return;
102 }
103 /* Otherwise fall trough, and go write since we can't wait
104 * over two seconds. */
105 redisLog(REDIS_NOTICE,"Asynchronous AOF fsync is taking too long (disk is busy?). Writing the AOF buffer without waiting for fsync to complete, this may slow down Redis.");
106 }
107 }
108 /* If you are following this code path, then we are going to write so
109 * set reset the postponed flush sentinel to zero. */
110 server.aof_flush_postponed_start = 0;
111
112 /* We want to perform a single write. This should be guaranteed atomic
113 * at least if the filesystem we are writing is a real physical one.
114 * While this will save us against the server being killed I don't think
115 * there is much to do about the whole server stopping for power problems
116 * or alike */
117 nwritten = write(server.appendfd,server.aofbuf,sdslen(server.aofbuf));
118 if (nwritten != (signed)sdslen(server.aofbuf)) {
119 /* Ooops, we are in troubles. The best thing to do for now is
120 * aborting instead of giving the illusion that everything is
121 * working as expected. */
122 if (nwritten == -1) {
123 redisLog(REDIS_WARNING,"Exiting on error writing to the append-only file: %s",strerror(errno));
124 } else {
125 redisLog(REDIS_WARNING,"Exiting on short write while writing to the append-only file: %s",strerror(errno));
126 }
127 exit(1);
128 }
129 server.appendonly_current_size += nwritten;
130
131 /* Re-use AOF buffer when it is small enough. The maximum comes from the
132 * arena size of 4k minus some overhead (but is otherwise arbitrary). */
133 if ((sdslen(server.aofbuf)+sdsavail(server.aofbuf)) < 4000) {
134 sdsclear(server.aofbuf);
135 } else {
136 sdsfree(server.aofbuf);
137 server.aofbuf = sdsempty();
138 }
139
140 /* Don't fsync if no-appendfsync-on-rewrite is set to yes and there are
141 * children doing I/O in the background. */
142 if (server.no_appendfsync_on_rewrite &&
143 (server.bgrewritechildpid != -1 || server.bgsavechildpid != -1))
144 return;
145
146 /* Perform the fsync if needed. */
147 if (server.appendfsync == APPENDFSYNC_ALWAYS) {
148 /* aof_fsync is defined as fdatasync() for Linux in order to avoid
149 * flushing metadata. */
150 aof_fsync(server.appendfd); /* Let's try to get this data on the disk */
151 server.lastfsync = server.unixtime;
152 } else if ((server.appendfsync == APPENDFSYNC_EVERYSEC &&
153 server.unixtime > server.lastfsync)) {
154 if (!sync_in_progress) aof_background_fsync(server.appendfd);
155 server.lastfsync = server.unixtime;
156 }
157 }
158
159 sds catAppendOnlyGenericCommand(sds dst, int argc, robj **argv) {
160 char buf[32];
161 int len, j;
162 robj *o;
163
164 buf[0] = '*';
165 len = 1+ll2string(buf+1,sizeof(buf)-1,argc);
166 buf[len++] = '\r';
167 buf[len++] = '\n';
168 dst = sdscatlen(dst,buf,len);
169
170 for (j = 0; j < argc; j++) {
171 o = getDecodedObject(argv[j]);
172 buf[0] = '$';
173 len = 1+ll2string(buf+1,sizeof(buf)-1,sdslen(o->ptr));
174 buf[len++] = '\r';
175 buf[len++] = '\n';
176 dst = sdscatlen(dst,buf,len);
177 dst = sdscatlen(dst,o->ptr,sdslen(o->ptr));
178 dst = sdscatlen(dst,"\r\n",2);
179 decrRefCount(o);
180 }
181 return dst;
182 }
183
184 sds catAppendOnlyExpireAtCommand(sds buf, robj *key, robj *seconds) {
185 int argc = 3;
186 long when;
187 robj *argv[3];
188
189 /* Make sure we can use strtol */
190 seconds = getDecodedObject(seconds);
191 when = time(NULL)+strtol(seconds->ptr,NULL,10);
192 decrRefCount(seconds);
193
194 argv[0] = createStringObject("EXPIREAT",8);
195 argv[1] = key;
196 argv[2] = createObject(REDIS_STRING,
197 sdscatprintf(sdsempty(),"%ld",when));
198 buf = catAppendOnlyGenericCommand(buf, argc, argv);
199 decrRefCount(argv[0]);
200 decrRefCount(argv[2]);
201 return buf;
202 }
203
204 void feedAppendOnlyFile(struct redisCommand *cmd, int dictid, robj **argv, int argc) {
205 sds buf = sdsempty();
206 robj *tmpargv[3];
207
208 /* The DB this command was targetting is not the same as the last command
209 * we appendend. To issue a SELECT command is needed. */
210 if (dictid != server.appendseldb) {
211 char seldb[64];
212
213 snprintf(seldb,sizeof(seldb),"%d",dictid);
214 buf = sdscatprintf(buf,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
215 (unsigned long)strlen(seldb),seldb);
216 server.appendseldb = dictid;
217 }
218
219 if (cmd->proc == expireCommand) {
220 /* Translate EXPIRE into EXPIREAT */
221 buf = catAppendOnlyExpireAtCommand(buf,argv[1],argv[2]);
222 } else if (cmd->proc == setexCommand) {
223 /* Translate SETEX to SET and EXPIREAT */
224 tmpargv[0] = createStringObject("SET",3);
225 tmpargv[1] = argv[1];
226 tmpargv[2] = argv[3];
227 buf = catAppendOnlyGenericCommand(buf,3,tmpargv);
228 decrRefCount(tmpargv[0]);
229 buf = catAppendOnlyExpireAtCommand(buf,argv[1],argv[2]);
230 } else {
231 buf = catAppendOnlyGenericCommand(buf,argc,argv);
232 }
233
234 /* Append to the AOF buffer. This will be flushed on disk just before
235 * of re-entering the event loop, so before the client will get a
236 * positive reply about the operation performed. */
237 server.aofbuf = sdscatlen(server.aofbuf,buf,sdslen(buf));
238
239 /* If a background append only file rewriting is in progress we want to
240 * accumulate the differences between the child DB and the current one
241 * in a buffer, so that when the child process will do its work we
242 * can append the differences to the new append only file. */
243 if (server.bgrewritechildpid != -1)
244 server.bgrewritebuf = sdscatlen(server.bgrewritebuf,buf,sdslen(buf));
245
246 sdsfree(buf);
247 }
248
249 /* In Redis commands are always executed in the context of a client, so in
250 * order to load the append only file we need to create a fake client. */
251 struct redisClient *createFakeClient(void) {
252 struct redisClient *c = zmalloc(sizeof(*c));
253
254 selectDb(c,0);
255 c->fd = -1;
256 c->querybuf = sdsempty();
257 c->argc = 0;
258 c->argv = NULL;
259 c->bufpos = 0;
260 c->flags = 0;
261 /* We set the fake client as a slave waiting for the synchronization
262 * so that Redis will not try to send replies to this client. */
263 c->replstate = REDIS_REPL_WAIT_BGSAVE_START;
264 c->reply = listCreate();
265 c->watched_keys = listCreate();
266 listSetFreeMethod(c->reply,decrRefCount);
267 listSetDupMethod(c->reply,dupClientReplyValue);
268 initClientMultiState(c);
269 return c;
270 }
271
272 void freeFakeClient(struct redisClient *c) {
273 sdsfree(c->querybuf);
274 listRelease(c->reply);
275 listRelease(c->watched_keys);
276 freeClientMultiState(c);
277 zfree(c);
278 }
279
280 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
281 * error (the append only file is zero-length) REDIS_ERR is returned. On
282 * fatal error an error message is logged and the program exists. */
283 int loadAppendOnlyFile(char *filename) {
284 struct redisClient *fakeClient;
285 FILE *fp = fopen(filename,"r");
286 struct redis_stat sb;
287 int appendonly = server.appendonly;
288 long loops = 0;
289
290 if (fp && redis_fstat(fileno(fp),&sb) != -1 && sb.st_size == 0) {
291 server.appendonly_current_size = 0;
292 fclose(fp);
293 return REDIS_ERR;
294 }
295
296 if (fp == NULL) {
297 redisLog(REDIS_WARNING,"Fatal error: can't open the append log file for reading: %s",strerror(errno));
298 exit(1);
299 }
300
301 /* Temporarily disable AOF, to prevent EXEC from feeding a MULTI
302 * to the same file we're about to read. */
303 server.appendonly = 0;
304
305 fakeClient = createFakeClient();
306 startLoading(fp);
307
308 while(1) {
309 int argc, j;
310 unsigned long len;
311 robj **argv;
312 char buf[128];
313 sds argsds;
314 struct redisCommand *cmd;
315
316 /* Serve the clients from time to time */
317 if (!(loops++ % 1000)) {
318 loadingProgress(ftello(fp));
319 aeProcessEvents(server.el, AE_FILE_EVENTS|AE_DONT_WAIT);
320 }
321
322 if (fgets(buf,sizeof(buf),fp) == NULL) {
323 if (feof(fp))
324 break;
325 else
326 goto readerr;
327 }
328 if (buf[0] != '*') goto fmterr;
329 argc = atoi(buf+1);
330 if (argc < 1) goto fmterr;
331
332 argv = zmalloc(sizeof(robj*)*argc);
333 for (j = 0; j < argc; j++) {
334 if (fgets(buf,sizeof(buf),fp) == NULL) goto readerr;
335 if (buf[0] != '$') goto fmterr;
336 len = strtol(buf+1,NULL,10);
337 argsds = sdsnewlen(NULL,len);
338 if (len && fread(argsds,len,1,fp) == 0) goto fmterr;
339 argv[j] = createObject(REDIS_STRING,argsds);
340 if (fread(buf,2,1,fp) == 0) goto fmterr; /* discard CRLF */
341 }
342
343 /* Command lookup */
344 cmd = lookupCommand(argv[0]->ptr);
345 if (!cmd) {
346 redisLog(REDIS_WARNING,"Unknown command '%s' reading the append only file", argv[0]->ptr);
347 exit(1);
348 }
349 /* Run the command in the context of a fake client */
350 fakeClient->argc = argc;
351 fakeClient->argv = argv;
352 cmd->proc(fakeClient);
353
354 /* The fake client should not have a reply */
355 redisAssert(fakeClient->bufpos == 0 && listLength(fakeClient->reply) == 0);
356 /* The fake client should never get blocked */
357 redisAssert((fakeClient->flags & REDIS_BLOCKED) == 0);
358
359 /* Clean up. Command code may have changed argv/argc so we use the
360 * argv/argc of the client instead of the local variables. */
361 for (j = 0; j < fakeClient->argc; j++)
362 decrRefCount(fakeClient->argv[j]);
363 zfree(fakeClient->argv);
364 }
365
366 /* This point can only be reached when EOF is reached without errors.
367 * If the client is in the middle of a MULTI/EXEC, log error and quit. */
368 if (fakeClient->flags & REDIS_MULTI) goto readerr;
369
370 fclose(fp);
371 freeFakeClient(fakeClient);
372 server.appendonly = appendonly;
373 stopLoading();
374 aofUpdateCurrentSize();
375 server.auto_aofrewrite_base_size = server.appendonly_current_size;
376 return REDIS_OK;
377
378 readerr:
379 if (feof(fp)) {
380 redisLog(REDIS_WARNING,"Unexpected end of file reading the append only file");
381 } else {
382 redisLog(REDIS_WARNING,"Unrecoverable error reading the append only file: %s", strerror(errno));
383 }
384 exit(1);
385 fmterr:
386 redisLog(REDIS_WARNING,"Bad file format reading the append only file: make a backup of your AOF file, then use ./redis-check-aof --fix <filename>");
387 exit(1);
388 }
389
390 /* Delegate writing an object to writing a bulk string or bulk long long.
391 * This is not placed in rio.c since that adds the redis.h dependency. */
392 int rioWriteBulkObject(rio *r, robj *obj) {
393 /* Avoid using getDecodedObject to help copy-on-write (we are often
394 * in a child process when this function is called). */
395 if (obj->encoding == REDIS_ENCODING_INT) {
396 return rioWriteBulkLongLong(r,(long)obj->ptr);
397 } else if (obj->encoding == REDIS_ENCODING_RAW) {
398 return rioWriteBulkString(r,obj->ptr,sdslen(obj->ptr));
399 } else {
400 redisPanic("Unknown string encoding");
401 }
402 }
403
404 /* Write a sequence of commands able to fully rebuild the dataset into
405 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
406 int rewriteAppendOnlyFile(char *filename) {
407 dictIterator *di = NULL;
408 dictEntry *de;
409 rio aof;
410 FILE *fp;
411 char tmpfile[256];
412 int j;
413 time_t now = time(NULL);
414
415 /* Note that we have to use a different temp name here compared to the
416 * one used by rewriteAppendOnlyFileBackground() function. */
417 snprintf(tmpfile,256,"temp-rewriteaof-%d.aof", (int) getpid());
418 fp = fopen(tmpfile,"w");
419 if (!fp) {
420 redisLog(REDIS_WARNING, "Failed rewriting the append only file: %s", strerror(errno));
421 return REDIS_ERR;
422 }
423
424 rioInitWithFile(&aof,fp);
425 for (j = 0; j < server.dbnum; j++) {
426 char selectcmd[] = "*2\r\n$6\r\nSELECT\r\n";
427 redisDb *db = server.db+j;
428 dict *d = db->dict;
429 if (dictSize(d) == 0) continue;
430 di = dictGetSafeIterator(d);
431 if (!di) {
432 fclose(fp);
433 return REDIS_ERR;
434 }
435
436 /* SELECT the new DB */
437 if (rioWrite(&aof,selectcmd,sizeof(selectcmd)-1) == 0) goto werr;
438 if (rioWriteBulkLongLong(&aof,j) == 0) goto werr;
439
440 /* Iterate this DB writing every entry */
441 while((de = dictNext(di)) != NULL) {
442 sds keystr;
443 robj key, *o;
444 time_t expiretime;
445
446 keystr = dictGetEntryKey(de);
447 o = dictGetEntryVal(de);
448 initStaticStringObject(key,keystr);
449
450 expiretime = getExpire(db,&key);
451
452 /* Save the key and associated value */
453 if (o->type == REDIS_STRING) {
454 /* Emit a SET command */
455 char cmd[]="*3\r\n$3\r\nSET\r\n";
456 if (rioWrite(&aof,cmd,sizeof(cmd)-1) == 0) goto werr;
457 /* Key and value */
458 if (rioWriteBulkObject(&aof,&key) == 0) goto werr;
459 if (rioWriteBulkObject(&aof,o) == 0) goto werr;
460 } else if (o->type == REDIS_LIST) {
461 /* Emit the RPUSHes needed to rebuild the list */
462 char cmd[]="*3\r\n$5\r\nRPUSH\r\n";
463 if (o->encoding == REDIS_ENCODING_ZIPLIST) {
464 unsigned char *zl = o->ptr;
465 unsigned char *p = ziplistIndex(zl,0);
466 unsigned char *vstr;
467 unsigned int vlen;
468 long long vlong;
469
470 while(ziplistGet(p,&vstr,&vlen,&vlong)) {
471 if (rioWrite(&aof,cmd,sizeof(cmd)-1) == 0) goto werr;
472 if (rioWriteBulkObject(&aof,&key) == 0) goto werr;
473 if (vstr) {
474 if (rioWriteBulkString(&aof,(char*)vstr,vlen) == 0)
475 goto werr;
476 } else {
477 if (rioWriteBulkLongLong(&aof,vlong) == 0)
478 goto werr;
479 }
480 p = ziplistNext(zl,p);
481 }
482 } else if (o->encoding == REDIS_ENCODING_LINKEDLIST) {
483 list *list = o->ptr;
484 listNode *ln;
485 listIter li;
486
487 listRewind(list,&li);
488 while((ln = listNext(&li))) {
489 robj *eleobj = listNodeValue(ln);
490
491 if (rioWrite(&aof,cmd,sizeof(cmd)-1) == 0) goto werr;
492 if (rioWriteBulkObject(&aof,&key) == 0) goto werr;
493 if (rioWriteBulkObject(&aof,eleobj) == 0) goto werr;
494 }
495 } else {
496 redisPanic("Unknown list encoding");
497 }
498 } else if (o->type == REDIS_SET) {
499 char cmd[]="*3\r\n$4\r\nSADD\r\n";
500
501 /* Emit the SADDs needed to rebuild the set */
502 if (o->encoding == REDIS_ENCODING_INTSET) {
503 int ii = 0;
504 int64_t llval;
505 while(intsetGet(o->ptr,ii++,&llval)) {
506 if (rioWrite(&aof,cmd,sizeof(cmd)-1) == 0) goto werr;
507 if (rioWriteBulkObject(&aof,&key) == 0) goto werr;
508 if (rioWriteBulkLongLong(&aof,llval) == 0) goto werr;
509 }
510 } else if (o->encoding == REDIS_ENCODING_HT) {
511 dictIterator *di = dictGetIterator(o->ptr);
512 dictEntry *de;
513 while((de = dictNext(di)) != NULL) {
514 robj *eleobj = dictGetEntryKey(de);
515 if (rioWrite(&aof,cmd,sizeof(cmd)-1) == 0) goto werr;
516 if (rioWriteBulkObject(&aof,&key) == 0) goto werr;
517 if (rioWriteBulkObject(&aof,eleobj) == 0) goto werr;
518 }
519 dictReleaseIterator(di);
520 } else {
521 redisPanic("Unknown set encoding");
522 }
523 } else if (o->type == REDIS_ZSET) {
524 /* Emit the ZADDs needed to rebuild the sorted set */
525 char cmd[]="*4\r\n$4\r\nZADD\r\n";
526
527 if (o->encoding == REDIS_ENCODING_ZIPLIST) {
528 unsigned char *zl = o->ptr;
529 unsigned char *eptr, *sptr;
530 unsigned char *vstr;
531 unsigned int vlen;
532 long long vll;
533 double score;
534
535 eptr = ziplistIndex(zl,0);
536 redisAssert(eptr != NULL);
537 sptr = ziplistNext(zl,eptr);
538 redisAssert(sptr != NULL);
539
540 while (eptr != NULL) {
541 redisAssert(ziplistGet(eptr,&vstr,&vlen,&vll));
542 score = zzlGetScore(sptr);
543
544 if (rioWrite(&aof,cmd,sizeof(cmd)-1) == 0) goto werr;
545 if (rioWriteBulkObject(&aof,&key) == 0) goto werr;
546 if (rioWriteBulkDouble(&aof,score) == 0) goto werr;
547 if (vstr != NULL) {
548 if (rioWriteBulkString(&aof,(char*)vstr,vlen) == 0)
549 goto werr;
550 } else {
551 if (rioWriteBulkLongLong(&aof,vll) == 0)
552 goto werr;
553 }
554 zzlNext(zl,&eptr,&sptr);
555 }
556 } else if (o->encoding == REDIS_ENCODING_SKIPLIST) {
557 zset *zs = o->ptr;
558 dictIterator *di = dictGetIterator(zs->dict);
559 dictEntry *de;
560
561 while((de = dictNext(di)) != NULL) {
562 robj *eleobj = dictGetEntryKey(de);
563 double *score = dictGetEntryVal(de);
564
565 if (rioWrite(&aof,cmd,sizeof(cmd)-1) == 0) goto werr;
566 if (rioWriteBulkObject(&aof,&key) == 0) goto werr;
567 if (rioWriteBulkDouble(&aof,*score) == 0) goto werr;
568 if (rioWriteBulkObject(&aof,eleobj) == 0) goto werr;
569 }
570 dictReleaseIterator(di);
571 } else {
572 redisPanic("Unknown sorted set encoding");
573 }
574 } else if (o->type == REDIS_HASH) {
575 char cmd[]="*4\r\n$4\r\nHSET\r\n";
576
577 /* Emit the HSETs needed to rebuild the hash */
578 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
579 unsigned char *p = zipmapRewind(o->ptr);
580 unsigned char *field, *val;
581 unsigned int flen, vlen;
582
583 while((p = zipmapNext(p,&field,&flen,&val,&vlen)) != NULL) {
584 if (rioWrite(&aof,cmd,sizeof(cmd)-1) == 0) goto werr;
585 if (rioWriteBulkObject(&aof,&key) == 0) goto werr;
586 if (rioWriteBulkString(&aof,(char*)field,flen) == 0)
587 goto werr;
588 if (rioWriteBulkString(&aof,(char*)val,vlen) == 0)
589 goto werr;
590 }
591 } else {
592 dictIterator *di = dictGetIterator(o->ptr);
593 dictEntry *de;
594
595 while((de = dictNext(di)) != NULL) {
596 robj *field = dictGetEntryKey(de);
597 robj *val = dictGetEntryVal(de);
598
599 if (rioWrite(&aof,cmd,sizeof(cmd)-1) == 0) goto werr;
600 if (rioWriteBulkObject(&aof,&key) == 0) goto werr;
601 if (rioWriteBulkObject(&aof,field) == 0) goto werr;
602 if (rioWriteBulkObject(&aof,val) == 0) goto werr;
603 }
604 dictReleaseIterator(di);
605 }
606 } else {
607 redisPanic("Unknown object type");
608 }
609 /* Save the expire time */
610 if (expiretime != -1) {
611 char cmd[]="*3\r\n$8\r\nEXPIREAT\r\n";
612 /* If this key is already expired skip it */
613 if (expiretime < now) continue;
614 if (rioWrite(&aof,cmd,sizeof(cmd)-1) == 0) goto werr;
615 if (rioWriteBulkObject(&aof,&key) == 0) goto werr;
616 if (rioWriteBulkLongLong(&aof,expiretime) == 0) goto werr;
617 }
618 }
619 dictReleaseIterator(di);
620 }
621
622 /* Make sure data will not remain on the OS's output buffers */
623 fflush(fp);
624 aof_fsync(fileno(fp));
625 fclose(fp);
626
627 /* Use RENAME to make sure the DB file is changed atomically only
628 * if the generate DB file is ok. */
629 if (rename(tmpfile,filename) == -1) {
630 redisLog(REDIS_WARNING,"Error moving temp append only file on the final destination: %s", strerror(errno));
631 unlink(tmpfile);
632 return REDIS_ERR;
633 }
634 redisLog(REDIS_NOTICE,"SYNC append only file rewrite performed");
635 return REDIS_OK;
636
637 werr:
638 fclose(fp);
639 unlink(tmpfile);
640 redisLog(REDIS_WARNING,"Write error writing append only file on disk: %s", strerror(errno));
641 if (di) dictReleaseIterator(di);
642 return REDIS_ERR;
643 }
644
645 /* This is how rewriting of the append only file in background works:
646 *
647 * 1) The user calls BGREWRITEAOF
648 * 2) Redis calls this function, that forks():
649 * 2a) the child rewrite the append only file in a temp file.
650 * 2b) the parent accumulates differences in server.bgrewritebuf.
651 * 3) When the child finished '2a' exists.
652 * 4) The parent will trap the exit code, if it's OK, will append the
653 * data accumulated into server.bgrewritebuf into the temp file, and
654 * finally will rename(2) the temp file in the actual file name.
655 * The the new file is reopened as the new append only file. Profit!
656 */
657 int rewriteAppendOnlyFileBackground(void) {
658 pid_t childpid;
659 long long start;
660
661 if (server.bgrewritechildpid != -1) return REDIS_ERR;
662 start = ustime();
663 if ((childpid = fork()) == 0) {
664 char tmpfile[256];
665
666 /* Child */
667 if (server.ipfd > 0) close(server.ipfd);
668 if (server.sofd > 0) close(server.sofd);
669 snprintf(tmpfile,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
670 if (rewriteAppendOnlyFile(tmpfile) == REDIS_OK) {
671 _exit(0);
672 } else {
673 _exit(1);
674 }
675 } else {
676 /* Parent */
677 server.stat_fork_time = ustime()-start;
678 if (childpid == -1) {
679 redisLog(REDIS_WARNING,
680 "Can't rewrite append only file in background: fork: %s",
681 strerror(errno));
682 return REDIS_ERR;
683 }
684 redisLog(REDIS_NOTICE,
685 "Background append only file rewriting started by pid %d",childpid);
686 server.bgrewritechildpid = childpid;
687 updateDictResizePolicy();
688 /* We set appendseldb to -1 in order to force the next call to the
689 * feedAppendOnlyFile() to issue a SELECT command, so the differences
690 * accumulated by the parent into server.bgrewritebuf will start
691 * with a SELECT statement and it will be safe to merge. */
692 server.appendseldb = -1;
693 return REDIS_OK;
694 }
695 return REDIS_OK; /* unreached */
696 }
697
698 void bgrewriteaofCommand(redisClient *c) {
699 if (server.bgrewritechildpid != -1) {
700 addReplyError(c,"Background append only file rewriting already in progress");
701 } else if (server.bgsavechildpid != -1) {
702 server.aofrewrite_scheduled = 1;
703 addReplyStatus(c,"Background append only file rewriting scheduled");
704 } else if (rewriteAppendOnlyFileBackground() == REDIS_OK) {
705 addReplyStatus(c,"Background append only file rewriting started");
706 } else {
707 addReply(c,shared.err);
708 }
709 }
710
711 void aofRemoveTempFile(pid_t childpid) {
712 char tmpfile[256];
713
714 snprintf(tmpfile,256,"temp-rewriteaof-bg-%d.aof", (int) childpid);
715 unlink(tmpfile);
716 }
717
718 /* Update the server.appendonly_current_size filed explicitly using stat(2)
719 * to check the size of the file. This is useful after a rewrite or after
720 * a restart, normally the size is updated just adding the write length
721 * to the current lenght, that is much faster. */
722 void aofUpdateCurrentSize(void) {
723 struct redis_stat sb;
724
725 if (redis_fstat(server.appendfd,&sb) == -1) {
726 redisLog(REDIS_WARNING,"Unable to check the AOF length: %s",
727 strerror(errno));
728 } else {
729 server.appendonly_current_size = sb.st_size;
730 }
731 }
732
733 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
734 * Handle this. */
735 void backgroundRewriteDoneHandler(int exitcode, int bysignal) {
736 if (!bysignal && exitcode == 0) {
737 int newfd, oldfd;
738 int nwritten;
739 char tmpfile[256];
740 long long now = ustime();
741
742 redisLog(REDIS_NOTICE,
743 "Background AOF rewrite terminated with success");
744
745 /* Flush the differences accumulated by the parent to the
746 * rewritten AOF. */
747 snprintf(tmpfile,256,"temp-rewriteaof-bg-%d.aof",
748 (int)server.bgrewritechildpid);
749 newfd = open(tmpfile,O_WRONLY|O_APPEND);
750 if (newfd == -1) {
751 redisLog(REDIS_WARNING,
752 "Unable to open the temporary AOF produced by the child: %s", strerror(errno));
753 goto cleanup;
754 }
755
756 nwritten = write(newfd,server.bgrewritebuf,sdslen(server.bgrewritebuf));
757 if (nwritten != (signed)sdslen(server.bgrewritebuf)) {
758 if (nwritten == -1) {
759 redisLog(REDIS_WARNING,
760 "Error trying to flush the parent diff to the rewritten AOF: %s", strerror(errno));
761 } else {
762 redisLog(REDIS_WARNING,
763 "Short write trying to flush the parent diff to the rewritten AOF: %s", strerror(errno));
764 }
765 close(newfd);
766 goto cleanup;
767 }
768
769 redisLog(REDIS_NOTICE,
770 "Parent diff successfully flushed to the rewritten AOF (%lu bytes)", nwritten);
771
772 /* The only remaining thing to do is to rename the temporary file to
773 * the configured file and switch the file descriptor used to do AOF
774 * writes. We don't want close(2) or rename(2) calls to block the
775 * server on old file deletion.
776 *
777 * There are two possible scenarios:
778 *
779 * 1) AOF is DISABLED and this was a one time rewrite. The temporary
780 * file will be renamed to the configured file. When this file already
781 * exists, it will be unlinked, which may block the server.
782 *
783 * 2) AOF is ENABLED and the rewritten AOF will immediately start
784 * receiving writes. After the temporary file is renamed to the
785 * configured file, the original AOF file descriptor will be closed.
786 * Since this will be the last reference to that file, closing it
787 * causes the underlying file to be unlinked, which may block the
788 * server.
789 *
790 * To mitigate the blocking effect of the unlink operation (either
791 * caused by rename(2) in scenario 1, or by close(2) in scenario 2), we
792 * use a background thread to take care of this. First, we
793 * make scenario 1 identical to scenario 2 by opening the target file
794 * when it exists. The unlink operation after the rename(2) will then
795 * be executed upon calling close(2) for its descriptor. Everything to
796 * guarantee atomicity for this switch has already happened by then, so
797 * we don't care what the outcome or duration of that close operation
798 * is, as long as the file descriptor is released again. */
799 if (server.appendfd == -1) {
800 /* AOF disabled */
801
802 /* Don't care if this fails: oldfd will be -1 and we handle that.
803 * One notable case of -1 return is if the old file does
804 * not exist. */
805 oldfd = open(server.appendfilename,O_RDONLY|O_NONBLOCK);
806 } else {
807 /* AOF enabled */
808 oldfd = -1; /* We'll set this to the current AOF filedes later. */
809 }
810
811 /* Rename the temporary file. This will not unlink the target file if
812 * it exists, because we reference it with "oldfd". */
813 if (rename(tmpfile,server.appendfilename) == -1) {
814 redisLog(REDIS_WARNING,
815 "Error trying to rename the temporary AOF: %s", strerror(errno));
816 close(newfd);
817 if (oldfd != -1) close(oldfd);
818 goto cleanup;
819 }
820
821 if (server.appendfd == -1) {
822 /* AOF disabled, we don't need to set the AOF file descriptor
823 * to this new file, so we can close it. */
824 close(newfd);
825 } else {
826 /* AOF enabled, replace the old fd with the new one. */
827 oldfd = server.appendfd;
828 server.appendfd = newfd;
829 if (server.appendfsync == APPENDFSYNC_ALWAYS)
830 aof_fsync(newfd);
831 else if (server.appendfsync == APPENDFSYNC_EVERYSEC)
832 aof_background_fsync(newfd);
833 server.appendseldb = -1; /* Make sure SELECT is re-issued */
834 aofUpdateCurrentSize();
835 server.auto_aofrewrite_base_size = server.appendonly_current_size;
836
837 /* Clear regular AOF buffer since its contents was just written to
838 * the new AOF from the background rewrite buffer. */
839 sdsfree(server.aofbuf);
840 server.aofbuf = sdsempty();
841 }
842
843 redisLog(REDIS_NOTICE, "Background AOF rewrite successful");
844
845 /* Asynchronously close the overwritten AOF. */
846 if (oldfd != -1) bioCreateBackgroundJob(REDIS_BIO_CLOSE_FILE,(void*)(long)oldfd,NULL,NULL);
847
848 redisLog(REDIS_VERBOSE,
849 "Background AOF rewrite signal handler took %lldus", ustime()-now);
850 } else if (!bysignal && exitcode != 0) {
851 redisLog(REDIS_WARNING,
852 "Background AOF rewrite terminated with error");
853 } else {
854 redisLog(REDIS_WARNING,
855 "Background AOF rewrite terminated by signal %d", bysignal);
856 }
857
858 cleanup:
859 sdsfree(server.bgrewritebuf);
860 server.bgrewritebuf = sdsempty();
861 aofRemoveTempFile(server.bgrewritechildpid);
862 server.bgrewritechildpid = -1;
863 }