10 #include <sys/resource.h>
13 void aofUpdateCurrentSize(void);
15 void aof_background_fsync(int fd
) {
16 bioCreateBackgroundJob(REDIS_BIO_AOF_FSYNC
,(void*)(long)fd
,NULL
,NULL
);
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
);
27 server
.appendseldb
= -1;
28 server
.appendonly
= 0;
29 /* rewrite operation in progress? kill it, wait child exit */
30 if (server
.bgrewritechildpid
!= -1) {
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;
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
));
52 if (rewriteAppendOnlyFileBackground() == REDIS_ERR
) {
53 server
.appendonly
= 0;
54 close(server
.appendfd
);
55 redisLog(REDIS_WARNING
,"User tried turning on AOF with CONFIG SET but I can't trigger a background AOF rewrite operation. Check the above logs for more info about the error.");
61 /* Write the append only file buffer on disk.
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.
69 * About the 'force' argument:
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.
77 * However if force is set to 1 we'll write regardless of the background
79 void flushAppendOnlyFile(int force
) {
81 int sync_in_progress
= 0;
83 if (sdslen(server
.aofbuf
) == 0) return;
85 if (server
.appendfsync
== APPENDFSYNC_EVERYSEC
)
86 sync_in_progress
= bioPendingJobsOfType(REDIS_BIO_AOF_FSYNC
) != 0;
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
;
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. */
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.");
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;
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
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
));
125 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
129 server
.appendonly_current_size
+= nwritten
;
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
);
136 sdsfree(server
.aofbuf
);
137 server
.aofbuf
= sdsempty();
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))
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
;
159 sds
catAppendOnlyGenericCommand(sds dst
, int argc
, robj
**argv
) {
165 len
= 1+ll2string(buf
+1,sizeof(buf
)-1,argc
);
168 dst
= sdscatlen(dst
,buf
,len
);
170 for (j
= 0; j
< argc
; j
++) {
171 o
= getDecodedObject(argv
[j
]);
173 len
= 1+ll2string(buf
+1,sizeof(buf
)-1,sdslen(o
->ptr
));
176 dst
= sdscatlen(dst
,buf
,len
);
177 dst
= sdscatlen(dst
,o
->ptr
,sdslen(o
->ptr
));
178 dst
= sdscatlen(dst
,"\r\n",2);
184 sds
catAppendOnlyExpireAtCommand(sds buf
, robj
*key
, robj
*seconds
) {
189 /* Make sure we can use strtol */
190 seconds
= getDecodedObject(seconds
);
191 when
= time(NULL
)+strtol(seconds
->ptr
,NULL
,10);
192 decrRefCount(seconds
);
194 argv
[0] = createStringObject("EXPIREAT",8);
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]);
204 void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
205 sds buf
= sdsempty();
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
) {
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
;
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]);
231 buf
= catAppendOnlyGenericCommand(buf
,argc
,argv
);
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
));
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
));
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
));
256 c
->querybuf
= sdsempty();
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
);
272 void freeFakeClient(struct redisClient
*c
) {
273 sdsfree(c
->querybuf
);
274 listRelease(c
->reply
);
275 listRelease(c
->watched_keys
);
276 freeClientMultiState(c
);
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
;
290 if (fp
&& redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0) {
291 server
.appendonly_current_size
= 0;
297 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
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;
305 fakeClient
= createFakeClient();
314 struct redisCommand
*cmd
;
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
);
322 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
328 if (buf
[0] != '*') goto fmterr
;
330 if (argc
< 1) goto fmterr
;
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 */
344 cmd
= lookupCommand(argv
[0]->ptr
);
346 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
349 /* Run the command in the context of a fake client */
350 fakeClient
->argc
= argc
;
351 fakeClient
->argv
= argv
;
352 cmd
->proc(fakeClient
);
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);
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
);
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
;
371 freeFakeClient(fakeClient
);
372 server
.appendonly
= appendonly
;
374 aofUpdateCurrentSize();
375 server
.auto_aofrewrite_base_size
= server
.appendonly_current_size
;
380 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
382 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
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>");
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
));
400 redisPanic("Unknown string encoding");
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
;
413 time_t now
= time(NULL
);
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");
420 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
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
;
429 if (dictSize(d
) == 0) continue;
430 di
= dictGetSafeIterator(d
);
436 /* SELECT the new DB */
437 if (rioWrite(&aof
,selectcmd
,sizeof(selectcmd
)-1) == 0) goto werr
;
438 if (rioWriteBulkLongLong(&aof
,j
) == 0) goto werr
;
440 /* Iterate this DB writing every entry */
441 while((de
= dictNext(di
)) != NULL
) {
446 keystr
= dictGetKey(de
);
448 initStaticStringObject(key
,keystr
);
450 expiretime
= getExpire(db
,&key
);
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
;
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);
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
;
474 if (rioWriteBulkString(&aof
,(char*)vstr
,vlen
) == 0)
477 if (rioWriteBulkLongLong(&aof
,vlong
) == 0)
480 p
= ziplistNext(zl
,p
);
482 } else if (o
->encoding
== REDIS_ENCODING_LINKEDLIST
) {
487 listRewind(list
,&li
);
488 while((ln
= listNext(&li
))) {
489 robj
*eleobj
= listNodeValue(ln
);
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
;
496 redisPanic("Unknown list encoding");
498 } else if (o
->type
== REDIS_SET
) {
499 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
501 /* Emit the SADDs needed to rebuild the set */
502 if (o
->encoding
== REDIS_ENCODING_INTSET
) {
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
;
510 } else if (o
->encoding
== REDIS_ENCODING_HT
) {
511 dictIterator
*di
= dictGetIterator(o
->ptr
);
513 while((de
= dictNext(di
)) != NULL
) {
514 robj
*eleobj
= dictGetKey(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
;
519 dictReleaseIterator(di
);
521 redisPanic("Unknown set encoding");
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";
527 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
) {
528 unsigned char *zl
= o
->ptr
;
529 unsigned char *eptr
, *sptr
;
535 eptr
= ziplistIndex(zl
,0);
536 redisAssert(eptr
!= NULL
);
537 sptr
= ziplistNext(zl
,eptr
);
538 redisAssert(sptr
!= NULL
);
540 while (eptr
!= NULL
) {
541 redisAssert(ziplistGet(eptr
,&vstr
,&vlen
,&vll
));
542 score
= zzlGetScore(sptr
);
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
;
548 if (rioWriteBulkString(&aof
,(char*)vstr
,vlen
) == 0)
551 if (rioWriteBulkLongLong(&aof
,vll
) == 0)
554 zzlNext(zl
,&eptr
,&sptr
);
556 } else if (o
->encoding
== REDIS_ENCODING_SKIPLIST
) {
558 dictIterator
*di
= dictGetIterator(zs
->dict
);
561 while((de
= dictNext(di
)) != NULL
) {
562 robj
*eleobj
= dictGetKey(de
);
563 double *score
= dictGetVal(de
);
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
;
570 dictReleaseIterator(di
);
572 redisPanic("Unknown sorted set encoding");
574 } else if (o
->type
== REDIS_HASH
) {
575 char cmd
[]="*4\r\n$4\r\nHSET\r\n";
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
;
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)
588 if (rioWriteBulkString(&aof
,(char*)val
,vlen
) == 0)
592 dictIterator
*di
= dictGetIterator(o
->ptr
);
595 while((de
= dictNext(di
)) != NULL
) {
596 robj
*field
= dictGetKey(de
);
597 robj
*val
= dictGetVal(de
);
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
;
604 dictReleaseIterator(di
);
607 redisPanic("Unknown object type");
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
/1000) == 0) goto werr
;
619 dictReleaseIterator(di
);
622 /* Make sure data will not remain on the OS's output buffers */
624 aof_fsync(fileno(fp
));
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
));
634 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
640 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
641 if (di
) dictReleaseIterator(di
);
645 /* This is how rewriting of the append only file in background works:
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!
657 int rewriteAppendOnlyFileBackground(void) {
661 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
663 if ((childpid
= fork()) == 0) {
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
) {
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",
684 redisLog(REDIS_NOTICE
,
685 "Background append only file rewriting started by pid %d",childpid
);
686 server
.aofrewrite_scheduled
= 0;
687 server
.bgrewritechildpid
= childpid
;
688 updateDictResizePolicy();
689 /* We set appendseldb to -1 in order to force the next call to the
690 * feedAppendOnlyFile() to issue a SELECT command, so the differences
691 * accumulated by the parent into server.bgrewritebuf will start
692 * with a SELECT statement and it will be safe to merge. */
693 server
.appendseldb
= -1;
696 return REDIS_OK
; /* unreached */
699 void bgrewriteaofCommand(redisClient
*c
) {
700 if (server
.bgrewritechildpid
!= -1) {
701 addReplyError(c
,"Background append only file rewriting already in progress");
702 } else if (server
.bgsavechildpid
!= -1) {
703 server
.aofrewrite_scheduled
= 1;
704 addReplyStatus(c
,"Background append only file rewriting scheduled");
705 } else if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
706 addReplyStatus(c
,"Background append only file rewriting started");
708 addReply(c
,shared
.err
);
712 void aofRemoveTempFile(pid_t childpid
) {
715 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
719 /* Update the server.appendonly_current_size filed explicitly using stat(2)
720 * to check the size of the file. This is useful after a rewrite or after
721 * a restart, normally the size is updated just adding the write length
722 * to the current lenght, that is much faster. */
723 void aofUpdateCurrentSize(void) {
724 struct redis_stat sb
;
726 if (redis_fstat(server
.appendfd
,&sb
) == -1) {
727 redisLog(REDIS_WARNING
,"Unable to check the AOF length: %s",
730 server
.appendonly_current_size
= sb
.st_size
;
734 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
736 void backgroundRewriteDoneHandler(int exitcode
, int bysignal
) {
737 if (!bysignal
&& exitcode
== 0) {
741 long long now
= ustime();
743 redisLog(REDIS_NOTICE
,
744 "Background AOF rewrite terminated with success");
746 /* Flush the differences accumulated by the parent to the
748 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof",
749 (int)server
.bgrewritechildpid
);
750 newfd
= open(tmpfile
,O_WRONLY
|O_APPEND
);
752 redisLog(REDIS_WARNING
,
753 "Unable to open the temporary AOF produced by the child: %s", strerror(errno
));
757 nwritten
= write(newfd
,server
.bgrewritebuf
,sdslen(server
.bgrewritebuf
));
758 if (nwritten
!= (signed)sdslen(server
.bgrewritebuf
)) {
759 if (nwritten
== -1) {
760 redisLog(REDIS_WARNING
,
761 "Error trying to flush the parent diff to the rewritten AOF: %s", strerror(errno
));
763 redisLog(REDIS_WARNING
,
764 "Short write trying to flush the parent diff to the rewritten AOF: %s", strerror(errno
));
770 redisLog(REDIS_NOTICE
,
771 "Parent diff successfully flushed to the rewritten AOF (%lu bytes)", nwritten
);
773 /* The only remaining thing to do is to rename the temporary file to
774 * the configured file and switch the file descriptor used to do AOF
775 * writes. We don't want close(2) or rename(2) calls to block the
776 * server on old file deletion.
778 * There are two possible scenarios:
780 * 1) AOF is DISABLED and this was a one time rewrite. The temporary
781 * file will be renamed to the configured file. When this file already
782 * exists, it will be unlinked, which may block the server.
784 * 2) AOF is ENABLED and the rewritten AOF will immediately start
785 * receiving writes. After the temporary file is renamed to the
786 * configured file, the original AOF file descriptor will be closed.
787 * Since this will be the last reference to that file, closing it
788 * causes the underlying file to be unlinked, which may block the
791 * To mitigate the blocking effect of the unlink operation (either
792 * caused by rename(2) in scenario 1, or by close(2) in scenario 2), we
793 * use a background thread to take care of this. First, we
794 * make scenario 1 identical to scenario 2 by opening the target file
795 * when it exists. The unlink operation after the rename(2) will then
796 * be executed upon calling close(2) for its descriptor. Everything to
797 * guarantee atomicity for this switch has already happened by then, so
798 * we don't care what the outcome or duration of that close operation
799 * is, as long as the file descriptor is released again. */
800 if (server
.appendfd
== -1) {
803 /* Don't care if this fails: oldfd will be -1 and we handle that.
804 * One notable case of -1 return is if the old file does
806 oldfd
= open(server
.appendfilename
,O_RDONLY
|O_NONBLOCK
);
809 oldfd
= -1; /* We'll set this to the current AOF filedes later. */
812 /* Rename the temporary file. This will not unlink the target file if
813 * it exists, because we reference it with "oldfd". */
814 if (rename(tmpfile
,server
.appendfilename
) == -1) {
815 redisLog(REDIS_WARNING
,
816 "Error trying to rename the temporary AOF: %s", strerror(errno
));
818 if (oldfd
!= -1) close(oldfd
);
822 if (server
.appendfd
== -1) {
823 /* AOF disabled, we don't need to set the AOF file descriptor
824 * to this new file, so we can close it. */
827 /* AOF enabled, replace the old fd with the new one. */
828 oldfd
= server
.appendfd
;
829 server
.appendfd
= newfd
;
830 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
)
832 else if (server
.appendfsync
== APPENDFSYNC_EVERYSEC
)
833 aof_background_fsync(newfd
);
834 server
.appendseldb
= -1; /* Make sure SELECT is re-issued */
835 aofUpdateCurrentSize();
836 server
.auto_aofrewrite_base_size
= server
.appendonly_current_size
;
838 /* Clear regular AOF buffer since its contents was just written to
839 * the new AOF from the background rewrite buffer. */
840 sdsfree(server
.aofbuf
);
841 server
.aofbuf
= sdsempty();
844 redisLog(REDIS_NOTICE
, "Background AOF rewrite successful");
846 /* Asynchronously close the overwritten AOF. */
847 if (oldfd
!= -1) bioCreateBackgroundJob(REDIS_BIO_CLOSE_FILE
,(void*)(long)oldfd
,NULL
,NULL
);
849 redisLog(REDIS_VERBOSE
,
850 "Background AOF rewrite signal handler took %lldus", ustime()-now
);
851 } else if (!bysignal
&& exitcode
!= 0) {
852 redisLog(REDIS_WARNING
,
853 "Background AOF rewrite terminated with error");
855 redisLog(REDIS_WARNING
,
856 "Background AOF rewrite terminated by signal %d", bysignal
);
860 sdsfree(server
.bgrewritebuf
);
861 server
.bgrewritebuf
= sdsempty();
862 aofRemoveTempFile(server
.bgrewritechildpid
);
863 server
.bgrewritechildpid
= -1;