aof.c 34.6 KB
Newer Older
1
#include "redis.h"
2
#include "bio.h"
A
antirez 已提交
3
#include "rio.h"
4 5 6 7

#include <signal.h>
#include <fcntl.h>
#include <sys/stat.h>
8 9 10 11
#include <sys/types.h>
#include <sys/time.h>
#include <sys/resource.h>
#include <sys/wait.h>
12

13 14
void aofUpdateCurrentSize(void);

15
void aof_background_fsync(int fd) {
A
antirez 已提交
16
    bioCreateBackgroundJob(REDIS_BIO_AOF_FSYNC,(void*)(long)fd,NULL,NULL);
17 18
}

19 20 21
/* Called when the user switches from "appendonly yes" to "appendonly no"
 * at runtime using the CONFIG command. */
void stopAppendOnly(void) {
22
    flushAppendOnlyFile(1);
23 24 25 26 27 28 29
    aof_fsync(server.appendfd);
    close(server.appendfd);

    server.appendfd = -1;
    server.appendseldb = -1;
    server.appendonly = 0;
    /* rewrite operation in progress? kill it, wait child exit */
30
    if (server.bgrewritechildpid != -1) {
31 32
        int statloc;

33
        if (kill(server.bgrewritechildpid,SIGKILL) != -1)
34 35 36 37
            wait3(&statloc,0,NULL);
        /* reset the buffer accumulating changes while the child saves */
        sdsfree(server.bgrewritebuf);
        server.bgrewritebuf = sdsempty();
38
        server.bgrewritechildpid = -1;
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
    }
}

/* Called when the user switches from "appendonly no" to "appendonly yes"
 * at runtime using the CONFIG command. */
int startAppendOnly(void) {
    server.appendonly = 1;
    server.lastfsync = time(NULL);
    server.appendfd = open(server.appendfilename,O_WRONLY|O_APPEND|O_CREAT,0644);
    if (server.appendfd == -1) {
        redisLog(REDIS_WARNING,"Used tried to switch on AOF via CONFIG, but I can't open the AOF file: %s",strerror(errno));
        return REDIS_ERR;
    }
    if (rewriteAppendOnlyFileBackground() == REDIS_ERR) {
        server.appendonly = 0;
        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.");
56 57 58 59 60 61 62 63 64 65 66
        return REDIS_ERR;
    }
    return REDIS_OK;
}

/* Write the append only file buffer on disk.
 *
 * Since we are required to write the AOF before replying to the client,
 * and the only way the client socket can get a write is entering when the
 * the event loop, we accumulate all the AOF writes in a memory
 * buffer and write it on disk using this function just before entering
67 68 69 70 71 72 73 74 75 76 77 78 79
 * the event loop again.
 *
 * About the 'force' argument:
 *
 * When the fsync policy is set to 'everysec' we may delay the flush if there
 * is still an fsync() going on in the background thread, since for instance
 * on Linux write(2) will be blocked by the background fsync anyway.
 * When this happens we remember that there is some aof buffer to be
 * flushed ASAP, and will try to do that in the serverCron() function.
 *
 * However if force is set to 1 we'll write regardless of the background
 * fsync. */
void flushAppendOnlyFile(int force) {
80
    ssize_t nwritten;
81
    int sync_in_progress = 0;
82 83 84

    if (sdslen(server.aofbuf) == 0) return;

85 86 87 88 89 90 91 92 93 94 95 96 97 98
    if (server.appendfsync == APPENDFSYNC_EVERYSEC)
        sync_in_progress = bioPendingJobsOfType(REDIS_BIO_AOF_FSYNC) != 0;

    if (server.appendfsync == APPENDFSYNC_EVERYSEC && !force) {
        /* With this append fsync policy we do background fsyncing.
         * If the fsync is still in progress we can try to delay
         * the write for a couple of seconds. */
        if (sync_in_progress) {
            if (server.aof_flush_postponed_start == 0) {
                /* No previous write postponinig, remember that we are
                 * postponing the flush and return. */
                server.aof_flush_postponed_start = server.unixtime;
                return;
            } else if (server.unixtime - server.aof_flush_postponed_start < 2) {
A
antirez 已提交
99
                /* We were already waiting for fsync to finish, but for less
100 101 102 103 104
                 * than two seconds this is still ok. Postpone again. */
                return;
            }
            /* Otherwise fall trough, and go write since we can't wait
             * 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 109 110 111
        }
    }
    /* If you are following this code path, then we are going to write so
     * set reset the postponed flush sentinel to zero. */
    server.aof_flush_postponed_start = 0;

112 113 114 115 116
    /* We want to perform a single write. This should be guaranteed atomic
     * at least if the filesystem we are writing is a real physical one.
     * While this will save us against the server being killed I don't think
     * there is much to do about the whole server stopping for power problems
     * or alike */
P
Pieter Noordhuis 已提交
117 118
    nwritten = write(server.appendfd,server.aofbuf,sdslen(server.aofbuf));
    if (nwritten != (signed)sdslen(server.aofbuf)) {
119 120 121
        /* Ooops, we are in troubles. The best thing to do for now is
         * aborting instead of giving the illusion that everything is
         * working as expected. */
P
Pieter Noordhuis 已提交
122
        if (nwritten == -1) {
123
            redisLog(REDIS_WARNING,"Exiting on error writing to the append-only file: %s",strerror(errno));
P
Pieter Noordhuis 已提交
124
        } else {
125
            redisLog(REDIS_WARNING,"Exiting on short write while writing to the append-only file: %s",strerror(errno));
P
Pieter Noordhuis 已提交
126 127
        }
        exit(1);
128
    }
129
    server.appendonly_current_size += nwritten;
130

131 132 133 134 135 136 137 138 139
    /* Re-use AOF buffer when it is small enough. The maximum comes from the
     * arena size of 4k minus some overhead (but is otherwise arbitrary). */
    if ((sdslen(server.aofbuf)+sdsavail(server.aofbuf)) < 4000) {
        sdsclear(server.aofbuf);
    } else {
        sdsfree(server.aofbuf);
        server.aofbuf = sdsempty();
    }

140 141
    /* Don't fsync if no-appendfsync-on-rewrite is set to yes and there are
     * children doing I/O in the background. */
142 143 144
    if (server.no_appendfsync_on_rewrite &&
        (server.bgrewritechildpid != -1 || server.bgsavechildpid != -1))
            return;
145 146

    /* Perform the fsync if needed. */
147
    if (server.appendfsync == APPENDFSYNC_ALWAYS) {
148 149 150
        /* aof_fsync is defined as fdatasync() for Linux in order to avoid
         * flushing metadata. */
        aof_fsync(server.appendfd); /* Let's try to get this data on the disk */
151
        server.lastfsync = server.unixtime;
152 153 154 155
    } else if ((server.appendfsync == APPENDFSYNC_EVERYSEC &&
                server.unixtime > server.lastfsync)) {
        if (!sync_in_progress) aof_background_fsync(server.appendfd);
        server.lastfsync = server.unixtime;
156 157 158
    }
}

159 160 161 162 163 164 165 166 167 168 169
sds catAppendOnlyGenericCommand(sds dst, int argc, robj **argv) {
    char buf[32];
    int len, j;
    robj *o;

    buf[0] = '*';
    len = 1+ll2string(buf+1,sizeof(buf)-1,argc);
    buf[len++] = '\r';
    buf[len++] = '\n';
    dst = sdscatlen(dst,buf,len);

170
    for (j = 0; j < argc; j++) {
171 172 173 174 175 176 177 178
        o = getDecodedObject(argv[j]);
        buf[0] = '$';
        len = 1+ll2string(buf+1,sizeof(buf)-1,sdslen(o->ptr));
        buf[len++] = '\r';
        buf[len++] = '\n';
        dst = sdscatlen(dst,buf,len);
        dst = sdscatlen(dst,o->ptr,sdslen(o->ptr));
        dst = sdscatlen(dst,"\r\n",2);
179 180
        decrRefCount(o);
    }
181
    return dst;
182 183
}

184 185 186 187 188 189 190 191 192
/* Create the sds representation of an PEXPIREAT command, using
 * 'seconds' as time to live and 'cmd' to understand what command
 * we are translating into a PEXPIREAT.
 *
 * This command is used in order to translate EXPIRE and PEXPIRE commands
 * into PEXPIREAT command so that we retain precision in the append only
 * file, and the time is always absolute and not relative. */
sds catAppendOnlyExpireAtCommand(sds buf, struct redisCommand *cmd, robj *key, robj *seconds) {
    long long when;
193 194 195 196
    robj *argv[3];

    /* Make sure we can use strtol */
    seconds = getDecodedObject(seconds);
197 198 199 200 201 202 203 204 205 206 207 208 209
    when = strtoll(seconds->ptr,NULL,10);
    /* Convert argument into milliseconds for EXPIRE, SETEX, EXPIREAT */
    if (cmd->proc == expireCommand || cmd->proc == setexCommand ||
        cmd->proc == expireatCommand)
    {
        when *= 1000;
    }
    /* Convert into absolute time for EXPIRE, PEXPIRE, SETEX, PSETEX */
    if (cmd->proc == expireCommand || cmd->proc == pexpireCommand ||
        cmd->proc == setexCommand || cmd->proc == psetexCommand)
    {
        when += mstime();
    }
210 211
    decrRefCount(seconds);

212
    argv[0] = createStringObject("PEXPIREAT",9);
213
    argv[1] = key;
214 215
    argv[2] = createStringObjectFromLongLong(when);
    buf = catAppendOnlyGenericCommand(buf, 3, argv);
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
    decrRefCount(argv[0]);
    decrRefCount(argv[2]);
    return buf;
}

void feedAppendOnlyFile(struct redisCommand *cmd, int dictid, robj **argv, int argc) {
    sds buf = sdsempty();
    robj *tmpargv[3];

    /* The DB this command was targetting is not the same as the last command
     * we appendend. To issue a SELECT command is needed. */
    if (dictid != server.appendseldb) {
        char seldb[64];

        snprintf(seldb,sizeof(seldb),"%d",dictid);
        buf = sdscatprintf(buf,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
            (unsigned long)strlen(seldb),seldb);
        server.appendseldb = dictid;
    }

236 237 238 239 240 241
    if (cmd->proc == expireCommand || cmd->proc == pexpireCommand ||
        cmd->proc == expireatCommand) {
        /* Translate EXPIRE/PEXPIRE/EXPIREAT into PEXPIREAT */
        buf = catAppendOnlyExpireAtCommand(buf,cmd,argv[1],argv[2]);
    } else if (cmd->proc == setexCommand || cmd->proc == psetexCommand) {
        /* Translate SETEX/PSETEX to SET and PEXPIREAT */
242 243 244 245 246
        tmpargv[0] = createStringObject("SET",3);
        tmpargv[1] = argv[1];
        tmpargv[2] = argv[3];
        buf = catAppendOnlyGenericCommand(buf,3,tmpargv);
        decrRefCount(tmpargv[0]);
247
        buf = catAppendOnlyExpireAtCommand(buf,cmd,argv[1],argv[2]);
248
    } else {
249 250 251
        /* All the other commands don't need translation or need the
         * same translation already operated in the command vector
         * for the replication itself. */
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
        buf = catAppendOnlyGenericCommand(buf,argc,argv);
    }

    /* Append to the AOF buffer. This will be flushed on disk just before
     * of re-entering the event loop, so before the client will get a
     * positive reply about the operation performed. */
    server.aofbuf = sdscatlen(server.aofbuf,buf,sdslen(buf));

    /* If a background append only file rewriting is in progress we want to
     * accumulate the differences between the child DB and the current one
     * in a buffer, so that when the child process will do its work we
     * can append the differences to the new append only file. */
    if (server.bgrewritechildpid != -1)
        server.bgrewritebuf = sdscatlen(server.bgrewritebuf,buf,sdslen(buf));

    sdsfree(buf);
}

/* In Redis commands are always executed in the context of a client, so in
 * order to load the append only file we need to create a fake client. */
struct redisClient *createFakeClient(void) {
    struct redisClient *c = zmalloc(sizeof(*c));

    selectDb(c,0);
    c->fd = -1;
    c->querybuf = sdsempty();
    c->argc = 0;
    c->argv = NULL;
280
    c->bufpos = 0;
281 282 283 284 285
    c->flags = 0;
    /* We set the fake client as a slave waiting for the synchronization
     * so that Redis will not try to send replies to this client. */
    c->replstate = REDIS_REPL_WAIT_BGSAVE_START;
    c->reply = listCreate();
286
    c->watched_keys = listCreate();
287 288 289 290 291 292 293 294 295
    listSetFreeMethod(c->reply,decrRefCount);
    listSetDupMethod(c->reply,dupClientReplyValue);
    initClientMultiState(c);
    return c;
}

void freeFakeClient(struct redisClient *c) {
    sdsfree(c->querybuf);
    listRelease(c->reply);
296
    listRelease(c->watched_keys);
297 298 299 300 301 302 303 304 305 306 307 308
    freeClientMultiState(c);
    zfree(c);
}

/* Replay the append log file. On error REDIS_OK is returned. On non fatal
 * error (the append only file is zero-length) REDIS_ERR is returned. On
 * fatal error an error message is logged and the program exists. */
int loadAppendOnlyFile(char *filename) {
    struct redisClient *fakeClient;
    FILE *fp = fopen(filename,"r");
    struct redis_stat sb;
    int appendonly = server.appendonly;
309
    long loops = 0;
310

A
antirez 已提交
311
    if (fp && redis_fstat(fileno(fp),&sb) != -1 && sb.st_size == 0) {
312
        server.appendonly_current_size = 0;
A
antirez 已提交
313
        fclose(fp);
314
        return REDIS_ERR;
A
antirez 已提交
315
    }
316 317 318 319 320 321 322 323 324 325 326

    if (fp == NULL) {
        redisLog(REDIS_WARNING,"Fatal error: can't open the append log file for reading: %s",strerror(errno));
        exit(1);
    }

    /* Temporarily disable AOF, to prevent EXEC from feeding a MULTI
     * to the same file we're about to read. */
    server.appendonly = 0;

    fakeClient = createFakeClient();
327 328
    startLoading(fp);

329 330 331 332 333 334 335 336
    while(1) {
        int argc, j;
        unsigned long len;
        robj **argv;
        char buf[128];
        sds argsds;
        struct redisCommand *cmd;

337 338 339 340 341 342
        /* Serve the clients from time to time */
        if (!(loops++ % 1000)) {
            loadingProgress(ftello(fp));
            aeProcessEvents(server.el, AE_FILE_EVENTS|AE_DONT_WAIT);
        }

343 344 345 346 347 348 349 350
        if (fgets(buf,sizeof(buf),fp) == NULL) {
            if (feof(fp))
                break;
            else
                goto readerr;
        }
        if (buf[0] != '*') goto fmterr;
        argc = atoi(buf+1);
351 352
        if (argc < 1) goto fmterr;

353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
        argv = zmalloc(sizeof(robj*)*argc);
        for (j = 0; j < argc; j++) {
            if (fgets(buf,sizeof(buf),fp) == NULL) goto readerr;
            if (buf[0] != '$') goto fmterr;
            len = strtol(buf+1,NULL,10);
            argsds = sdsnewlen(NULL,len);
            if (len && fread(argsds,len,1,fp) == 0) goto fmterr;
            argv[j] = createObject(REDIS_STRING,argsds);
            if (fread(buf,2,1,fp) == 0) goto fmterr; /* discard CRLF */
        }

        /* Command lookup */
        cmd = lookupCommand(argv[0]->ptr);
        if (!cmd) {
            redisLog(REDIS_WARNING,"Unknown command '%s' reading the append only file", argv[0]->ptr);
            exit(1);
        }
        /* Run the command in the context of a fake client */
        fakeClient->argc = argc;
        fakeClient->argv = argv;
        cmd->proc(fakeClient);
374 375 376

        /* The fake client should not have a reply */
        redisAssert(fakeClient->bufpos == 0 && listLength(fakeClient->reply) == 0);
377 378
        /* The fake client should never get blocked */
        redisAssert((fakeClient->flags & REDIS_BLOCKED) == 0);
379

380 381 382 383 384
        /* Clean up. Command code may have changed argv/argc so we use the
         * argv/argc of the client instead of the local variables. */
        for (j = 0; j < fakeClient->argc; j++)
            decrRefCount(fakeClient->argv[j]);
        zfree(fakeClient->argv);
385 386 387 388 389 390 391 392 393
    }

    /* This point can only be reached when EOF is reached without errors.
     * If the client is in the middle of a MULTI/EXEC, log error and quit. */
    if (fakeClient->flags & REDIS_MULTI) goto readerr;

    fclose(fp);
    freeFakeClient(fakeClient);
    server.appendonly = appendonly;
394
    stopLoading();
395
    aofUpdateCurrentSize();
396
    server.auto_aofrewrite_base_size = server.appendonly_current_size;
397 398 399 400 401 402 403 404 405 406
    return REDIS_OK;

readerr:
    if (feof(fp)) {
        redisLog(REDIS_WARNING,"Unexpected end of file reading the append only file");
    } else {
        redisLog(REDIS_WARNING,"Unrecoverable error reading the append only file: %s", strerror(errno));
    }
    exit(1);
fmterr:
A
antirez 已提交
407
    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>");
408 409 410
    exit(1);
}

P
Pieter Noordhuis 已提交
411 412 413 414 415 416 417 418 419 420 421 422 423 424
/* Delegate writing an object to writing a bulk string or bulk long long.
 * This is not placed in rio.c since that adds the redis.h dependency. */
int rioWriteBulkObject(rio *r, robj *obj) {
    /* Avoid using getDecodedObject to help copy-on-write (we are often
     * in a child process when this function is called). */
    if (obj->encoding == REDIS_ENCODING_INT) {
        return rioWriteBulkLongLong(r,(long)obj->ptr);
    } else if (obj->encoding == REDIS_ENCODING_RAW) {
        return rioWriteBulkString(r,obj->ptr,sdslen(obj->ptr));
    } else {
        redisPanic("Unknown string encoding");
    }
}

425 426 427 428 429
/* Write a sequence of commands able to fully rebuild the dataset into
 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
int rewriteAppendOnlyFile(char *filename) {
    dictIterator *di = NULL;
    dictEntry *de;
P
Pieter Noordhuis 已提交
430
    rio aof;
431 432 433
    FILE *fp;
    char tmpfile[256];
    int j;
434
    long long now = mstime();
435 436 437 438 439 440 441 442 443

    /* Note that we have to use a different temp name here compared to the
     * one used by rewriteAppendOnlyFileBackground() function. */
    snprintf(tmpfile,256,"temp-rewriteaof-%d.aof", (int) getpid());
    fp = fopen(tmpfile,"w");
    if (!fp) {
        redisLog(REDIS_WARNING, "Failed rewriting the append only file: %s", strerror(errno));
        return REDIS_ERR;
    }
P
Pieter Noordhuis 已提交
444

445
    rioInitWithFile(&aof,fp);
446 447 448 449 450
    for (j = 0; j < server.dbnum; j++) {
        char selectcmd[] = "*2\r\n$6\r\nSELECT\r\n";
        redisDb *db = server.db+j;
        dict *d = db->dict;
        if (dictSize(d) == 0) continue;
451
        di = dictGetSafeIterator(d);
452 453 454 455 456 457
        if (!di) {
            fclose(fp);
            return REDIS_ERR;
        }

        /* SELECT the new DB */
P
Pieter Noordhuis 已提交
458 459
        if (rioWrite(&aof,selectcmd,sizeof(selectcmd)-1) == 0) goto werr;
        if (rioWriteBulkLongLong(&aof,j) == 0) goto werr;
460 461 462

        /* Iterate this DB writing every entry */
        while((de = dictNext(di)) != NULL) {
A
antirez 已提交
463
            sds keystr;
464
            robj key, *o;
465
            long long expiretime;
466

467 468
            keystr = dictGetKey(de);
            o = dictGetVal(de);
469
            initStaticStringObject(key,keystr);
470

471 472 473 474 475 476
            expiretime = getExpire(db,&key);

            /* Save the key and associated value */
            if (o->type == REDIS_STRING) {
                /* Emit a SET command */
                char cmd[]="*3\r\n$3\r\nSET\r\n";
P
Pieter Noordhuis 已提交
477
                if (rioWrite(&aof,cmd,sizeof(cmd)-1) == 0) goto werr;
478
                /* Key and value */
P
Pieter Noordhuis 已提交
479 480
                if (rioWriteBulkObject(&aof,&key) == 0) goto werr;
                if (rioWriteBulkObject(&aof,o) == 0) goto werr;
481 482 483 484 485 486 487 488 489 490 491
            } else if (o->type == REDIS_LIST) {
                /* Emit the RPUSHes needed to rebuild the list */
                char cmd[]="*3\r\n$5\r\nRPUSH\r\n";
                if (o->encoding == REDIS_ENCODING_ZIPLIST) {
                    unsigned char *zl = o->ptr;
                    unsigned char *p = ziplistIndex(zl,0);
                    unsigned char *vstr;
                    unsigned int vlen;
                    long long vlong;

                    while(ziplistGet(p,&vstr,&vlen,&vlong)) {
P
Pieter Noordhuis 已提交
492 493
                        if (rioWrite(&aof,cmd,sizeof(cmd)-1) == 0) goto werr;
                        if (rioWriteBulkObject(&aof,&key) == 0) goto werr;
494
                        if (vstr) {
P
Pieter Noordhuis 已提交
495
                            if (rioWriteBulkString(&aof,(char*)vstr,vlen) == 0)
496 497
                                goto werr;
                        } else {
P
Pieter Noordhuis 已提交
498
                            if (rioWriteBulkLongLong(&aof,vlong) == 0)
499 500 501 502 503 504 505 506 507 508 509 510 511
                                goto werr;
                        }
                        p = ziplistNext(zl,p);
                    }
                } else if (o->encoding == REDIS_ENCODING_LINKEDLIST) {
                    list *list = o->ptr;
                    listNode *ln;
                    listIter li;

                    listRewind(list,&li);
                    while((ln = listNext(&li))) {
                        robj *eleobj = listNodeValue(ln);

P
Pieter Noordhuis 已提交
512 513 514
                        if (rioWrite(&aof,cmd,sizeof(cmd)-1) == 0) goto werr;
                        if (rioWriteBulkObject(&aof,&key) == 0) goto werr;
                        if (rioWriteBulkObject(&aof,eleobj) == 0) goto werr;
515 516 517 518 519
                    }
                } else {
                    redisPanic("Unknown list encoding");
                }
            } else if (o->type == REDIS_SET) {
520
                char cmd[]="*3\r\n$4\r\nSADD\r\n";
521

522 523 524
                /* Emit the SADDs needed to rebuild the set */
                if (o->encoding == REDIS_ENCODING_INTSET) {
                    int ii = 0;
525
                    int64_t llval;
526
                    while(intsetGet(o->ptr,ii++,&llval)) {
P
Pieter Noordhuis 已提交
527 528 529
                        if (rioWrite(&aof,cmd,sizeof(cmd)-1) == 0) goto werr;
                        if (rioWriteBulkObject(&aof,&key) == 0) goto werr;
                        if (rioWriteBulkLongLong(&aof,llval) == 0) goto werr;
530 531 532 533 534
                    }
                } else if (o->encoding == REDIS_ENCODING_HT) {
                    dictIterator *di = dictGetIterator(o->ptr);
                    dictEntry *de;
                    while((de = dictNext(di)) != NULL) {
535
                        robj *eleobj = dictGetKey(de);
P
Pieter Noordhuis 已提交
536 537 538
                        if (rioWrite(&aof,cmd,sizeof(cmd)-1) == 0) goto werr;
                        if (rioWriteBulkObject(&aof,&key) == 0) goto werr;
                        if (rioWriteBulkObject(&aof,eleobj) == 0) goto werr;
539 540 541 542
                    }
                    dictReleaseIterator(di);
                } else {
                    redisPanic("Unknown set encoding");
543 544 545
                }
            } else if (o->type == REDIS_ZSET) {
                /* Emit the ZADDs needed to rebuild the sorted set */
546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564
                char cmd[]="*4\r\n$4\r\nZADD\r\n";

                if (o->encoding == REDIS_ENCODING_ZIPLIST) {
                    unsigned char *zl = o->ptr;
                    unsigned char *eptr, *sptr;
                    unsigned char *vstr;
                    unsigned int vlen;
                    long long vll;
                    double score;

                    eptr = ziplistIndex(zl,0);
                    redisAssert(eptr != NULL);
                    sptr = ziplistNext(zl,eptr);
                    redisAssert(sptr != NULL);

                    while (eptr != NULL) {
                        redisAssert(ziplistGet(eptr,&vstr,&vlen,&vll));
                        score = zzlGetScore(sptr);

P
Pieter Noordhuis 已提交
565 566 567
                        if (rioWrite(&aof,cmd,sizeof(cmd)-1) == 0) goto werr;
                        if (rioWriteBulkObject(&aof,&key) == 0) goto werr;
                        if (rioWriteBulkDouble(&aof,score) == 0) goto werr;
568
                        if (vstr != NULL) {
P
Pieter Noordhuis 已提交
569
                            if (rioWriteBulkString(&aof,(char*)vstr,vlen) == 0)
570 571
                                goto werr;
                        } else {
P
Pieter Noordhuis 已提交
572
                            if (rioWriteBulkLongLong(&aof,vll) == 0)
573 574 575 576
                                goto werr;
                        }
                        zzlNext(zl,&eptr,&sptr);
                    }
577
                } else if (o->encoding == REDIS_ENCODING_SKIPLIST) {
578 579 580 581 582
                    zset *zs = o->ptr;
                    dictIterator *di = dictGetIterator(zs->dict);
                    dictEntry *de;

                    while((de = dictNext(di)) != NULL) {
583 584
                        robj *eleobj = dictGetKey(de);
                        double *score = dictGetVal(de);
585

P
Pieter Noordhuis 已提交
586 587 588 589
                        if (rioWrite(&aof,cmd,sizeof(cmd)-1) == 0) goto werr;
                        if (rioWriteBulkObject(&aof,&key) == 0) goto werr;
                        if (rioWriteBulkDouble(&aof,*score) == 0) goto werr;
                        if (rioWriteBulkObject(&aof,eleobj) == 0) goto werr;
590 591 592 593
                    }
                    dictReleaseIterator(di);
                } else {
                    redisPanic("Unknown sorted set encoding");
594 595 596 597 598 599 600 601 602 603 604
                }
            } else if (o->type == REDIS_HASH) {
                char cmd[]="*4\r\n$4\r\nHSET\r\n";

                /* Emit the HSETs needed to rebuild the hash */
                if (o->encoding == REDIS_ENCODING_ZIPMAP) {
                    unsigned char *p = zipmapRewind(o->ptr);
                    unsigned char *field, *val;
                    unsigned int flen, vlen;

                    while((p = zipmapNext(p,&field,&flen,&val,&vlen)) != NULL) {
P
Pieter Noordhuis 已提交
605 606 607
                        if (rioWrite(&aof,cmd,sizeof(cmd)-1) == 0) goto werr;
                        if (rioWriteBulkObject(&aof,&key) == 0) goto werr;
                        if (rioWriteBulkString(&aof,(char*)field,flen) == 0)
608
                            goto werr;
P
Pieter Noordhuis 已提交
609
                        if (rioWriteBulkString(&aof,(char*)val,vlen) == 0)
610
                            goto werr;
611 612 613 614 615 616
                    }
                } else {
                    dictIterator *di = dictGetIterator(o->ptr);
                    dictEntry *de;

                    while((de = dictNext(di)) != NULL) {
617 618
                        robj *field = dictGetKey(de);
                        robj *val = dictGetVal(de);
619

P
Pieter Noordhuis 已提交
620 621 622 623
                        if (rioWrite(&aof,cmd,sizeof(cmd)-1) == 0) goto werr;
                        if (rioWriteBulkObject(&aof,&key) == 0) goto werr;
                        if (rioWriteBulkObject(&aof,field) == 0) goto werr;
                        if (rioWriteBulkObject(&aof,val) == 0) goto werr;
624 625 626 627 628 629 630 631
                    }
                    dictReleaseIterator(di);
                }
            } else {
                redisPanic("Unknown object type");
            }
            /* Save the expire time */
            if (expiretime != -1) {
632
                char cmd[]="*3\r\n$9\r\nPEXPIREAT\r\n";
633 634
                /* If this key is already expired skip it */
                if (expiretime < now) continue;
P
Pieter Noordhuis 已提交
635 636
                if (rioWrite(&aof,cmd,sizeof(cmd)-1) == 0) goto werr;
                if (rioWriteBulkObject(&aof,&key) == 0) goto werr;
637
                if (rioWriteBulkLongLong(&aof,expiretime) == 0) goto werr;
638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679
            }
        }
        dictReleaseIterator(di);
    }

    /* Make sure data will not remain on the OS's output buffers */
    fflush(fp);
    aof_fsync(fileno(fp));
    fclose(fp);

    /* Use RENAME to make sure the DB file is changed atomically only
     * if the generate DB file is ok. */
    if (rename(tmpfile,filename) == -1) {
        redisLog(REDIS_WARNING,"Error moving temp append only file on the final destination: %s", strerror(errno));
        unlink(tmpfile);
        return REDIS_ERR;
    }
    redisLog(REDIS_NOTICE,"SYNC append only file rewrite performed");
    return REDIS_OK;

werr:
    fclose(fp);
    unlink(tmpfile);
    redisLog(REDIS_WARNING,"Write error writing append only file on disk: %s", strerror(errno));
    if (di) dictReleaseIterator(di);
    return REDIS_ERR;
}

/* This is how rewriting of the append only file in background works:
 *
 * 1) The user calls BGREWRITEAOF
 * 2) Redis calls this function, that forks():
 *    2a) the child rewrite the append only file in a temp file.
 *    2b) the parent accumulates differences in server.bgrewritebuf.
 * 3) When the child finished '2a' exists.
 * 4) The parent will trap the exit code, if it's OK, will append the
 *    data accumulated into server.bgrewritebuf into the temp file, and
 *    finally will rename(2) the temp file in the actual file name.
 *    The the new file is reopened as the new append only file. Profit!
 */
int rewriteAppendOnlyFileBackground(void) {
    pid_t childpid;
680
    long long start;
681 682

    if (server.bgrewritechildpid != -1) return REDIS_ERR;
683
    start = ustime();
684 685 686
    if ((childpid = fork()) == 0) {
        char tmpfile[256];

687
        /* Child */
688 689
        if (server.ipfd > 0) close(server.ipfd);
        if (server.sofd > 0) close(server.sofd);
690 691 692 693 694 695 696 697
        snprintf(tmpfile,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
        if (rewriteAppendOnlyFile(tmpfile) == REDIS_OK) {
            _exit(0);
        } else {
            _exit(1);
        }
    } else {
        /* Parent */
698
        server.stat_fork_time = ustime()-start;
699 700 701 702 703 704 705 706
        if (childpid == -1) {
            redisLog(REDIS_WARNING,
                "Can't rewrite append only file in background: fork: %s",
                strerror(errno));
            return REDIS_ERR;
        }
        redisLog(REDIS_NOTICE,
            "Background append only file rewriting started by pid %d",childpid);
707
        server.aofrewrite_scheduled = 0;
708 709 710 711 712 713 714 715 716 717 718 719 720 721
        server.bgrewritechildpid = childpid;
        updateDictResizePolicy();
        /* We set appendseldb to -1 in order to force the next call to the
         * feedAppendOnlyFile() to issue a SELECT command, so the differences
         * accumulated by the parent into server.bgrewritebuf will start
         * with a SELECT statement and it will be safe to merge. */
        server.appendseldb = -1;
        return REDIS_OK;
    }
    return REDIS_OK; /* unreached */
}

void bgrewriteaofCommand(redisClient *c) {
    if (server.bgrewritechildpid != -1) {
722
        addReplyError(c,"Background append only file rewriting already in progress");
723 724
    } else if (server.bgsavechildpid != -1) {
        server.aofrewrite_scheduled = 1;
725
        addReplyStatus(c,"Background append only file rewriting scheduled");
726
    } else if (rewriteAppendOnlyFileBackground() == REDIS_OK) {
727
        addReplyStatus(c,"Background append only file rewriting started");
728 729 730 731 732 733 734 735 736 737 738 739
    } else {
        addReply(c,shared.err);
    }
}

void aofRemoveTempFile(pid_t childpid) {
    char tmpfile[256];

    snprintf(tmpfile,256,"temp-rewriteaof-bg-%d.aof", (int) childpid);
    unlink(tmpfile);
}

740 741 742 743 744 745 746 747 748 749 750 751 752 753 754
/* Update the server.appendonly_current_size filed explicitly using stat(2)
 * to check the size of the file. This is useful after a rewrite or after
 * a restart, normally the size is updated just adding the write length
 * to the current lenght, that is much faster. */
void aofUpdateCurrentSize(void) {
    struct redis_stat sb;

    if (redis_fstat(server.appendfd,&sb) == -1) {
        redisLog(REDIS_WARNING,"Unable to check the AOF length: %s",
            strerror(errno));
    } else {
        server.appendonly_current_size = sb.st_size;
    }
}

755 756
/* A background append only file rewriting (BGREWRITEAOF) terminated its work.
 * Handle this. */
757
void backgroundRewriteDoneHandler(int exitcode, int bysignal) {
758
    if (!bysignal && exitcode == 0) {
759 760
        int newfd, oldfd;
        int nwritten;
761
        char tmpfile[256];
762
        long long now = ustime();
763 764

        redisLog(REDIS_NOTICE,
765 766
            "Background AOF rewrite terminated with success");

767 768 769 770
        /* Flush the differences accumulated by the parent to the
         * rewritten AOF. */
        snprintf(tmpfile,256,"temp-rewriteaof-bg-%d.aof",
            (int)server.bgrewritechildpid);
771 772 773 774
        newfd = open(tmpfile,O_WRONLY|O_APPEND);
        if (newfd == -1) {
            redisLog(REDIS_WARNING,
                "Unable to open the temporary AOF produced by the child: %s", strerror(errno));
775 776
            goto cleanup;
        }
777 778 779 780 781 782 783 784 785 786 787

        nwritten = write(newfd,server.bgrewritebuf,sdslen(server.bgrewritebuf));
        if (nwritten != (signed)sdslen(server.bgrewritebuf)) {
            if (nwritten == -1) {
                redisLog(REDIS_WARNING,
                    "Error trying to flush the parent diff to the rewritten AOF: %s", strerror(errno));
            } else {
                redisLog(REDIS_WARNING,
                    "Short write trying to flush the parent diff to the rewritten AOF: %s", strerror(errno));
            }
            close(newfd);
788 789
            goto cleanup;
        }
790 791 792 793 794 795

        redisLog(REDIS_NOTICE,
            "Parent diff successfully flushed to the rewritten AOF (%lu bytes)", nwritten);

        /* The only remaining thing to do is to rename the temporary file to
         * the configured file and switch the file descriptor used to do AOF
796 797 798 799
         * writes. We don't want close(2) or rename(2) calls to block the
         * server on old file deletion.
         *
         * There are two possible scenarios:
800 801 802 803 804 805 806 807 808 809 810 811 812 813
         *
         * 1) AOF is DISABLED and this was a one time rewrite. The temporary
         * file will be renamed to the configured file. When this file already
         * exists, it will be unlinked, which may block the server.
         *
         * 2) AOF is ENABLED and the rewritten AOF will immediately start
         * receiving writes. After the temporary file is renamed to the
         * configured file, the original AOF file descriptor will be closed.
         * Since this will be the last reference to that file, closing it
         * causes the underlying file to be unlinked, which may block the
         * server.
         *
         * To mitigate the blocking effect of the unlink operation (either
         * caused by rename(2) in scenario 1, or by close(2) in scenario 2), we
814
         * use a background thread to take care of this. First, we
815 816 817 818 819 820 821 822 823
         * make scenario 1 identical to scenario 2 by opening the target file
         * when it exists. The unlink operation after the rename(2) will then
         * be executed upon calling close(2) for its descriptor. Everything to
         * guarantee atomicity for this switch has already happened by then, so
         * we don't care what the outcome or duration of that close operation
         * is, as long as the file descriptor is released again. */
        if (server.appendfd == -1) {
            /* AOF disabled */

824 825 826 827
             /* Don't care if this fails: oldfd will be -1 and we handle that.
              * One notable case of -1 return is if the old file does
              * not exist. */
             oldfd = open(server.appendfilename,O_RDONLY|O_NONBLOCK);
828 829
        } else {
            /* AOF enabled */
830
            oldfd = -1; /* We'll set this to the current AOF filedes later. */
831 832 833 834
        }

        /* Rename the temporary file. This will not unlink the target file if
         * it exists, because we reference it with "oldfd". */
835
        if (rename(tmpfile,server.appendfilename) == -1) {
836 837 838
            redisLog(REDIS_WARNING,
                "Error trying to rename the temporary AOF: %s", strerror(errno));
            close(newfd);
839
            if (oldfd != -1) close(oldfd);
840 841
            goto cleanup;
        }
842 843

        if (server.appendfd == -1) {
844 845
            /* AOF disabled, we don't need to set the AOF file descriptor
             * to this new file, so we can close it. */
846 847
            close(newfd);
        } else {
848
            /* AOF enabled, replace the old fd with the new one. */
849 850
            oldfd = server.appendfd;
            server.appendfd = newfd;
851 852 853 854
            if (server.appendfsync == APPENDFSYNC_ALWAYS)
                aof_fsync(newfd);
            else if (server.appendfsync == APPENDFSYNC_EVERYSEC)
                aof_background_fsync(newfd);
855
            server.appendseldb = -1; /* Make sure SELECT is re-issued */
856
            aofUpdateCurrentSize();
857
            server.auto_aofrewrite_base_size = server.appendonly_current_size;
858 859 860 861 862

            /* Clear regular AOF buffer since its contents was just written to
             * the new AOF from the background rewrite buffer. */
            sdsfree(server.aofbuf);
            server.aofbuf = sdsempty();
863
        }
864 865 866 867

        redisLog(REDIS_NOTICE, "Background AOF rewrite successful");

        /* Asynchronously close the overwritten AOF. */
868
        if (oldfd != -1) bioCreateBackgroundJob(REDIS_BIO_CLOSE_FILE,(void*)(long)oldfd,NULL,NULL);
869 870 871

        redisLog(REDIS_VERBOSE,
            "Background AOF rewrite signal handler took %lldus", ustime()-now);
872
    } else if (!bysignal && exitcode != 0) {
873 874
        redisLog(REDIS_WARNING,
            "Background AOF rewrite terminated with error");
875 876
    } else {
        redisLog(REDIS_WARNING,
877
            "Background AOF rewrite terminated by signal %d", bysignal);
878
    }
879

880 881 882 883 884 885
cleanup:
    sdsfree(server.bgrewritebuf);
    server.bgrewritebuf = sdsempty();
    aofRemoveTempFile(server.bgrewritechildpid);
    server.bgrewritechildpid = -1;
}