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 redisAssert(server
.aof_state
!= REDIS_AOF_OFF
);
23 flushAppendOnlyFile(1);
24 aof_fsync(server
.aof_fd
);
28 server
.aof_selected_db
= -1;
29 server
.aof_state
= REDIS_AOF_OFF
;
30 /* rewrite operation in progress? kill it, wait child exit */
31 if (server
.aof_child_pid
!= -1) {
34 redisLog(REDIS_NOTICE
,"Killing running AOF rewrite child: %ld",
35 (long) server
.aof_child_pid
);
36 if (kill(server
.aof_child_pid
,SIGKILL
) != -1)
37 wait3(&statloc
,0,NULL
);
38 /* reset the buffer accumulating changes while the child saves */
39 sdsfree(server
.aof_rewrite_buf
);
40 server
.aof_rewrite_buf
= sdsempty();
41 aofRemoveTempFile(server
.aof_child_pid
);
42 server
.aof_child_pid
= -1;
46 /* Called when the user switches from "appendonly no" to "appendonly yes"
47 * at runtime using the CONFIG command. */
48 int startAppendOnly(void) {
49 server
.aof_last_fsync
= time(NULL
);
50 server
.aof_fd
= open(server
.aof_filename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
51 redisAssert(server
.aof_state
== REDIS_AOF_OFF
);
52 if (server
.aof_fd
== -1) {
53 redisLog(REDIS_WARNING
,"Redis needs to enable the AOF but can't open the append only file: %s",strerror(errno
));
56 if (rewriteAppendOnlyFileBackground() == REDIS_ERR
) {
58 redisLog(REDIS_WARNING
,"Redis needs to enable the AOF but can't trigger a background AOF rewrite operation. Check the above logs for more info about the error.");
61 /* We correctly switched on AOF, now wait for the rerwite to be complete
62 * in order to append data on disk. */
63 server
.aof_state
= REDIS_AOF_WAIT_REWRITE
;
67 /* Write the append only file buffer on disk.
69 * Since we are required to write the AOF before replying to the client,
70 * and the only way the client socket can get a write is entering when the
71 * the event loop, we accumulate all the AOF writes in a memory
72 * buffer and write it on disk using this function just before entering
73 * the event loop again.
75 * About the 'force' argument:
77 * When the fsync policy is set to 'everysec' we may delay the flush if there
78 * is still an fsync() going on in the background thread, since for instance
79 * on Linux write(2) will be blocked by the background fsync anyway.
80 * When this happens we remember that there is some aof buffer to be
81 * flushed ASAP, and will try to do that in the serverCron() function.
83 * However if force is set to 1 we'll write regardless of the background
85 void flushAppendOnlyFile(int force
) {
87 int sync_in_progress
= 0;
89 if (sdslen(server
.aof_buf
) == 0) return;
91 if (server
.aof_fsync
== AOF_FSYNC_EVERYSEC
)
92 sync_in_progress
= bioPendingJobsOfType(REDIS_BIO_AOF_FSYNC
) != 0;
94 if (server
.aof_fsync
== AOF_FSYNC_EVERYSEC
&& !force
) {
95 /* With this append fsync policy we do background fsyncing.
96 * If the fsync is still in progress we can try to delay
97 * the write for a couple of seconds. */
98 if (sync_in_progress
) {
99 if (server
.aof_flush_postponed_start
== 0) {
100 /* No previous write postponinig, remember that we are
101 * postponing the flush and return. */
102 server
.aof_flush_postponed_start
= server
.unixtime
;
104 } else if (server
.unixtime
- server
.aof_flush_postponed_start
< 2) {
105 /* We were already waiting for fsync to finish, but for less
106 * than two seconds this is still ok. Postpone again. */
109 /* Otherwise fall trough, and go write since we can't wait
110 * over two seconds. */
111 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.");
114 /* If you are following this code path, then we are going to write so
115 * set reset the postponed flush sentinel to zero. */
116 server
.aof_flush_postponed_start
= 0;
118 /* We want to perform a single write. This should be guaranteed atomic
119 * at least if the filesystem we are writing is a real physical one.
120 * While this will save us against the server being killed I don't think
121 * there is much to do about the whole server stopping for power problems
123 nwritten
= write(server
.aof_fd
,server
.aof_buf
,sdslen(server
.aof_buf
));
124 if (nwritten
!= (signed)sdslen(server
.aof_buf
)) {
125 /* Ooops, we are in troubles. The best thing to do for now is
126 * aborting instead of giving the illusion that everything is
127 * working as expected. */
128 if (nwritten
== -1) {
129 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
131 redisLog(REDIS_WARNING
,"Exiting on short write while writing to "
132 "the append-only file: %s (nwritten=%ld, "
136 (long)sdslen(server
.aof_buf
));
140 server
.aof_current_size
+= nwritten
;
142 /* Re-use AOF buffer when it is small enough. The maximum comes from the
143 * arena size of 4k minus some overhead (but is otherwise arbitrary). */
144 if ((sdslen(server
.aof_buf
)+sdsavail(server
.aof_buf
)) < 4000) {
145 sdsclear(server
.aof_buf
);
147 sdsfree(server
.aof_buf
);
148 server
.aof_buf
= sdsempty();
151 /* Don't fsync if no-appendfsync-on-rewrite is set to yes and there are
152 * children doing I/O in the background. */
153 if (server
.aof_no_fsync_on_rewrite
&&
154 (server
.aof_child_pid
!= -1 || server
.rdb_child_pid
!= -1))
157 /* Perform the fsync if needed. */
158 if (server
.aof_fsync
== AOF_FSYNC_ALWAYS
) {
159 /* aof_fsync is defined as fdatasync() for Linux in order to avoid
160 * flushing metadata. */
161 aof_fsync(server
.aof_fd
); /* Let's try to get this data on the disk */
162 server
.aof_last_fsync
= server
.unixtime
;
163 } else if ((server
.aof_fsync
== AOF_FSYNC_EVERYSEC
&&
164 server
.unixtime
> server
.aof_last_fsync
)) {
165 if (!sync_in_progress
) aof_background_fsync(server
.aof_fd
);
166 server
.aof_last_fsync
= server
.unixtime
;
170 sds
catAppendOnlyGenericCommand(sds dst
, int argc
, robj
**argv
) {
176 len
= 1+ll2string(buf
+1,sizeof(buf
)-1,argc
);
179 dst
= sdscatlen(dst
,buf
,len
);
181 for (j
= 0; j
< argc
; j
++) {
182 o
= getDecodedObject(argv
[j
]);
184 len
= 1+ll2string(buf
+1,sizeof(buf
)-1,sdslen(o
->ptr
));
187 dst
= sdscatlen(dst
,buf
,len
);
188 dst
= sdscatlen(dst
,o
->ptr
,sdslen(o
->ptr
));
189 dst
= sdscatlen(dst
,"\r\n",2);
195 /* Create the sds representation of an PEXPIREAT command, using
196 * 'seconds' as time to live and 'cmd' to understand what command
197 * we are translating into a PEXPIREAT.
199 * This command is used in order to translate EXPIRE and PEXPIRE commands
200 * into PEXPIREAT command so that we retain precision in the append only
201 * file, and the time is always absolute and not relative. */
202 sds
catAppendOnlyExpireAtCommand(sds buf
, struct redisCommand
*cmd
, robj
*key
, robj
*seconds
) {
206 /* Make sure we can use strtol */
207 seconds
= getDecodedObject(seconds
);
208 when
= strtoll(seconds
->ptr
,NULL
,10);
209 /* Convert argument into milliseconds for EXPIRE, SETEX, EXPIREAT */
210 if (cmd
->proc
== expireCommand
|| cmd
->proc
== setexCommand
||
211 cmd
->proc
== expireatCommand
)
215 /* Convert into absolute time for EXPIRE, PEXPIRE, SETEX, PSETEX */
216 if (cmd
->proc
== expireCommand
|| cmd
->proc
== pexpireCommand
||
217 cmd
->proc
== setexCommand
|| cmd
->proc
== psetexCommand
)
221 decrRefCount(seconds
);
223 argv
[0] = createStringObject("PEXPIREAT",9);
225 argv
[2] = createStringObjectFromLongLong(when
);
226 buf
= catAppendOnlyGenericCommand(buf
, 3, argv
);
227 decrRefCount(argv
[0]);
228 decrRefCount(argv
[2]);
232 void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
233 sds buf
= sdsempty();
236 /* The DB this command was targetting is not the same as the last command
237 * we appendend. To issue a SELECT command is needed. */
238 if (dictid
!= server
.aof_selected_db
) {
241 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
242 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
243 (unsigned long)strlen(seldb
),seldb
);
244 server
.aof_selected_db
= dictid
;
247 if (cmd
->proc
== expireCommand
|| cmd
->proc
== pexpireCommand
||
248 cmd
->proc
== expireatCommand
) {
249 /* Translate EXPIRE/PEXPIRE/EXPIREAT into PEXPIREAT */
250 buf
= catAppendOnlyExpireAtCommand(buf
,cmd
,argv
[1],argv
[2]);
251 } else if (cmd
->proc
== setexCommand
|| cmd
->proc
== psetexCommand
) {
252 /* Translate SETEX/PSETEX to SET and PEXPIREAT */
253 tmpargv
[0] = createStringObject("SET",3);
254 tmpargv
[1] = argv
[1];
255 tmpargv
[2] = argv
[3];
256 buf
= catAppendOnlyGenericCommand(buf
,3,tmpargv
);
257 decrRefCount(tmpargv
[0]);
258 buf
= catAppendOnlyExpireAtCommand(buf
,cmd
,argv
[1],argv
[2]);
260 /* All the other commands don't need translation or need the
261 * same translation already operated in the command vector
262 * for the replication itself. */
263 buf
= catAppendOnlyGenericCommand(buf
,argc
,argv
);
266 /* Append to the AOF buffer. This will be flushed on disk just before
267 * of re-entering the event loop, so before the client will get a
268 * positive reply about the operation performed. */
269 if (server
.aof_state
== REDIS_AOF_ON
)
270 server
.aof_buf
= sdscatlen(server
.aof_buf
,buf
,sdslen(buf
));
272 /* If a background append only file rewriting is in progress we want to
273 * accumulate the differences between the child DB and the current one
274 * in a buffer, so that when the child process will do its work we
275 * can append the differences to the new append only file. */
276 if (server
.aof_child_pid
!= -1)
277 server
.aof_rewrite_buf
= sdscatlen(server
.aof_rewrite_buf
,buf
,sdslen(buf
));
282 /* In Redis commands are always executed in the context of a client, so in
283 * order to load the append only file we need to create a fake client. */
284 struct redisClient
*createFakeClient(void) {
285 struct redisClient
*c
= zmalloc(sizeof(*c
));
289 c
->querybuf
= sdsempty();
294 /* We set the fake client as a slave waiting for the synchronization
295 * so that Redis will not try to send replies to this client. */
296 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
297 c
->reply
= listCreate();
299 c
->watched_keys
= listCreate();
300 listSetFreeMethod(c
->reply
,decrRefCount
);
301 listSetDupMethod(c
->reply
,dupClientReplyValue
);
302 initClientMultiState(c
);
306 void freeFakeClient(struct redisClient
*c
) {
307 sdsfree(c
->querybuf
);
308 listRelease(c
->reply
);
309 listRelease(c
->watched_keys
);
310 freeClientMultiState(c
);
314 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
315 * error (the append only file is zero-length) REDIS_ERR is returned. On
316 * fatal error an error message is logged and the program exists. */
317 int loadAppendOnlyFile(char *filename
) {
318 struct redisClient
*fakeClient
;
319 FILE *fp
= fopen(filename
,"r");
320 struct redis_stat sb
;
321 int old_aof_state
= server
.aof_state
;
324 if (fp
&& redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0) {
325 server
.aof_current_size
= 0;
331 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
335 /* Temporarily disable AOF, to prevent EXEC from feeding a MULTI
336 * to the same file we're about to read. */
337 server
.aof_state
= REDIS_AOF_OFF
;
339 fakeClient
= createFakeClient();
348 struct redisCommand
*cmd
;
350 /* Serve the clients from time to time */
351 if (!(loops
++ % 1000)) {
352 loadingProgress(ftello(fp
));
353 aeProcessEvents(server
.el
, AE_FILE_EVENTS
|AE_DONT_WAIT
);
356 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
362 if (buf
[0] != '*') goto fmterr
;
364 if (argc
< 1) goto fmterr
;
366 argv
= zmalloc(sizeof(robj
*)*argc
);
367 for (j
= 0; j
< argc
; j
++) {
368 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
369 if (buf
[0] != '$') goto fmterr
;
370 len
= strtol(buf
+1,NULL
,10);
371 argsds
= sdsnewlen(NULL
,len
);
372 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
373 argv
[j
] = createObject(REDIS_STRING
,argsds
);
374 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
378 cmd
= lookupCommand(argv
[0]->ptr
);
380 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
383 /* Run the command in the context of a fake client */
384 fakeClient
->argc
= argc
;
385 fakeClient
->argv
= argv
;
386 cmd
->proc(fakeClient
);
388 /* The fake client should not have a reply */
389 redisAssert(fakeClient
->bufpos
== 0 && listLength(fakeClient
->reply
) == 0);
390 /* The fake client should never get blocked */
391 redisAssert((fakeClient
->flags
& REDIS_BLOCKED
) == 0);
393 /* Clean up. Command code may have changed argv/argc so we use the
394 * argv/argc of the client instead of the local variables. */
395 for (j
= 0; j
< fakeClient
->argc
; j
++)
396 decrRefCount(fakeClient
->argv
[j
]);
397 zfree(fakeClient
->argv
);
400 /* This point can only be reached when EOF is reached without errors.
401 * If the client is in the middle of a MULTI/EXEC, log error and quit. */
402 if (fakeClient
->flags
& REDIS_MULTI
) goto readerr
;
405 freeFakeClient(fakeClient
);
406 server
.aof_state
= old_aof_state
;
408 aofUpdateCurrentSize();
409 server
.aof_rewrite_base_size
= server
.aof_current_size
;
414 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
416 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
420 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>");
424 /* Delegate writing an object to writing a bulk string or bulk long long.
425 * This is not placed in rio.c since that adds the redis.h dependency. */
426 int rioWriteBulkObject(rio
*r
, robj
*obj
) {
427 /* Avoid using getDecodedObject to help copy-on-write (we are often
428 * in a child process when this function is called). */
429 if (obj
->encoding
== REDIS_ENCODING_INT
) {
430 return rioWriteBulkLongLong(r
,(long)obj
->ptr
);
431 } else if (obj
->encoding
== REDIS_ENCODING_RAW
) {
432 return rioWriteBulkString(r
,obj
->ptr
,sdslen(obj
->ptr
));
434 redisPanic("Unknown string encoding");
438 /* Emit the commands needed to rebuild a list object.
439 * The function returns 0 on error, 1 on success. */
440 int rewriteListObject(rio
*r
, robj
*key
, robj
*o
) {
441 long long count
= 0, items
= listTypeLength(o
);
443 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
) {
444 unsigned char *zl
= o
->ptr
;
445 unsigned char *p
= ziplistIndex(zl
,0);
450 while(ziplistGet(p
,&vstr
,&vlen
,&vlong
)) {
452 int cmd_items
= (items
> REDIS_AOF_REWRITE_ITEMS_PER_CMD
) ?
453 REDIS_AOF_REWRITE_ITEMS_PER_CMD
: items
;
455 if (rioWriteBulkCount(r
,'*',2+cmd_items
) == 0) return 0;
456 if (rioWriteBulkString(r
,"RPUSH",5) == 0) return 0;
457 if (rioWriteBulkObject(r
,key
) == 0) return 0;
460 if (rioWriteBulkString(r
,(char*)vstr
,vlen
) == 0) return 0;
462 if (rioWriteBulkLongLong(r
,vlong
) == 0) return 0;
464 p
= ziplistNext(zl
,p
);
465 if (++count
== REDIS_AOF_REWRITE_ITEMS_PER_CMD
) count
= 0;
468 } else if (o
->encoding
== REDIS_ENCODING_LINKEDLIST
) {
473 listRewind(list
,&li
);
474 while((ln
= listNext(&li
))) {
475 robj
*eleobj
= listNodeValue(ln
);
478 int cmd_items
= (items
> REDIS_AOF_REWRITE_ITEMS_PER_CMD
) ?
479 REDIS_AOF_REWRITE_ITEMS_PER_CMD
: items
;
481 if (rioWriteBulkCount(r
,'*',2+cmd_items
) == 0) return 0;
482 if (rioWriteBulkString(r
,"RPUSH",5) == 0) return 0;
483 if (rioWriteBulkObject(r
,key
) == 0) return 0;
485 if (rioWriteBulkObject(r
,eleobj
) == 0) return 0;
486 if (++count
== REDIS_AOF_REWRITE_ITEMS_PER_CMD
) count
= 0;
490 redisPanic("Unknown list encoding");
495 /* Emit the commands needed to rebuild a set object.
496 * The function returns 0 on error, 1 on success. */
497 int rewriteSetObject(rio
*r
, robj
*key
, robj
*o
) {
498 long long count
= 0, items
= setTypeSize(o
);
500 if (o
->encoding
== REDIS_ENCODING_INTSET
) {
504 while(intsetGet(o
->ptr
,ii
++,&llval
)) {
506 int cmd_items
= (items
> REDIS_AOF_REWRITE_ITEMS_PER_CMD
) ?
507 REDIS_AOF_REWRITE_ITEMS_PER_CMD
: items
;
509 if (rioWriteBulkCount(r
,'*',2+cmd_items
) == 0) return 0;
510 if (rioWriteBulkString(r
,"SADD",4) == 0) return 0;
511 if (rioWriteBulkObject(r
,key
) == 0) return 0;
513 if (rioWriteBulkLongLong(r
,llval
) == 0) return 0;
514 if (++count
== REDIS_AOF_REWRITE_ITEMS_PER_CMD
) count
= 0;
517 } else if (o
->encoding
== REDIS_ENCODING_HT
) {
518 dictIterator
*di
= dictGetIterator(o
->ptr
);
521 while((de
= dictNext(di
)) != NULL
) {
522 robj
*eleobj
= dictGetKey(de
);
524 int cmd_items
= (items
> REDIS_AOF_REWRITE_ITEMS_PER_CMD
) ?
525 REDIS_AOF_REWRITE_ITEMS_PER_CMD
: items
;
527 if (rioWriteBulkCount(r
,'*',2+cmd_items
) == 0) return 0;
528 if (rioWriteBulkString(r
,"SADD",4) == 0) return 0;
529 if (rioWriteBulkObject(r
,key
) == 0) return 0;
531 if (rioWriteBulkObject(r
,eleobj
) == 0) return 0;
532 if (++count
== REDIS_AOF_REWRITE_ITEMS_PER_CMD
) count
= 0;
535 dictReleaseIterator(di
);
537 redisPanic("Unknown set encoding");
542 /* Emit the commands needed to rebuild a sorted set object.
543 * The function returns 0 on error, 1 on success. */
544 int rewriteSortedSetObject(rio
*r
, robj
*key
, robj
*o
) {
545 long long count
= 0, items
= zsetLength(o
);
547 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
) {
548 unsigned char *zl
= o
->ptr
;
549 unsigned char *eptr
, *sptr
;
555 eptr
= ziplistIndex(zl
,0);
556 redisAssert(eptr
!= NULL
);
557 sptr
= ziplistNext(zl
,eptr
);
558 redisAssert(sptr
!= NULL
);
560 while (eptr
!= NULL
) {
561 redisAssert(ziplistGet(eptr
,&vstr
,&vlen
,&vll
));
562 score
= zzlGetScore(sptr
);
565 int cmd_items
= (items
> REDIS_AOF_REWRITE_ITEMS_PER_CMD
) ?
566 REDIS_AOF_REWRITE_ITEMS_PER_CMD
: items
;
568 if (rioWriteBulkCount(r
,'*',2+cmd_items
*2) == 0) return 0;
569 if (rioWriteBulkString(r
,"ZADD",4) == 0) return 0;
570 if (rioWriteBulkObject(r
,key
) == 0) return 0;
572 if (rioWriteBulkDouble(r
,score
) == 0) return 0;
574 if (rioWriteBulkString(r
,(char*)vstr
,vlen
) == 0) return 0;
576 if (rioWriteBulkLongLong(r
,vll
) == 0) return 0;
578 zzlNext(zl
,&eptr
,&sptr
);
579 if (++count
== REDIS_AOF_REWRITE_ITEMS_PER_CMD
) count
= 0;
582 } else if (o
->encoding
== REDIS_ENCODING_SKIPLIST
) {
584 dictIterator
*di
= dictGetIterator(zs
->dict
);
587 while((de
= dictNext(di
)) != NULL
) {
588 robj
*eleobj
= dictGetKey(de
);
589 double *score
= dictGetVal(de
);
592 int cmd_items
= (items
> REDIS_AOF_REWRITE_ITEMS_PER_CMD
) ?
593 REDIS_AOF_REWRITE_ITEMS_PER_CMD
: items
;
595 if (rioWriteBulkCount(r
,'*',2+cmd_items
*2) == 0) return 0;
596 if (rioWriteBulkString(r
,"ZADD",4) == 0) return 0;
597 if (rioWriteBulkObject(r
,key
) == 0) return 0;
599 if (rioWriteBulkDouble(r
,*score
) == 0) return 0;
600 if (rioWriteBulkObject(r
,eleobj
) == 0) return 0;
601 if (++count
== REDIS_AOF_REWRITE_ITEMS_PER_CMD
) count
= 0;
604 dictReleaseIterator(di
);
606 redisPanic("Unknown sorted zset encoding");
611 /* Emit the commands needed to rebuild a hash object.
612 * The function returns 0 on error, 1 on success. */
613 int rewriteHashObject(rio
*r
, robj
*key
, robj
*o
) {
614 long long count
= 0, items
= hashTypeLength(o
);
616 if (o
->encoding
== REDIS_ENCODING_ZIPMAP
) {
617 unsigned char *p
= zipmapRewind(o
->ptr
);
618 unsigned char *field
, *val
;
619 unsigned int flen
, vlen
;
621 while((p
= zipmapNext(p
,&field
,&flen
,&val
,&vlen
)) != NULL
) {
623 int cmd_items
= (items
> REDIS_AOF_REWRITE_ITEMS_PER_CMD
) ?
624 REDIS_AOF_REWRITE_ITEMS_PER_CMD
: items
;
626 if (rioWriteBulkCount(r
,'*',2+cmd_items
*2) == 0) return 0;
627 if (rioWriteBulkString(r
,"HMSET",5) == 0) return 0;
628 if (rioWriteBulkObject(r
,key
) == 0) return 0;
630 if (rioWriteBulkString(r
,(char*)field
,flen
) == 0) return 0;
631 if (rioWriteBulkString(r
,(char*)val
,vlen
) == 0) return 0;
632 if (++count
== REDIS_AOF_REWRITE_ITEMS_PER_CMD
) count
= 0;
636 dictIterator
*di
= dictGetIterator(o
->ptr
);
639 while((de
= dictNext(di
)) != NULL
) {
640 robj
*field
= dictGetKey(de
);
641 robj
*val
= dictGetVal(de
);
644 int cmd_items
= (items
> REDIS_AOF_REWRITE_ITEMS_PER_CMD
) ?
645 REDIS_AOF_REWRITE_ITEMS_PER_CMD
: items
;
647 if (rioWriteBulkCount(r
,'*',2+cmd_items
*2) == 0) return 0;
648 if (rioWriteBulkString(r
,"HMSET",5) == 0) return 0;
649 if (rioWriteBulkObject(r
,key
) == 0) return 0;
651 if (rioWriteBulkObject(r
,field
) == 0) return 0;
652 if (rioWriteBulkObject(r
,val
) == 0) return 0;
653 if (++count
== REDIS_AOF_REWRITE_ITEMS_PER_CMD
) count
= 0;
656 dictReleaseIterator(di
);
661 /* Write a sequence of commands able to fully rebuild the dataset into
662 * "filename". Used both by REWRITEAOF and BGREWRITEAOF.
664 * In order to minimize the number of commands needed in the rewritten
665 * log Redis uses variadic commands when possible, such as RPUSH, SADD
666 * and ZADD. However at max REDIS_AOF_REWRITE_ITEMS_PER_CMD items per time
667 * are inserted using a single command. */
668 int rewriteAppendOnlyFile(char *filename
) {
669 dictIterator
*di
= NULL
;
675 long long now
= mstime();
677 /* Note that we have to use a different temp name here compared to the
678 * one used by rewriteAppendOnlyFileBackground() function. */
679 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
680 fp
= fopen(tmpfile
,"w");
682 redisLog(REDIS_WARNING
, "Opening the temp file for AOF rewrite in rewriteAppendOnlyFile(): %s", strerror(errno
));
686 rioInitWithFile(&aof
,fp
);
687 for (j
= 0; j
< server
.dbnum
; j
++) {
688 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
689 redisDb
*db
= server
.db
+j
;
691 if (dictSize(d
) == 0) continue;
692 di
= dictGetSafeIterator(d
);
698 /* SELECT the new DB */
699 if (rioWrite(&aof
,selectcmd
,sizeof(selectcmd
)-1) == 0) goto werr
;
700 if (rioWriteBulkLongLong(&aof
,j
) == 0) goto werr
;
702 /* Iterate this DB writing every entry */
703 while((de
= dictNext(di
)) != NULL
) {
706 long long expiretime
;
708 keystr
= dictGetKey(de
);
710 initStaticStringObject(key
,keystr
);
712 expiretime
= getExpire(db
,&key
);
714 /* Save the key and associated value */
715 if (o
->type
== REDIS_STRING
) {
716 /* Emit a SET command */
717 char cmd
[]="*3\r\n$3\r\nSET\r\n";
718 if (rioWrite(&aof
,cmd
,sizeof(cmd
)-1) == 0) goto werr
;
720 if (rioWriteBulkObject(&aof
,&key
) == 0) goto werr
;
721 if (rioWriteBulkObject(&aof
,o
) == 0) goto werr
;
722 } else if (o
->type
== REDIS_LIST
) {
723 if (rewriteListObject(&aof
,&key
,o
) == 0) goto werr
;
724 } else if (o
->type
== REDIS_SET
) {
725 if (rewriteSetObject(&aof
,&key
,o
) == 0) goto werr
;
726 } else if (o
->type
== REDIS_ZSET
) {
727 if (rewriteSortedSetObject(&aof
,&key
,o
) == 0) goto werr
;
728 } else if (o
->type
== REDIS_HASH
) {
729 if (rewriteHashObject(&aof
,&key
,o
) == 0) goto werr
;
731 redisPanic("Unknown object type");
733 /* Save the expire time */
734 if (expiretime
!= -1) {
735 char cmd
[]="*3\r\n$9\r\nPEXPIREAT\r\n";
736 /* If this key is already expired skip it */
737 if (expiretime
< now
) continue;
738 if (rioWrite(&aof
,cmd
,sizeof(cmd
)-1) == 0) goto werr
;
739 if (rioWriteBulkObject(&aof
,&key
) == 0) goto werr
;
740 if (rioWriteBulkLongLong(&aof
,expiretime
) == 0) goto werr
;
743 dictReleaseIterator(di
);
746 /* Make sure data will not remain on the OS's output buffers */
748 aof_fsync(fileno(fp
));
751 /* Use RENAME to make sure the DB file is changed atomically only
752 * if the generate DB file is ok. */
753 if (rename(tmpfile
,filename
) == -1) {
754 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
758 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
764 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
765 if (di
) dictReleaseIterator(di
);
769 /* This is how rewriting of the append only file in background works:
771 * 1) The user calls BGREWRITEAOF
772 * 2) Redis calls this function, that forks():
773 * 2a) the child rewrite the append only file in a temp file.
774 * 2b) the parent accumulates differences in server.aof_rewrite_buf.
775 * 3) When the child finished '2a' exists.
776 * 4) The parent will trap the exit code, if it's OK, will append the
777 * data accumulated into server.aof_rewrite_buf into the temp file, and
778 * finally will rename(2) the temp file in the actual file name.
779 * The the new file is reopened as the new append only file. Profit!
781 int rewriteAppendOnlyFileBackground(void) {
785 if (server
.aof_child_pid
!= -1) return REDIS_ERR
;
787 if ((childpid
= fork()) == 0) {
791 if (server
.ipfd
> 0) close(server
.ipfd
);
792 if (server
.sofd
> 0) close(server
.sofd
);
793 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
794 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
801 server
.stat_fork_time
= ustime()-start
;
802 if (childpid
== -1) {
803 redisLog(REDIS_WARNING
,
804 "Can't rewrite append only file in background: fork: %s",
808 redisLog(REDIS_NOTICE
,
809 "Background append only file rewriting started by pid %d",childpid
);
810 server
.aof_rewrite_scheduled
= 0;
811 server
.aof_child_pid
= childpid
;
812 updateDictResizePolicy();
813 /* We set appendseldb to -1 in order to force the next call to the
814 * feedAppendOnlyFile() to issue a SELECT command, so the differences
815 * accumulated by the parent into server.aof_rewrite_buf will start
816 * with a SELECT statement and it will be safe to merge. */
817 server
.aof_selected_db
= -1;
820 return REDIS_OK
; /* unreached */
823 void bgrewriteaofCommand(redisClient
*c
) {
824 if (server
.aof_child_pid
!= -1) {
825 addReplyError(c
,"Background append only file rewriting already in progress");
826 } else if (server
.rdb_child_pid
!= -1) {
827 server
.aof_rewrite_scheduled
= 1;
828 addReplyStatus(c
,"Background append only file rewriting scheduled");
829 } else if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
830 addReplyStatus(c
,"Background append only file rewriting started");
832 addReply(c
,shared
.err
);
836 void aofRemoveTempFile(pid_t childpid
) {
839 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
843 /* Update the server.aof_current_size filed explicitly using stat(2)
844 * to check the size of the file. This is useful after a rewrite or after
845 * a restart, normally the size is updated just adding the write length
846 * to the current lenght, that is much faster. */
847 void aofUpdateCurrentSize(void) {
848 struct redis_stat sb
;
850 if (redis_fstat(server
.aof_fd
,&sb
) == -1) {
851 redisLog(REDIS_WARNING
,"Unable to obtain the AOF file length. stat: %s",
854 server
.aof_current_size
= sb
.st_size
;
858 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
860 void backgroundRewriteDoneHandler(int exitcode
, int bysignal
) {
861 if (!bysignal
&& exitcode
== 0) {
865 long long now
= ustime();
867 redisLog(REDIS_NOTICE
,
868 "Background AOF rewrite terminated with success");
870 /* Flush the differences accumulated by the parent to the
872 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof",
873 (int)server
.aof_child_pid
);
874 newfd
= open(tmpfile
,O_WRONLY
|O_APPEND
);
876 redisLog(REDIS_WARNING
,
877 "Unable to open the temporary AOF produced by the child: %s", strerror(errno
));
881 nwritten
= write(newfd
,server
.aof_rewrite_buf
,sdslen(server
.aof_rewrite_buf
));
882 if (nwritten
!= (signed)sdslen(server
.aof_rewrite_buf
)) {
883 if (nwritten
== -1) {
884 redisLog(REDIS_WARNING
,
885 "Error trying to flush the parent diff to the rewritten AOF: %s", strerror(errno
));
887 redisLog(REDIS_WARNING
,
888 "Short write trying to flush the parent diff to the rewritten AOF: %s", strerror(errno
));
894 redisLog(REDIS_NOTICE
,
895 "Parent diff successfully flushed to the rewritten AOF (%lu bytes)", nwritten
);
897 /* The only remaining thing to do is to rename the temporary file to
898 * the configured file and switch the file descriptor used to do AOF
899 * writes. We don't want close(2) or rename(2) calls to block the
900 * server on old file deletion.
902 * There are two possible scenarios:
904 * 1) AOF is DISABLED and this was a one time rewrite. The temporary
905 * file will be renamed to the configured file. When this file already
906 * exists, it will be unlinked, which may block the server.
908 * 2) AOF is ENABLED and the rewritten AOF will immediately start
909 * receiving writes. After the temporary file is renamed to the
910 * configured file, the original AOF file descriptor will be closed.
911 * Since this will be the last reference to that file, closing it
912 * causes the underlying file to be unlinked, which may block the
915 * To mitigate the blocking effect of the unlink operation (either
916 * caused by rename(2) in scenario 1, or by close(2) in scenario 2), we
917 * use a background thread to take care of this. First, we
918 * make scenario 1 identical to scenario 2 by opening the target file
919 * when it exists. The unlink operation after the rename(2) will then
920 * be executed upon calling close(2) for its descriptor. Everything to
921 * guarantee atomicity for this switch has already happened by then, so
922 * we don't care what the outcome or duration of that close operation
923 * is, as long as the file descriptor is released again. */
924 if (server
.aof_fd
== -1) {
927 /* Don't care if this fails: oldfd will be -1 and we handle that.
928 * One notable case of -1 return is if the old file does
930 oldfd
= open(server
.aof_filename
,O_RDONLY
|O_NONBLOCK
);
933 oldfd
= -1; /* We'll set this to the current AOF filedes later. */
936 /* Rename the temporary file. This will not unlink the target file if
937 * it exists, because we reference it with "oldfd". */
938 if (rename(tmpfile
,server
.aof_filename
) == -1) {
939 redisLog(REDIS_WARNING
,
940 "Error trying to rename the temporary AOF file: %s", strerror(errno
));
942 if (oldfd
!= -1) close(oldfd
);
946 if (server
.aof_fd
== -1) {
947 /* AOF disabled, we don't need to set the AOF file descriptor
948 * to this new file, so we can close it. */
951 /* AOF enabled, replace the old fd with the new one. */
952 oldfd
= server
.aof_fd
;
953 server
.aof_fd
= newfd
;
954 if (server
.aof_fsync
== AOF_FSYNC_ALWAYS
)
956 else if (server
.aof_fsync
== AOF_FSYNC_EVERYSEC
)
957 aof_background_fsync(newfd
);
958 server
.aof_selected_db
= -1; /* Make sure SELECT is re-issued */
959 aofUpdateCurrentSize();
960 server
.aof_rewrite_base_size
= server
.aof_current_size
;
962 /* Clear regular AOF buffer since its contents was just written to
963 * the new AOF from the background rewrite buffer. */
964 sdsfree(server
.aof_buf
);
965 server
.aof_buf
= sdsempty();
968 redisLog(REDIS_NOTICE
, "Background AOF rewrite finished successfully");
969 /* Change state from WAIT_REWRITE to ON if needed */
970 if (server
.aof_state
== REDIS_AOF_WAIT_REWRITE
)
971 server
.aof_state
= REDIS_AOF_ON
;
973 /* Asynchronously close the overwritten AOF. */
974 if (oldfd
!= -1) bioCreateBackgroundJob(REDIS_BIO_CLOSE_FILE
,(void*)(long)oldfd
,NULL
,NULL
);
976 redisLog(REDIS_VERBOSE
,
977 "Background AOF rewrite signal handler took %lldus", ustime()-now
);
978 } else if (!bysignal
&& exitcode
!= 0) {
979 redisLog(REDIS_WARNING
,
980 "Background AOF rewrite terminated with error");
982 redisLog(REDIS_WARNING
,
983 "Background AOF rewrite terminated by signal %d", bysignal
);
987 sdsfree(server
.aof_rewrite_buf
);
988 server
.aof_rewrite_buf
= sdsempty();
989 aofRemoveTempFile(server
.aof_child_pid
);
990 server
.aof_child_pid
= -1;
991 /* Schedule a new rewrite if we are waiting for it to switch the AOF ON. */
992 if (server
.aof_state
== REDIS_AOF_WAIT_REWRITE
)
993 server
.aof_rewrite_scheduled
= 1;