aof.c 37.8 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
    redisAssert(server.aof_state != REDIS_AOF_OFF);
23
    flushAppendOnlyFile(1);
A
antirez 已提交
24 25
    aof_fsync(server.aof_fd);
    close(server.aof_fd);
26

A
antirez 已提交
27 28
    server.aof_fd = -1;
    server.aof_selected_db = -1;
29
    server.aof_state = REDIS_AOF_OFF;
30
    /* rewrite operation in progress? kill it, wait child exit */
A
antirez 已提交
31
    if (server.aof_child_pid != -1) {
32 33
        int statloc;

34 35
        redisLog(REDIS_NOTICE,"Killing running AOF rewrite child: %ld",
            (long) server.aof_child_pid);
A
antirez 已提交
36
        if (kill(server.aof_child_pid,SIGKILL) != -1)
37 38
            wait3(&statloc,0,NULL);
        /* reset the buffer accumulating changes while the child saves */
A
antirez 已提交
39 40 41 42
        sdsfree(server.aof_rewrite_buf);
        server.aof_rewrite_buf = sdsempty();
        aofRemoveTempFile(server.aof_child_pid);
        server.aof_child_pid = -1;
43 44 45 46 47 48
    }
}

/* Called when the user switches from "appendonly no" to "appendonly yes"
 * at runtime using the CONFIG command. */
int startAppendOnly(void) {
A
antirez 已提交
49 50
    server.aof_last_fsync = time(NULL);
    server.aof_fd = open(server.aof_filename,O_WRONLY|O_APPEND|O_CREAT,0644);
51
    redisAssert(server.aof_state == REDIS_AOF_OFF);
A
antirez 已提交
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));
54 55 56
        return REDIS_ERR;
    }
    if (rewriteAppendOnlyFileBackground() == REDIS_ERR) {
A
antirez 已提交
57
        close(server.aof_fd);
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.");
59 60
        return REDIS_ERR;
    }
61 62
    /* We correctly switched on AOF, now wait for the rerwite to be complete
     * in order to append data on disk. */
63
    server.aof_state = REDIS_AOF_WAIT_REWRITE;
64 65 66 67 68 69 70 71 72
    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
73 74 75 76 77 78 79 80 81 82 83 84 85
 * 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) {
86
    ssize_t nwritten;
87
    int sync_in_progress = 0;
88

A
antirez 已提交
89
    if (sdslen(server.aof_buf) == 0) return;
90

91
    if (server.aof_fsync == AOF_FSYNC_EVERYSEC)
92 93
        sync_in_progress = bioPendingJobsOfType(REDIS_BIO_AOF_FSYNC) != 0;

94
    if (server.aof_fsync == AOF_FSYNC_EVERYSEC && !force) {
95 96 97 98 99 100 101 102 103 104
        /* 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 已提交
105
                /* We were already waiting for fsync to finish, but for less
106 107 108 109 110
                 * than two seconds this is still ok. Postpone again. */
                return;
            }
            /* Otherwise fall trough, and go write since we can't wait
             * 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.");
112 113 114 115 116 117
        }
    }
    /* 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;

118 119 120 121 122
    /* 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 */
A
antirez 已提交
123 124
    nwritten = write(server.aof_fd,server.aof_buf,sdslen(server.aof_buf));
    if (nwritten != (signed)sdslen(server.aof_buf)) {
125 126 127
        /* 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 已提交
128
        if (nwritten == -1) {
129
            redisLog(REDIS_WARNING,"Exiting on error writing to the append-only file: %s",strerror(errno));
P
Pieter Noordhuis 已提交
130
        } else {
A
antirez 已提交
131 132 133 134 135 136
            redisLog(REDIS_WARNING,"Exiting on short write while writing to "
                                   "the append-only file: %s (nwritten=%ld, "
                                   "expected=%ld)",
                                   strerror(errno),
                                   (long)nwritten,
                                   (long)sdslen(server.aof_buf));
P
Pieter Noordhuis 已提交
137 138
        }
        exit(1);
139
    }
140
    server.aof_current_size += nwritten;
141

142 143
    /* 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). */
A
antirez 已提交
144 145
    if ((sdslen(server.aof_buf)+sdsavail(server.aof_buf)) < 4000) {
        sdsclear(server.aof_buf);
146
    } else {
A
antirez 已提交
147 148
        sdsfree(server.aof_buf);
        server.aof_buf = sdsempty();
149 150
    }

151 152
    /* Don't fsync if no-appendfsync-on-rewrite is set to yes and there are
     * children doing I/O in the background. */
153
    if (server.aof_no_fsync_on_rewrite &&
A
antirez 已提交
154
        (server.aof_child_pid != -1 || server.rdb_child_pid != -1))
155
            return;
156 157

    /* Perform the fsync if needed. */
158
    if (server.aof_fsync == AOF_FSYNC_ALWAYS) {
159 160
        /* aof_fsync is defined as fdatasync() for Linux in order to avoid
         * flushing metadata. */
A
antirez 已提交
161 162
        aof_fsync(server.aof_fd); /* Let's try to get this data on the disk */
        server.aof_last_fsync = server.unixtime;
163
    } else if ((server.aof_fsync == AOF_FSYNC_EVERYSEC &&
A
antirez 已提交
164 165 166
                server.unixtime > server.aof_last_fsync)) {
        if (!sync_in_progress) aof_background_fsync(server.aof_fd);
        server.aof_last_fsync = server.unixtime;
167 168 169
    }
}

170 171 172 173 174 175 176 177 178 179 180
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);

181
    for (j = 0; j < argc; j++) {
182 183 184 185 186 187 188 189
        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);
190 191
        decrRefCount(o);
    }
192
    return dst;
193 194
}

195 196 197 198 199 200 201 202 203
/* 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;
204 205 206 207
    robj *argv[3];

    /* Make sure we can use strtol */
    seconds = getDecodedObject(seconds);
208 209 210 211 212 213 214 215 216 217 218 219 220
    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();
    }
221 222
    decrRefCount(seconds);

223
    argv[0] = createStringObject("PEXPIREAT",9);
224
    argv[1] = key;
225 226
    argv[2] = createStringObjectFromLongLong(when);
    buf = catAppendOnlyGenericCommand(buf, 3, argv);
227 228 229 230 231 232
    decrRefCount(argv[0]);
    decrRefCount(argv[2]);
    return buf;
}

void feedAppendOnlyFile(struct redisCommand *cmd, int dictid, robj **argv, int argc) {
233
    sds buf = sdsempty();
234 235 236 237
    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. */
A
antirez 已提交
238
    if (dictid != server.aof_selected_db) {
239 240 241 242 243
        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);
A
antirez 已提交
244
        server.aof_selected_db = dictid;
245 246
    }

247 248 249 250 251 252
    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 */
253 254 255 256 257
        tmpargv[0] = createStringObject("SET",3);
        tmpargv[1] = argv[1];
        tmpargv[2] = argv[3];
        buf = catAppendOnlyGenericCommand(buf,3,tmpargv);
        decrRefCount(tmpargv[0]);
258
        buf = catAppendOnlyExpireAtCommand(buf,cmd,argv[1],argv[2]);
259
    } else {
260 261 262
        /* All the other commands don't need translation or need the
         * same translation already operated in the command vector
         * for the replication itself. */
263 264 265 266 267
        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
268 269
     * positive reply about the operation performed. */
    if (server.aof_state == REDIS_AOF_ON)
A
antirez 已提交
270
        server.aof_buf = sdscatlen(server.aof_buf,buf,sdslen(buf));
271 272 273 274 275

    /* 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. */
A
antirez 已提交
276 277
    if (server.aof_child_pid != -1)
        server.aof_rewrite_buf = sdscatlen(server.aof_rewrite_buf,buf,sdslen(buf));
278 279 280 281 282 283 284 285 286 287 288 289 290 291

    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;
292
    c->bufpos = 0;
293 294 295 296 297
    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();
298
    c->reply_bytes = 0;
299
    c->watched_keys = listCreate();
300 301 302 303 304 305 306 307 308
    listSetFreeMethod(c->reply,decrRefCount);
    listSetDupMethod(c->reply,dupClientReplyValue);
    initClientMultiState(c);
    return c;
}

void freeFakeClient(struct redisClient *c) {
    sdsfree(c->querybuf);
    listRelease(c->reply);
309
    listRelease(c->watched_keys);
310 311 312 313 314 315 316 317 318 319 320
    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;
321
    int old_aof_state = server.aof_state;
322
    long loops = 0;
323

A
antirez 已提交
324
    if (fp && redis_fstat(fileno(fp),&sb) != -1 && sb.st_size == 0) {
325
        server.aof_current_size = 0;
A
antirez 已提交
326
        fclose(fp);
327
        return REDIS_ERR;
A
antirez 已提交
328
    }
329 330 331 332 333 334 335 336

    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. */
337
    server.aof_state = REDIS_AOF_OFF;
338 339

    fakeClient = createFakeClient();
340 341
    startLoading(fp);

342 343 344 345 346 347 348 349
    while(1) {
        int argc, j;
        unsigned long len;
        robj **argv;
        char buf[128];
        sds argsds;
        struct redisCommand *cmd;

350 351 352 353 354 355
        /* Serve the clients from time to time */
        if (!(loops++ % 1000)) {
            loadingProgress(ftello(fp));
            aeProcessEvents(server.el, AE_FILE_EVENTS|AE_DONT_WAIT);
        }

356 357 358 359 360 361 362 363
        if (fgets(buf,sizeof(buf),fp) == NULL) {
            if (feof(fp))
                break;
            else
                goto readerr;
        }
        if (buf[0] != '*') goto fmterr;
        argc = atoi(buf+1);
364 365
        if (argc < 1) goto fmterr;

366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386
        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);
387 388 389

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

393 394 395 396 397
        /* 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);
398 399 400 401 402 403 404 405
    }

    /* 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);
406
    server.aof_state = old_aof_state;
407
    stopLoading();
408
    aofUpdateCurrentSize();
409
    server.aof_rewrite_base_size = server.aof_current_size;
410 411 412 413 414 415 416 417 418 419
    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 已提交
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>");
421 422 423
    exit(1);
}

P
Pieter Noordhuis 已提交
424 425 426 427 428 429 430 431 432 433 434 435 436 437
/* 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");
    }
}

438 439 440 441 442 443 444 445 446 447 448 449 450 451
/* Emit the commands needed to rebuild a list object.
 * The function returns 0 on error, 1 on success. */
int rewriteListObject(rio *r, robj *key, robj *o) {
    long long count = 0, items = listTypeLength(o);

    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)) {
            if (count == 0) {
452 453
                int cmd_items = (items > REDIS_AOF_REWRITE_ITEMS_PER_CMD) ?
                    REDIS_AOF_REWRITE_ITEMS_PER_CMD : items;
454

455 456 457 458 459 460 461 462 463 464
                if (rioWriteBulkCount(r,'*',2+cmd_items) == 0) return 0;
                if (rioWriteBulkString(r,"RPUSH",5) == 0) return 0;
                if (rioWriteBulkObject(r,key) == 0) return 0;
            }
            if (vstr) {
                if (rioWriteBulkString(r,(char*)vstr,vlen) == 0) return 0;
            } else {
                if (rioWriteBulkLongLong(r,vlong) == 0) return 0;
            }
            p = ziplistNext(zl,p);
465
            if (++count == REDIS_AOF_REWRITE_ITEMS_PER_CMD) count = 0;
466 467 468 469 470 471 472 473 474 475 476
            items--;
        }
    } 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);

477
            if (count == 0) {
478 479
                int cmd_items = (items > REDIS_AOF_REWRITE_ITEMS_PER_CMD) ?
                    REDIS_AOF_REWRITE_ITEMS_PER_CMD : items;
480

481 482 483 484
                if (rioWriteBulkCount(r,'*',2+cmd_items) == 0) return 0;
                if (rioWriteBulkString(r,"RPUSH",5) == 0) return 0;
                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;
487
            items--;
488 489 490 491 492 493 494
        }
    } else {
        redisPanic("Unknown list encoding");
    }
    return 1;
}

495 496 497 498 499 500 501 502 503 504 505
/* Emit the commands needed to rebuild a set object.
 * The function returns 0 on error, 1 on success. */
int rewriteSetObject(rio *r, robj *key, robj *o) {
    long long count = 0, items = setTypeSize(o);

    if (o->encoding == REDIS_ENCODING_INTSET) {
        int ii = 0;
        int64_t llval;

        while(intsetGet(o->ptr,ii++,&llval)) {
            if (count == 0) {
506 507
                int cmd_items = (items > REDIS_AOF_REWRITE_ITEMS_PER_CMD) ?
                    REDIS_AOF_REWRITE_ITEMS_PER_CMD : items;
508 509 510 511 512 513

                if (rioWriteBulkCount(r,'*',2+cmd_items) == 0) return 0;
                if (rioWriteBulkString(r,"SADD",4) == 0) return 0;
                if (rioWriteBulkObject(r,key) == 0) return 0;
            }
            if (rioWriteBulkLongLong(r,llval) == 0) return 0;
514
            if (++count == REDIS_AOF_REWRITE_ITEMS_PER_CMD) count = 0;
515 516 517 518 519 520 521 522 523
            items--;
        }
    } else if (o->encoding == REDIS_ENCODING_HT) {
        dictIterator *di = dictGetIterator(o->ptr);
        dictEntry *de;

        while((de = dictNext(di)) != NULL) {
            robj *eleobj = dictGetKey(de);
            if (count == 0) {
524 525
                int cmd_items = (items > REDIS_AOF_REWRITE_ITEMS_PER_CMD) ?
                    REDIS_AOF_REWRITE_ITEMS_PER_CMD : items;
526 527 528 529 530 531

                if (rioWriteBulkCount(r,'*',2+cmd_items) == 0) return 0;
                if (rioWriteBulkString(r,"SADD",4) == 0) return 0;
                if (rioWriteBulkObject(r,key) == 0) return 0;
            }
            if (rioWriteBulkObject(r,eleobj) == 0) return 0;
532
            if (++count == REDIS_AOF_REWRITE_ITEMS_PER_CMD) count = 0;
533 534 535 536 537 538 539 540 541
            items--;
        }
        dictReleaseIterator(di);
    } else {
        redisPanic("Unknown set encoding");
    }
    return 1;
}

542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564
/* Emit the commands needed to rebuild a sorted set object.
 * The function returns 0 on error, 1 on success. */
int rewriteSortedSetObject(rio *r, robj *key, robj *o) {
    long long count = 0, items = zsetLength(o);

    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);

            if (count == 0) {
565 566
                int cmd_items = (items > REDIS_AOF_REWRITE_ITEMS_PER_CMD) ?
                    REDIS_AOF_REWRITE_ITEMS_PER_CMD : items;
567 568 569 570 571 572 573 574 575 576 577 578

                if (rioWriteBulkCount(r,'*',2+cmd_items*2) == 0) return 0;
                if (rioWriteBulkString(r,"ZADD",4) == 0) return 0;
                if (rioWriteBulkObject(r,key) == 0) return 0;
            }
            if (rioWriteBulkDouble(r,score) == 0) return 0;
            if (vstr != NULL) {
                if (rioWriteBulkString(r,(char*)vstr,vlen) == 0) return 0;
            } else {
                if (rioWriteBulkLongLong(r,vll) == 0) return 0;
            }
            zzlNext(zl,&eptr,&sptr);
579
            if (++count == REDIS_AOF_REWRITE_ITEMS_PER_CMD) count = 0;
580 581 582 583 584 585 586 587 588 589 590 591
            items--;
        }
    } else if (o->encoding == REDIS_ENCODING_SKIPLIST) {
        zset *zs = o->ptr;
        dictIterator *di = dictGetIterator(zs->dict);
        dictEntry *de;

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

            if (count == 0) {
592 593
                int cmd_items = (items > REDIS_AOF_REWRITE_ITEMS_PER_CMD) ?
                    REDIS_AOF_REWRITE_ITEMS_PER_CMD : items;
594 595 596 597 598 599 600

                if (rioWriteBulkCount(r,'*',2+cmd_items*2) == 0) return 0;
                if (rioWriteBulkString(r,"ZADD",4) == 0) return 0;
                if (rioWriteBulkObject(r,key) == 0) return 0;
            }
            if (rioWriteBulkDouble(r,*score) == 0) return 0;
            if (rioWriteBulkObject(r,eleobj) == 0) return 0;
601
            if (++count == REDIS_AOF_REWRITE_ITEMS_PER_CMD) count = 0;
602 603 604 605 606 607 608 609 610
            items--;
        }
        dictReleaseIterator(di);
    } else {
        redisPanic("Unknown sorted zset encoding");
    }
    return 1;
}

A
antirez 已提交
611 612 613 614 615 616 617 618 619 620 621 622
/* Emit the commands needed to rebuild a hash object.
 * The function returns 0 on error, 1 on success. */
int rewriteHashObject(rio *r, robj *key, robj *o) {
    long long count = 0, items = hashTypeLength(o);

    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) {
            if (count == 0) {
623 624
                int cmd_items = (items > REDIS_AOF_REWRITE_ITEMS_PER_CMD) ?
                    REDIS_AOF_REWRITE_ITEMS_PER_CMD : items;
A
antirez 已提交
625 626 627 628 629 630 631

                if (rioWriteBulkCount(r,'*',2+cmd_items*2) == 0) return 0;
                if (rioWriteBulkString(r,"HMSET",5) == 0) return 0;
                if (rioWriteBulkObject(r,key) == 0) return 0;
            }
            if (rioWriteBulkString(r,(char*)field,flen) == 0) return 0;
            if (rioWriteBulkString(r,(char*)val,vlen) == 0) return 0;
632
            if (++count == REDIS_AOF_REWRITE_ITEMS_PER_CMD) count = 0;
A
antirez 已提交
633 634 635 636 637 638 639 640 641 642 643
            items--;
        }
    } else {
        dictIterator *di = dictGetIterator(o->ptr);
        dictEntry *de;

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

            if (count == 0) {
644 645
                int cmd_items = (items > REDIS_AOF_REWRITE_ITEMS_PER_CMD) ?
                    REDIS_AOF_REWRITE_ITEMS_PER_CMD : items;
A
antirez 已提交
646 647 648 649 650 651 652

                if (rioWriteBulkCount(r,'*',2+cmd_items*2) == 0) return 0;
                if (rioWriteBulkString(r,"HMSET",5) == 0) return 0;
                if (rioWriteBulkObject(r,key) == 0) return 0;
            }
            if (rioWriteBulkObject(r,field) == 0) return 0;
            if (rioWriteBulkObject(r,val) == 0) return 0;
653
            if (++count == REDIS_AOF_REWRITE_ITEMS_PER_CMD) count = 0;
A
antirez 已提交
654 655 656 657 658 659 660
            items--;
        }
        dictReleaseIterator(di);
    }
    return 1;
}

661
/* Write a sequence of commands able to fully rebuild the dataset into
662 663 664 665
 * "filename". Used both by REWRITEAOF and BGREWRITEAOF.
 *
 * In order to minimize the number of commands needed in the rewritten
 * 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 669 670
int rewriteAppendOnlyFile(char *filename) {
    dictIterator *di = NULL;
    dictEntry *de;
P
Pieter Noordhuis 已提交
671
    rio aof;
672 673 674
    FILE *fp;
    char tmpfile[256];
    int j;
675
    long long now = mstime();
676 677 678 679 680 681

    /* 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) {
A
antirez 已提交
682
        redisLog(REDIS_WARNING, "Opening the temp file for AOF rewrite in rewriteAppendOnlyFile(): %s", strerror(errno));
683 684
        return REDIS_ERR;
    }
P
Pieter Noordhuis 已提交
685

686
    rioInitWithFile(&aof,fp);
687 688 689 690 691
    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;
692
        di = dictGetSafeIterator(d);
693 694 695 696 697 698
        if (!di) {
            fclose(fp);
            return REDIS_ERR;
        }

        /* SELECT the new DB */
P
Pieter Noordhuis 已提交
699 700
        if (rioWrite(&aof,selectcmd,sizeof(selectcmd)-1) == 0) goto werr;
        if (rioWriteBulkLongLong(&aof,j) == 0) goto werr;
701 702 703

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

708 709
            keystr = dictGetKey(de);
            o = dictGetVal(de);
710
            initStaticStringObject(key,keystr);
711

712 713 714 715 716 717
            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 已提交
718
                if (rioWrite(&aof,cmd,sizeof(cmd)-1) == 0) goto werr;
719
                /* Key and value */
P
Pieter Noordhuis 已提交
720 721
                if (rioWriteBulkObject(&aof,&key) == 0) goto werr;
                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) {
A
antirez 已提交
729
                if (rewriteHashObject(&aof,&key,o) == 0) goto werr;
730 731 732 733 734
            } else {
                redisPanic("Unknown object type");
            }
            /* Save the expire time */
            if (expiretime != -1) {
735
                char cmd[]="*3\r\n$9\r\nPEXPIREAT\r\n";
736 737
                /* If this key is already expired skip it */
                if (expiretime < now) continue;
P
Pieter Noordhuis 已提交
738 739
                if (rioWrite(&aof,cmd,sizeof(cmd)-1) == 0) goto werr;
                if (rioWriteBulkObject(&aof,&key) == 0) goto werr;
740
                if (rioWriteBulkLongLong(&aof,expiretime) == 0) goto werr;
741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773
            }
        }
        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.
A
antirez 已提交
774
 *    2b) the parent accumulates differences in server.aof_rewrite_buf.
775 776
 * 3) When the child finished '2a' exists.
 * 4) The parent will trap the exit code, if it's OK, will append the
A
antirez 已提交
777
 *    data accumulated into server.aof_rewrite_buf into the temp file, and
778 779 780 781 782
 *    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;
783
    long long start;
784

A
antirez 已提交
785
    if (server.aof_child_pid != -1) return REDIS_ERR;
786
    start = ustime();
787 788 789
    if ((childpid = fork()) == 0) {
        char tmpfile[256];

790
        /* Child */
791 792
        if (server.ipfd > 0) close(server.ipfd);
        if (server.sofd > 0) close(server.sofd);
793 794 795 796 797 798 799 800
        snprintf(tmpfile,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
        if (rewriteAppendOnlyFile(tmpfile) == REDIS_OK) {
            _exit(0);
        } else {
            _exit(1);
        }
    } else {
        /* Parent */
801
        server.stat_fork_time = ustime()-start;
802 803 804 805 806 807 808 809
        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);
810
        server.aof_rewrite_scheduled = 0;
A
antirez 已提交
811
        server.aof_child_pid = childpid;
812 813 814
        updateDictResizePolicy();
        /* We set appendseldb to -1 in order to force the next call to the
         * feedAppendOnlyFile() to issue a SELECT command, so the differences
A
antirez 已提交
815
         * accumulated by the parent into server.aof_rewrite_buf will start
816
         * with a SELECT statement and it will be safe to merge. */
A
antirez 已提交
817
        server.aof_selected_db = -1;
818 819 820 821 822 823
        return REDIS_OK;
    }
    return REDIS_OK; /* unreached */
}

void bgrewriteaofCommand(redisClient *c) {
A
antirez 已提交
824
    if (server.aof_child_pid != -1) {
825
        addReplyError(c,"Background append only file rewriting already in progress");
A
antirez 已提交
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");
831 832 833 834 835 836 837 838 839 840 841 842
    } 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);
}

843
/* Update the server.aof_current_size filed explicitly using stat(2)
844 845 846 847 848 849
 * 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;

A
antirez 已提交
850
    if (redis_fstat(server.aof_fd,&sb) == -1) {
A
antirez 已提交
851
        redisLog(REDIS_WARNING,"Unable to obtain the AOF file length. stat: %s",
852 853
            strerror(errno));
    } else {
854
        server.aof_current_size = sb.st_size;
855 856 857
    }
}

858 859
/* A background append only file rewriting (BGREWRITEAOF) terminated its work.
 * Handle this. */
860
void backgroundRewriteDoneHandler(int exitcode, int bysignal) {
861
    if (!bysignal && exitcode == 0) {
862 863
        int newfd, oldfd;
        int nwritten;
864
        char tmpfile[256];
865
        long long now = ustime();
866 867

        redisLog(REDIS_NOTICE,
868 869
            "Background AOF rewrite terminated with success");

870 871 872
        /* Flush the differences accumulated by the parent to the
         * rewritten AOF. */
        snprintf(tmpfile,256,"temp-rewriteaof-bg-%d.aof",
A
antirez 已提交
873
            (int)server.aof_child_pid);
874 875 876 877
        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));
878 879
            goto cleanup;
        }
880

A
antirez 已提交
881 882
        nwritten = write(newfd,server.aof_rewrite_buf,sdslen(server.aof_rewrite_buf));
        if (nwritten != (signed)sdslen(server.aof_rewrite_buf)) {
883 884 885 886 887 888 889 890
            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);
891 892
            goto cleanup;
        }
893 894 895 896 897 898

        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
899 900 901 902
         * writes. We don't want close(2) or rename(2) calls to block the
         * server on old file deletion.
         *
         * There are two possible scenarios:
903 904 905 906 907 908 909 910 911 912 913 914 915 916
         *
         * 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
917
         * use a background thread to take care of this. First, we
918 919 920 921 922 923
         * 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. */
A
antirez 已提交
924
        if (server.aof_fd == -1) {
925 926
            /* AOF disabled */

927 928 929
             /* 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. */
930
             oldfd = open(server.aof_filename,O_RDONLY|O_NONBLOCK);
931 932
        } else {
            /* AOF enabled */
933
            oldfd = -1; /* We'll set this to the current AOF filedes later. */
934 935 936 937
        }

        /* Rename the temporary file. This will not unlink the target file if
         * it exists, because we reference it with "oldfd". */
938
        if (rename(tmpfile,server.aof_filename) == -1) {
939
            redisLog(REDIS_WARNING,
A
antirez 已提交
940
                "Error trying to rename the temporary AOF file: %s", strerror(errno));
941
            close(newfd);
942
            if (oldfd != -1) close(oldfd);
943 944
            goto cleanup;
        }
945

A
antirez 已提交
946
        if (server.aof_fd == -1) {
947 948
            /* AOF disabled, we don't need to set the AOF file descriptor
             * to this new file, so we can close it. */
949 950
            close(newfd);
        } else {
951
            /* AOF enabled, replace the old fd with the new one. */
A
antirez 已提交
952 953
            oldfd = server.aof_fd;
            server.aof_fd = newfd;
954
            if (server.aof_fsync == AOF_FSYNC_ALWAYS)
955
                aof_fsync(newfd);
956
            else if (server.aof_fsync == AOF_FSYNC_EVERYSEC)
957
                aof_background_fsync(newfd);
A
antirez 已提交
958
            server.aof_selected_db = -1; /* Make sure SELECT is re-issued */
959
            aofUpdateCurrentSize();
960
            server.aof_rewrite_base_size = server.aof_current_size;
961 962 963

            /* Clear regular AOF buffer since its contents was just written to
             * the new AOF from the background rewrite buffer. */
A
antirez 已提交
964 965
            sdsfree(server.aof_buf);
            server.aof_buf = sdsempty();
966
        }
967

A
antirez 已提交
968
        redisLog(REDIS_NOTICE, "Background AOF rewrite finished successfully");
969 970 971
        /* Change state from WAIT_REWRITE to ON if needed */
        if (server.aof_state == REDIS_AOF_WAIT_REWRITE)
            server.aof_state = REDIS_AOF_ON;
972 973

        /* Asynchronously close the overwritten AOF. */
974
        if (oldfd != -1) bioCreateBackgroundJob(REDIS_BIO_CLOSE_FILE,(void*)(long)oldfd,NULL,NULL);
975 976 977

        redisLog(REDIS_VERBOSE,
            "Background AOF rewrite signal handler took %lldus", ustime()-now);
978
    } else if (!bysignal && exitcode != 0) {
979 980
        redisLog(REDIS_WARNING,
            "Background AOF rewrite terminated with error");
981 982
    } else {
        redisLog(REDIS_WARNING,
983
            "Background AOF rewrite terminated by signal %d", bysignal);
984
    }
985

986
cleanup:
A
antirez 已提交
987 988 989 990
    sdsfree(server.aof_rewrite_buf);
    server.aof_rewrite_buf = sdsempty();
    aofRemoveTempFile(server.aof_child_pid);
    server.aof_child_pid = -1;
991 992
    /* Schedule a new rewrite if we are waiting for it to switch the AOF ON. */
    if (server.aof_state == REDIS_AOF_WAIT_REWRITE)
993
        server.aof_rewrite_scheduled = 1;
994
}