aof.c 54.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
/*
 * Copyright (c) 2009-2012, Salvatore Sanfilippo <antirez at gmail dot com>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   * Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *   * Neither the name of Redis nor the names of its contributors may be used
 *     to endorse or promote products derived from this software without
 *     specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

30
#include "redis.h"
31
#include "bio.h"
A
antirez 已提交
32
#include "rio.h"
33 34 35 36

#include <signal.h>
#include <fcntl.h>
#include <sys/stat.h>
37
#include <sys/types.h>
H
Henry Rawas 已提交
38
#ifndef _WIN32
39 40 41
#include <sys/time.h>
#include <sys/resource.h>
#include <sys/wait.h>
H
Henry Rawas 已提交
42
#endif
43

44 45
void aofUpdateCurrentSize(void);

46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
/* ----------------------------------------------------------------------------
 * AOF rewrite buffer implementation.
 *
 * The following code implement a simple buffer used in order to accumulate
 * changes while the background process is rewriting the AOF file.
 *
 * We only need to append, but can't just use realloc with a large block
 * because 'huge' reallocs are not always handled as one could expect
 * (via remapping of pages at OS level) but may involve copying data.
 *
 * For this reason we use a list of blocks, every block is
 * AOF_RW_BUF_BLOCK_SIZE bytes.
 * ------------------------------------------------------------------------- */

#define AOF_RW_BUF_BLOCK_SIZE (1024*1024*10)    /* 10 MB per block */

typedef struct aofrwblock {
    unsigned long used, free;
    char buf[AOF_RW_BUF_BLOCK_SIZE];
} aofrwblock;

/* This function free the old AOF rewrite buffer if needed, and initialize
 * a fresh new one. It tests for server.aof_rewrite_buf_blocks equal to NULL
 * so can be used for the first initialization as well. */
void aofRewriteBufferReset(void) {
    if (server.aof_rewrite_buf_blocks)
        listRelease(server.aof_rewrite_buf_blocks);

    server.aof_rewrite_buf_blocks = listCreate();
    listSetFreeMethod(server.aof_rewrite_buf_blocks,zfree);
}

/* Return the current size of the AOF rerwite buffer. */
unsigned long aofRewriteBufferSize(void) {
H
Henry Rawas 已提交
80
    unsigned long size;
81 82 83 84
    listNode *ln = listLast(server.aof_rewrite_buf_blocks);
    aofrwblock *block = ln ? ln->value : NULL;

    if (block == NULL) return 0;
H
Henry Rawas 已提交
85
    size =
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
        (listLength(server.aof_rewrite_buf_blocks)-1) * AOF_RW_BUF_BLOCK_SIZE;
    size += block->used;
    return size;
}

/* Append data to the AOF rewrite buffer, allocating new blocks if needed. */
void aofRewriteBufferAppend(unsigned char *s, unsigned long len) {
    listNode *ln = listLast(server.aof_rewrite_buf_blocks);
    aofrwblock *block = ln ? ln->value : NULL;

    while(len) {
        /* If we already got at least an allocated block, try appending
         * at least some piece into it. */
        if (block) {
            unsigned long thislen = (block->free < len) ? block->free : len;
            if (thislen) {  /* The current block is not already full. */
                memcpy(block->buf+block->used, s, thislen);
                block->used += thislen;
                block->free -= thislen;
                s += thislen;
                len -= thislen;
            }
        }

        if (len) { /* First block to allocate, or need another block. */
            int numblocks;

            block = zmalloc(sizeof(*block));
            block->free = AOF_RW_BUF_BLOCK_SIZE;
            block->used = 0;
            listAddNodeTail(server.aof_rewrite_buf_blocks,block);

            /* Log every time we cross more 10 or 100 blocks, respectively
             * as a notice or warning. */
            numblocks = listLength(server.aof_rewrite_buf_blocks);
            if (((numblocks+1) % 10) == 0) {
                int level = ((numblocks+1) % 100) == 0 ? REDIS_WARNING :
                                                         REDIS_NOTICE;
                redisLog(level,"Background AOF buffer size: %lu MB",
                    aofRewriteBufferSize()/(1024*1024));
            }
        }
    }
}

/* Write the buffer (possibly composed of multiple blocks) into the specified
132
 * fd. If a short write or any other error happens -1 is returned,
133 134 135 136 137 138 139 140 141 142 143 144 145
 * otherwise the number of bytes written is returned. */
ssize_t aofRewriteBufferWrite(int fd) {
    listNode *ln;
    listIter li;
    ssize_t count = 0;

    listRewind(server.aof_rewrite_buf_blocks,&li);
    while((ln = listNext(&li))) {
        aofrwblock *block = listNodeValue(ln);
        ssize_t nwritten;

        if (block->used) {
            nwritten = write(fd,block->buf,block->used);
146
            if (nwritten != (ssize_t)block->used) {
147 148 149 150 151 152 153 154 155
                if (nwritten == 0) errno = EIO;
                return -1;
            }
            count += nwritten;
        }
    }
    return count;
}

156 157 158 159 160 161
/* ----------------------------------------------------------------------------
 * AOF file implementation
 * ------------------------------------------------------------------------- */

/* Starts a background task that performs fsync() against the specified
 * file descriptor (the one of the AOF file) in another thread. */
162
void aof_background_fsync(int fd) {
A
antirez 已提交
163
    bioCreateBackgroundJob(REDIS_BIO_AOF_FSYNC,(void*)(long)fd,NULL,NULL);
164 165
}

166 167 168
/* Called when the user switches from "appendonly yes" to "appendonly no"
 * at runtime using the CONFIG command. */
void stopAppendOnly(void) {
169
    redisAssert(server.aof_state != REDIS_AOF_OFF);
170
    flushAppendOnlyFile(1);
A
antirez 已提交
171 172
    aof_fsync(server.aof_fd);
    close(server.aof_fd);
173

A
antirez 已提交
174 175
    server.aof_fd = -1;
    server.aof_selected_db = -1;
176
    server.aof_state = REDIS_AOF_OFF;
177
    /* rewrite operation in progress? kill it, wait child exit */
A
antirez 已提交
178
    if (server.aof_child_pid != -1) {
179 180
        redisLog(REDIS_NOTICE,"Killing running AOF rewrite child: %ld",
            (long) server.aof_child_pid);
181 182
#ifdef _WIN32
        AbortForkOperation();
H
Henry Rawas 已提交
183
#else
184 185
        {
            int statloc;
186
        if (kill(server.aof_child_pid,SIGUSR1) != -1)
187 188
                wait3(&statloc,0,NULL);
        }
H
Henry Rawas 已提交
189
#endif
190
        /* reset the buffer accumulating changes while the child saves */
191
        aofRewriteBufferReset();
A
antirez 已提交
192 193
        aofRemoveTempFile(server.aof_child_pid);
        server.aof_child_pid = -1;
194
        server.aof_rewrite_time_start = -1;
195 196 197 198 199 200
    }
}

/* Called when the user switches from "appendonly no" to "appendonly yes"
 * at runtime using the CONFIG command. */
int startAppendOnly(void) {
201
    server.aof_last_fsync = server.unixtime;
H
Henry Rawas 已提交
202 203 204
#ifdef _WIN32
    server.aof_fd = open(server.aof_filename,O_WRONLY|O_APPEND|O_CREAT|_O_BINARY,_S_IREAD|_S_IWRITE);
#else
A
antirez 已提交
205
    server.aof_fd = open(server.aof_filename,O_WRONLY|O_APPEND|O_CREAT,0644);
H
Henry Rawas 已提交
206
#endif
207
    redisAssert(server.aof_state == REDIS_AOF_OFF);
A
antirez 已提交
208
    if (server.aof_fd == -1) {
209
        redisLog(REDIS_WARNING,"Redis needs to enable the AOF but can't open the append only file: %s",strerror(errno));
210 211 212
        return REDIS_ERR;
    }
    if (rewriteAppendOnlyFileBackground() == REDIS_ERR) {
A
antirez 已提交
213
        close(server.aof_fd);
214
        server.aof_fd = -1;
215
        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.");
216 217
        return REDIS_ERR;
    }
218 219
    /* We correctly switched on AOF, now wait for the rerwite to be complete
     * in order to append data on disk. */
220
    server.aof_state = REDIS_AOF_WAIT_REWRITE;
221 222 223 224 225 226 227 228 229
    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
230 231 232 233 234 235 236 237 238 239 240 241
 * 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. */
242
#define AOF_WRITE_LOG_ERROR_RATE 30 /* Seconds between errors logging. */
243
void flushAppendOnlyFile(int force) {
244
    ssize_t nwritten;
245
    int sync_in_progress = 0;
246
    mstime_t latency;
247

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

250
    if (server.aof_fsync == AOF_FSYNC_EVERYSEC)
251 252
        sync_in_progress = bioPendingJobsOfType(REDIS_BIO_AOF_FSYNC) != 0;

253
    if (server.aof_fsync == AOF_FSYNC_EVERYSEC && !force) {
254 255 256 257 258 259 260 261 262 263
        /* 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 已提交
264
                /* We were already waiting for fsync to finish, but for less
265 266 267 268 269
                 * than two seconds this is still ok. Postpone again. */
                return;
            }
            /* Otherwise fall trough, and go write since we can't wait
             * over two seconds. */
270
            server.aof_delayed_fsync++;
271
            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.");
272 273 274 275 276 277
        }
    }
    /* 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;

278 279 280 281 282
    /* 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 */
283

284
    latencyStartMonitor(latency);
A
antirez 已提交
285
    nwritten = write(server.aof_fd,server.aof_buf,sdslen(server.aof_buf));
286
    latencyEndMonitor(latency);
287 288 289 290 291
    /* We want to capture different events for delayed writes:
     * when the delay happens with a pending fsync, or with a saving child
     * active, and when the above two conditions are missing.
     * We also use an additional event name to save all samples which is
     * useful for graphing / monitoring purposes. */
292
    if (sync_in_progress) {
293 294 295 296 297 298
        latencyAddSampleIfNeeded("aof-write-pending-fsync",latency);
    } else if (server.aof_child_pid != -1 || server.rdb_child_pid != -1) {
        latencyAddSampleIfNeeded("aof-write-active-child",latency);
    } else {
        latencyAddSampleIfNeeded("aof-write-alone",latency);
    }
299 300
    latencyAddSampleIfNeeded("aof-write",latency);

301 302 303
    /* We performed the write so reset the postponed flush sentinel to zero. */
    server.aof_flush_postponed_start = 0;

A
antirez 已提交
304
    if (nwritten != (signed)sdslen(server.aof_buf)) {
305 306 307 308 309 310 311 312 313 314
        static time_t last_write_error_log = 0;
        int can_log = 0;

        /* Limit logging rate to 1 line per AOF_WRITE_LOG_ERROR_RATE seconds. */
        if ((server.unixtime - last_write_error_log) > AOF_WRITE_LOG_ERROR_RATE) {
            can_log = 1;
            last_write_error_log = server.unixtime;
        }

        /* Lof the AOF write error and record the error code. */
P
Pieter Noordhuis 已提交
315
        if (nwritten == -1) {
316 317 318 319 320
            if (can_log) {
                redisLog(REDIS_WARNING,"Error writing to the AOF file: %s",
                    strerror(errno));
                server.aof_last_write_errno = errno;
            }
P
Pieter Noordhuis 已提交
321
        } else {
322 323 324 325 326 327 328
            if (can_log) {
                redisLog(REDIS_WARNING,"Short write while writing to "
                                       "the AOF file: (nwritten=%lld, "
                                       "expected=%lld)",
                                       (long long)nwritten,
                                       (long long)sdslen(server.aof_buf));
            }
329 330

            if (ftruncate(server.aof_fd, server.aof_current_size) == -1) {
331 332 333 334 335 336 337 338 339 340
                if (can_log) {
                    redisLog(REDIS_WARNING, "Could not remove short write "
                             "from the append-only file.  Redis may refuse "
                             "to load the AOF the next time it starts.  "
                             "ftruncate: %s", strerror(errno));
                }
            } else {
                /* If the ftrunacate() succeeded we can set nwritten to
                 * -1 since there is no longer partial data into the AOF. */
                nwritten = -1;
341
            }
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
            server.aof_last_write_errno = ENOSPC;
        }

        /* Handle the AOF write error. */
        if (server.aof_fsync == AOF_FSYNC_ALWAYS) {
            /* We can't recover when the fsync policy is ALWAYS since the
             * reply for the client is already in the output buffers, and we
             * have the contract with the user that on acknowledged write data
             * is synched on disk. */
            redisLog(REDIS_WARNING,"Can't recover from AOF write error when the AOF fsync policy is 'always'. Exiting...");
            exit(1);
        } else {
            /* Recover from failed write leaving data into the buffer. However
             * set an error to stop accepting writes as long as the error
             * condition is not cleared. */
            server.aof_last_write_status = REDIS_ERR;

            /* Trim the sds buffer if there was a partial write, and there
             * was no way to undo it with ftruncate(2). */
            if (nwritten > 0) {
                server.aof_current_size += nwritten;
                sdsrange(server.aof_buf,nwritten,-1);
            }
            return; /* We'll try again on the next call... */
        }
    } else {
        /* Successful write(2). If AOF was in error state, restore the
         * OK state and log the event. */
        if (server.aof_last_write_status == REDIS_ERR) {
            redisLog(REDIS_WARNING,
                "AOF write error looks solved, Redis can write again.");
            server.aof_last_write_status = REDIS_OK;
P
Pieter Noordhuis 已提交
374
        }
375
    }
376
    server.aof_current_size += nwritten;
377

378 379
    /* 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 已提交
380 381
    if ((sdslen(server.aof_buf)+sdsavail(server.aof_buf)) < 4000) {
        sdsclear(server.aof_buf);
382
    } else {
A
antirez 已提交
383 384
        sdsfree(server.aof_buf);
        server.aof_buf = sdsempty();
385 386
    }

387 388
    /* Don't fsync if no-appendfsync-on-rewrite is set to yes and there are
     * children doing I/O in the background. */
389
    if (server.aof_no_fsync_on_rewrite &&
A
antirez 已提交
390
        (server.aof_child_pid != -1 || server.rdb_child_pid != -1))
391
            return;
392 393

    /* Perform the fsync if needed. */
394
    if (server.aof_fsync == AOF_FSYNC_ALWAYS) {
395 396
        /* aof_fsync is defined as fdatasync() for Linux in order to avoid
         * flushing metadata. */
397
        latencyStartMonitor(latency);
A
antirez 已提交
398
        aof_fsync(server.aof_fd); /* Let's try to get this data on the disk */
399 400
        latencyEndMonitor(latency);
        latencyAddSampleIfNeeded("aof-fsync-always",latency);
A
antirez 已提交
401
        server.aof_last_fsync = server.unixtime;
402
    } else if ((server.aof_fsync == AOF_FSYNC_EVERYSEC &&
A
antirez 已提交
403 404 405
                server.unixtime > server.aof_last_fsync)) {
        if (!sync_in_progress) aof_background_fsync(server.aof_fd);
        server.aof_last_fsync = server.unixtime;
406 407 408
    }
}

409 410 411 412 413 414 415 416 417 418 419
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);

420
    for (j = 0; j < argc; j++) {
421 422 423 424 425 426 427 428
        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);
429 430
        decrRefCount(o);
    }
431
    return dst;
432 433
}

434 435 436 437 438 439 440 441 442
/* 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;
443 444 445 446
    robj *argv[3];

    /* Make sure we can use strtol */
    seconds = getDecodedObject(seconds);
447 448 449 450 451 452 453 454 455 456 457 458 459
    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();
    }
460 461
    decrRefCount(seconds);

462
    argv[0] = createStringObject("PEXPIREAT",9);
463
    argv[1] = key;
464 465
    argv[2] = createStringObjectFromLongLong(when);
    buf = catAppendOnlyGenericCommand(buf, 3, argv);
466 467 468 469 470 471
    decrRefCount(argv[0]);
    decrRefCount(argv[2]);
    return buf;
}

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

G
guiquanz 已提交
475
    /* The DB this command was targeting is not the same as the last command
476
     * we appendend. To issue a SELECT command is needed. */
A
antirez 已提交
477
    if (dictid != server.aof_selected_db) {
478 479 480 481 482
        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 已提交
483
        server.aof_selected_db = dictid;
484 485
    }

486 487 488 489 490 491
    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 */
492 493 494 495 496
        tmpargv[0] = createStringObject("SET",3);
        tmpargv[1] = argv[1];
        tmpargv[2] = argv[3];
        buf = catAppendOnlyGenericCommand(buf,3,tmpargv);
        decrRefCount(tmpargv[0]);
497
        buf = catAppendOnlyExpireAtCommand(buf,cmd,argv[1],argv[2]);
498
    } else {
499 500 501
        /* All the other commands don't need translation or need the
         * same translation already operated in the command vector
         * for the replication itself. */
502 503 504 505 506
        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
507 508
     * positive reply about the operation performed. */
    if (server.aof_state == REDIS_AOF_ON)
A
antirez 已提交
509
        server.aof_buf = sdscatlen(server.aof_buf,buf,sdslen(buf));
510 511 512 513 514

    /* 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 已提交
515
    if (server.aof_child_pid != -1)
H
Henry Rawas 已提交
516
        aofRewriteBufferAppend((unsigned char*)buf,(unsigned long)sdslen(buf));
517 518 519 520

    sdsfree(buf);
}

521 522 523 524
/* ----------------------------------------------------------------------------
 * AOF loading
 * ------------------------------------------------------------------------- */

525 526 527 528 529 530 531
/* 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;
532
    c->name = NULL;
533
    c->querybuf = sdsempty();
534
    c->querybuf_peak = 0;
535 536
    c->argc = 0;
    c->argv = NULL;
537
    c->bufpos = 0;
538 539 540 541 542
    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();
543
    c->reply_bytes = 0;
544
    c->obuf_soft_limit_reached_time = 0;
545
    c->watched_keys = listCreate();
546
    c->peerid = NULL;
547
    listSetFreeMethod(c->reply,decrRefCountVoid);
548 549 550 551 552
    listSetDupMethod(c->reply,dupClientReplyValue);
    initClientMultiState(c);
    return c;
}

553 554 555 556 557 558 559 560
void freeFakeClientArgv(struct redisClient *c) {
    int j;

    for (j = 0; j < c->argc; j++)
        decrRefCount(c->argv[j]);
    zfree(c->argv);
}

561 562 563
void freeFakeClient(struct redisClient *c) {
    sdsfree(c->querybuf);
    listRelease(c->reply);
564
    listRelease(c->watched_keys);
565 566 567 568 569 570 571 572 573
    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;
H
Henry Rawas 已提交
574 575 576
#ifdef _WIN32
    FILE *fp = fopen(filename,"rb");
#else
577
    FILE *fp = fopen(filename,"r");
H
Henry Rawas 已提交
578
#endif
579
    struct redis_stat sb;
580
    int old_aof_state = server.aof_state;
581
    long loops = 0;
582
    off_t valid_up_to = 0; /* Offset of the latest well-formed command loaded. */
583

A
antirez 已提交
584
    if (fp && redis_fstat(fileno(fp),&sb) != -1 && sb.st_size == 0) {
585
        server.aof_current_size = 0;
A
antirez 已提交
586
        fclose(fp);
587
        return REDIS_ERR;
A
antirez 已提交
588
    }
589 590 591 592 593 594 595 596

    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. */
597
    server.aof_state = REDIS_AOF_OFF;
598 599

    fakeClient = createFakeClient();
600 601
    startLoading(fp);

602 603
    while(1) {
        int argc, j;
H
Henry Rawas 已提交
604 605 606
#ifdef _WIN32
        size_t len;
#else
607
        unsigned long len;
H
Henry Rawas 已提交
608
#endif
609 610 611 612 613
        robj **argv;
        char buf[128];
        sds argsds;
        struct redisCommand *cmd;

614 615
        /* Serve the clients from time to time */
        if (!(loops++ % 1000)) {
H
Henry Rawas 已提交
616
            loadingProgress((off_t)ftello(fp));
617
            processEventsWhileBlocked();
618 619
        }

620 621 622 623 624 625 626
        if (fgets(buf,sizeof(buf),fp) == NULL) {
            if (feof(fp))
                break;
            else
                goto readerr;
        }
        if (buf[0] != '*') goto fmterr;
A
antirez 已提交
627
        if (buf[1] == '\0') goto readerr;
628
        argc = atoi(buf+1);
629 630
        if (argc < 1) goto fmterr;

631
        argv = zmalloc(sizeof(robj*)*argc);
632 633 634
        fakeClient->argc = argc;
        fakeClient->argv = argv;

635
        for (j = 0; j < argc; j++) {
636 637 638 639 640
            if (fgets(buf,sizeof(buf),fp) == NULL) {
                fakeClient->argc = j; /* Free up to j-1. */
                freeFakeClientArgv(fakeClient);
                goto readerr;
            }
641 642 643
            if (buf[0] != '$') goto fmterr;
            len = strtol(buf+1,NULL,10);
            argsds = sdsnewlen(NULL,len);
644 645 646 647 648 649
            if (len && fread(argsds,len,1,fp) == 0) {
                sdsfree(argsds);
                fakeClient->argc = j; /* Free up to j-1. */
                freeFakeClientArgv(fakeClient);
                goto readerr;
            }
650
            argv[j] = createObject(REDIS_STRING,argsds);
651 652 653 654 655
            if (fread(buf,2,1,fp) == 0) {
                fakeClient->argc = j+1; /* Free up to j. */
                freeFakeClientArgv(fakeClient);
                goto readerr; /* discard CRLF */
            }
656 657 658 659 660
        }

        /* Command lookup */
        cmd = lookupCommand(argv[0]->ptr);
        if (!cmd) {
661
            redisLog(REDIS_WARNING,"Unknown command '%s' reading the append only file", (char*)argv[0]->ptr);
662 663
            exit(1);
        }
664

665 666
        /* Run the command in the context of a fake client */
        cmd->proc(fakeClient);
667 668 669

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

673 674
        /* Clean up. Command code may have changed argv/argc so we use the
         * argv/argc of the client instead of the local variables. */
675
        freeFakeClientArgv(fakeClient);
676
        if (server.aof_load_truncated) valid_up_to = ftello(fp);
677 678 679 680
    }

    /* 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. */
681
    if (fakeClient->flags & REDIS_MULTI) goto uxeof;
682

A
antirez 已提交
683
loaded_ok: /* DB loaded, cleanup and return REDIS_OK to the caller. */
684 685
    fclose(fp);
    freeFakeClient(fakeClient);
686
    server.aof_state = old_aof_state;
687
    stopLoading();
688
    aofUpdateCurrentSize();
689
    server.aof_rewrite_base_size = server.aof_current_size;
690 691
    return REDIS_OK;

692 693
readerr: /* Read error. If feof(fp) is true, fall through to unexpected EOF. */
    if (!feof(fp)) {
694
        redisLog(REDIS_WARNING,"Unrecoverable error reading the append only file: %s", strerror(errno));
695
        exit(1);
696
    }
697 698

uxeof: /* Unexpected AOF end of file. */
A
antirez 已提交
699 700
    if (server.aof_load_truncated) {
        redisLog(REDIS_WARNING,"!!! Warning: short read while loading the AOF file !!!");
701 702 703 704 705 706 707 708 709 710
        redisLog(REDIS_WARNING,"!!! Truncating the AOF at offset %llu !!!",
            (unsigned long long) valid_up_to);
        if (valid_up_to == -1 || truncate(filename,valid_up_to) == -1) {
            if (valid_up_to == -1) {
                redisLog(REDIS_WARNING,"Last valid command offset is invalid");
            } else {
                redisLog(REDIS_WARNING,"Error truncating the AOF file: %s",
                    strerror(errno));
            }
        } else {
711 712 713 714 715 716 717 718 719 720
            /* Make sure the AOF file descriptor points to the end of the
             * file after the truncate call. */
            if (server.aof_fd != -1 && lseek(server.aof_fd,0,SEEK_END) == -1) {
                redisLog(REDIS_WARNING,"Can't seek the end of the AOF file: %s",
                    strerror(errno));
            } else {
                redisLog(REDIS_WARNING,
                    "AOF loaded anyway because aof-load-truncated is enabled");
                goto loaded_ok;
            }
721
        }
A
antirez 已提交
722 723
    }
    redisLog(REDIS_WARNING,"Unexpected end of file reading the append only file. You can: 1) Make a backup of your AOF file, then use ./redis-check-aof --fix <filename>. 2) Alternatively you can set the 'aof-load-truncated' configuration option to yes and restart the server.");
724
    exit(1);
725 726

fmterr: /* Format error. */
A
antirez 已提交
727
    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>");
728 729 730
    exit(1);
}

731 732 733 734
/* ----------------------------------------------------------------------------
 * AOF rewrite
 * ------------------------------------------------------------------------- */

P
Pieter Noordhuis 已提交
735 736 737 738 739 740
/* 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) {
H
Henry Rawas 已提交
741
        return (int)rioWriteBulkLongLong(r,(long)obj->ptr);
P
Pieter Noordhuis 已提交
742
    } else if (obj->encoding == REDIS_ENCODING_RAW) {
H
Henry Rawas 已提交
743
        return (int)rioWriteBulkString(r,obj->ptr,sdslen(obj->ptr));
P
Pieter Noordhuis 已提交
744 745 746 747 748
    } else {
        redisPanic("Unknown string encoding");
    }
}

749 750 751 752 753 754 755 756 757 758 759 760 761 762
/* 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) {
763
                int cmd_items = (items > REDIS_AOF_REWRITE_ITEMS_PER_CMD) ?
H
Henry Rawas 已提交
764
                    REDIS_AOF_REWRITE_ITEMS_PER_CMD : (int)items;
765

766 767 768 769 770 771 772 773 774 775
                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);
776
            if (++count == REDIS_AOF_REWRITE_ITEMS_PER_CMD) count = 0;
777 778 779 780 781 782 783 784 785 786 787
            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);

788
            if (count == 0) {
789
                int cmd_items = (items > REDIS_AOF_REWRITE_ITEMS_PER_CMD) ?
H
Henry Rawas 已提交
790
                    REDIS_AOF_REWRITE_ITEMS_PER_CMD : (int)items;
791

792 793 794 795
                if (rioWriteBulkCount(r,'*',2+cmd_items) == 0) return 0;
                if (rioWriteBulkString(r,"RPUSH",5) == 0) return 0;
                if (rioWriteBulkObject(r,key) == 0) return 0;
            }
796
            if (rioWriteBulkObject(r,eleobj) == 0) return 0;
797
            if (++count == REDIS_AOF_REWRITE_ITEMS_PER_CMD) count = 0;
798
            items--;
799 800 801 802 803 804 805
        }
    } else {
        redisPanic("Unknown list encoding");
    }
    return 1;
}

806 807 808 809 810 811 812 813 814 815 816
/* 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) {
817
                int cmd_items = (items > REDIS_AOF_REWRITE_ITEMS_PER_CMD) ?
H
Henry Rawas 已提交
818
                    REDIS_AOF_REWRITE_ITEMS_PER_CMD : (int)items;
819 820 821 822 823 824

                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;
825
            if (++count == REDIS_AOF_REWRITE_ITEMS_PER_CMD) count = 0;
826 827 828 829 830 831 832 833 834
            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) {
835
                int cmd_items = (items > REDIS_AOF_REWRITE_ITEMS_PER_CMD) ?
H
Henry Rawas 已提交
836
                    REDIS_AOF_REWRITE_ITEMS_PER_CMD : (int)items;
837 838 839 840 841 842

                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;
843
            if (++count == REDIS_AOF_REWRITE_ITEMS_PER_CMD) count = 0;
844 845 846 847 848 849 850 851 852
            items--;
        }
        dictReleaseIterator(di);
    } else {
        redisPanic("Unknown set encoding");
    }
    return 1;
}

853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875
/* 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) {
876
                int cmd_items = (items > REDIS_AOF_REWRITE_ITEMS_PER_CMD) ?
H
Henry Rawas 已提交
877
                    REDIS_AOF_REWRITE_ITEMS_PER_CMD : (int)items;
878 879 880 881 882 883 884 885 886 887 888 889

                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);
890
            if (++count == REDIS_AOF_REWRITE_ITEMS_PER_CMD) count = 0;
891 892 893 894 895 896 897 898 899 900 901 902
            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) {
903
                int cmd_items = (items > REDIS_AOF_REWRITE_ITEMS_PER_CMD) ?
H
Henry Rawas 已提交
904
                    REDIS_AOF_REWRITE_ITEMS_PER_CMD : (int)items;
905 906 907 908 909 910 911

                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;
912
            if (++count == REDIS_AOF_REWRITE_ITEMS_PER_CMD) count = 0;
913 914 915 916 917 918 919 920 921
            items--;
        }
        dictReleaseIterator(di);
    } else {
        redisPanic("Unknown sorted zset encoding");
    }
    return 1;
}

922
/* Write either the key or the value of the currently selected item of a hash.
923 924 925 926 927
 * The 'hi' argument passes a valid Redis hash iterator.
 * The 'what' filed specifies if to write a key or a value and can be
 * either REDIS_HASH_KEY or REDIS_HASH_VALUE.
 *
 * The function returns 0 on error, non-zero on success. */
928 929 930 931 932 933 934 935
static int rioWriteHashIteratorCursor(rio *r, hashTypeIterator *hi, int what) {
    if (hi->encoding == REDIS_ENCODING_ZIPLIST) {
        unsigned char *vstr = NULL;
        unsigned int vlen = UINT_MAX;
        long long vll = LLONG_MAX;

        hashTypeCurrentFromZiplist(hi, what, &vstr, &vlen, &vll);
        if (vstr) {
H
Henry Rawas 已提交
936
            return (int)rioWriteBulkString(r, (char*)vstr, vlen);
937
        } else {
H
Henry Rawas 已提交
938
            return (int)rioWriteBulkLongLong(r, vll);
939 940 941 942 943 944 945 946 947 948 949 950 951
        }

    } else if (hi->encoding == REDIS_ENCODING_HT) {
        robj *value;

        hashTypeCurrentFromHashTable(hi, what, &value);
        return rioWriteBulkObject(r, value);
    }

    redisPanic("Unknown hash encoding");
    return 0;
}

A
antirez 已提交
952 953 954
/* 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) {
955
    hashTypeIterator *hi;
A
antirez 已提交
956 957
    long long count = 0, items = hashTypeLength(o);

958 959 960
    hi = hashTypeInitIterator(o);
    while (hashTypeNext(hi) != REDIS_ERR) {
        if (count == 0) {
961 962
            int cmd_items = (int)((items > REDIS_AOF_REWRITE_ITEMS_PER_CMD) ?
                REDIS_AOF_REWRITE_ITEMS_PER_CMD : items);
A
antirez 已提交
963

964 965 966
            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;
A
antirez 已提交
967 968
        }

969 970 971 972 973
        if (rioWriteHashIteratorCursor(r, hi, REDIS_HASH_KEY) == 0) return 0;
        if (rioWriteHashIteratorCursor(r, hi, REDIS_HASH_VALUE) == 0) return 0;
        if (++count == REDIS_AOF_REWRITE_ITEMS_PER_CMD) count = 0;
        items--;
    }
A
antirez 已提交
974

975
    hashTypeReleaseIterator(hi);
A
antirez 已提交
976 977 978 979

    return 1;
}

980
/* Write a sequence of commands able to fully rebuild the dataset into
981 982 983 984
 * "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
985
 * and ZADD. However at max REDIS_AOF_REWRITE_ITEMS_PER_CMD items per time
986
 * are inserted using a single command. */
987 988 989
int rewriteAppendOnlyFile(char *filename) {
    dictIterator *di = NULL;
    dictEntry *de;
P
Pieter Noordhuis 已提交
990
    rio aof;
991 992 993
    FILE *fp;
    char tmpfile[256];
    int j;
994
    long long now = mstime();
995 996 997 998

    /* 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());
H
Henry Rawas 已提交
999 1000 1001
#ifdef _WIN32
    fp = fopen(tmpfile,"wb");
#else
1002
    fp = fopen(tmpfile,"w");
H
Henry Rawas 已提交
1003
#endif
1004
    if (!fp) {
A
antirez 已提交
1005
        redisLog(REDIS_WARNING, "Opening the temp file for AOF rewrite in rewriteAppendOnlyFile(): %s", strerror(errno));
1006 1007
        return REDIS_ERR;
    }
P
Pieter Noordhuis 已提交
1008

1009
    rioInitWithFile(&aof,fp);
1010 1011
    if (server.aof_rewrite_incremental_fsync)
        rioSetAutoSync(&aof,REDIS_AOF_AUTOSYNC_BYTES);
1012 1013 1014
    for (j = 0; j < server.dbnum; j++) {
        char selectcmd[] = "*2\r\n$6\r\nSELECT\r\n";
        redisDb *db = server.db+j;
H
Henry Rawas 已提交
1015 1016 1017
        dict *d;

        d = db->dict;
1018
        if (dictSize(d) == 0) continue;
1019
        di = dictGetSafeIterator(d);
1020 1021 1022 1023 1024 1025
        if (!di) {
            fclose(fp);
            return REDIS_ERR;
        }

        /* SELECT the new DB */
P
Pieter Noordhuis 已提交
1026 1027
        if (rioWrite(&aof,selectcmd,sizeof(selectcmd)-1) == 0) goto werr;
        if (rioWriteBulkLongLong(&aof,j) == 0) goto werr;
1028 1029 1030

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

1035 1036
            keystr = dictGetKey(de);
            o = dictGetVal(de);
1037
            initStaticStringObject(key,keystr);
1038

1039 1040
            expiretime = getExpire(db,&key);

1041 1042 1043
            /* If this key is already expired skip it */
            if (expiretime != -1 && expiretime < now) continue;

1044 1045 1046 1047
            /* 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 已提交
1048
                if (rioWrite(&aof,cmd,sizeof(cmd)-1) == 0) goto werr;
1049
                /* Key and value */
P
Pieter Noordhuis 已提交
1050 1051
                if (rioWriteBulkObject(&aof,&key) == 0) goto werr;
                if (rioWriteBulkObject(&aof,o) == 0) goto werr;
1052
            } else if (o->type == REDIS_LIST) {
1053
                if (rewriteListObject(&aof,&key,o) == 0) goto werr;
1054
            } else if (o->type == REDIS_SET) {
1055
                if (rewriteSetObject(&aof,&key,o) == 0) goto werr;
1056
            } else if (o->type == REDIS_ZSET) {
1057
                if (rewriteSortedSetObject(&aof,&key,o) == 0) goto werr;
1058
            } else if (o->type == REDIS_HASH) {
A
antirez 已提交
1059
                if (rewriteHashObject(&aof,&key,o) == 0) goto werr;
1060 1061 1062 1063 1064
            } else {
                redisPanic("Unknown object type");
            }
            /* Save the expire time */
            if (expiretime != -1) {
1065
                char cmd[]="*3\r\n$9\r\nPEXPIREAT\r\n";
P
Pieter Noordhuis 已提交
1066 1067
                if (rioWrite(&aof,cmd,sizeof(cmd)-1) == 0) goto werr;
                if (rioWriteBulkObject(&aof,&key) == 0) goto werr;
1068
                if (rioWriteBulkLongLong(&aof,expiretime) == 0) goto werr;
1069 1070 1071 1072 1073 1074
            }
        }
        dictReleaseIterator(di);
    }

    /* Make sure data will not remain on the OS's output buffers */
1075
    if (fflush(fp) == EOF) goto werr;
1076
    if (fsync(fileno(fp)) == -1) goto werr;
1077
    if (fclose(fp) == EOF) goto werr;
1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101

    /* 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 已提交
1102
 *    2b) the parent accumulates differences in server.aof_rewrite_buf.
1103 1104
 * 3) When the child finished '2a' exists.
 * 4) The parent will trap the exit code, if it's OK, will append the
A
antirez 已提交
1105
 *    data accumulated into server.aof_rewrite_buf into the temp file, and
1106 1107 1108
 *    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!
 */
H
Henry Rawas 已提交
1109 1110
#ifdef _WIN32
int rewriteAppendOnlyFileBackground(void) {
1111
    long long start;
H
Henry Rawas 已提交
1112 1113 1114
    char tmpfile[256];

    if (server.aof_child_pid != -1) return REDIS_ERR;
1115
    start = ustime();
H
Henry Rawas 已提交
1116

1117
    snprintf(tmpfile,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
1118
    if (BeginForkOperation(otAOF, tmpfile, &server, sizeof(server), &server.aof_child_pid, dictGetHashFunctionSeed()) == FALSE) {
H
Henry Rawas 已提交
1119
            redisLog(REDIS_WARNING,
1120
                "Can't rewrite append only file in background: fork: %s",
H
Henry Rawas 已提交
1121 1122 1123
                strerror(errno));
            return REDIS_ERR;
    }
1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135
    server.stat_fork_time = ustime()-start;

    redisLog(REDIS_NOTICE,
        "Background append only file rewriting started by pid %d",server.aof_child_pid);
    server.aof_rewrite_scheduled = 0;
    server.aof_rewrite_time_start = time(NULL);
    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.aof_rewrite_buf will start
        * with a SELECT statement and it will be safe to merge. */
    server.aof_selected_db = -1;
1136
    return REDIS_OK;
H
Henry Rawas 已提交
1137 1138
}
#else
1139 1140
int rewriteAppendOnlyFileBackground(void) {
    pid_t childpid;
1141
    long long start;
1142

A
antirez 已提交
1143
    if (server.aof_child_pid != -1) return REDIS_ERR;
1144
    start = ustime();
1145 1146 1147
    if ((childpid = fork()) == 0) {
        char tmpfile[256];

1148
        /* Child */
1149
        closeListeningSockets(0);
1150
        redisSetProcTitle("redis-aof-rewrite");
1151 1152
        snprintf(tmpfile,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
        if (rewriteAppendOnlyFile(tmpfile) == REDIS_OK) {
1153 1154 1155 1156
            size_t private_dirty = zmalloc_get_private_dirty();

            if (private_dirty) {
                redisLog(REDIS_NOTICE,
1157
                    "AOF rewrite: %lu MB of memory used by copy-on-write",
1158 1159
                    private_dirty/(1024*1024));
            }
1160
            exitFromChild(0);
1161
        } else {
1162
            exitFromChild(1);
1163 1164 1165
        }
    } else {
        /* Parent */
1166
        server.stat_fork_time = ustime()-start;
1167
        server.stat_fork_rate = (double) zmalloc_used_memory() * 1000000 / server.stat_fork_time / (1024*1024*1024); /* GB per second. */
1168
        latencyAddSampleIfNeeded("fork",server.stat_fork_time/1000);
1169 1170 1171 1172 1173 1174 1175 1176
        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);
1177
        server.aof_rewrite_scheduled = 0;
1178
        server.aof_rewrite_time_start = time(NULL);
A
antirez 已提交
1179
        server.aof_child_pid = childpid;
1180 1181 1182
        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 已提交
1183
         * accumulated by the parent into server.aof_rewrite_buf will start
1184
         * with a SELECT statement and it will be safe to merge. */
A
antirez 已提交
1185
        server.aof_selected_db = -1;
1186
        replicationScriptCacheFlush();
1187 1188 1189 1190
        return REDIS_OK;
    }
    return REDIS_OK; /* unreached */
}
H
Henry Rawas 已提交
1191
#endif
1192 1193

void bgrewriteaofCommand(redisClient *c) {
A
antirez 已提交
1194
    if (server.aof_child_pid != -1) {
1195
        addReplyError(c,"Background append only file rewriting already in progress");
A
antirez 已提交
1196
    } else if (server.rdb_child_pid != -1) {
1197
        server.aof_rewrite_scheduled = 1;
1198
        addReplyStatus(c,"Background append only file rewriting scheduled");
1199
    } else if (rewriteAppendOnlyFileBackground() == REDIS_OK) {
1200
        addReplyStatus(c,"Background append only file rewriting started");
1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212
    } 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);
}

A
antirez 已提交
1213
/* Update the server.aof_current_size field explicitly using stat(2)
1214 1215
 * 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
A
antirez 已提交
1216
 * to the current length, that is much faster. */
1217 1218
void aofUpdateCurrentSize(void) {
    struct redis_stat sb;
1219
    mstime_t latency;
1220

H
Henry Rawas 已提交
1221 1222 1223 1224 1225 1226
#ifdef _WIN32
    if (server.aof_fd == -1) {
        redisLog(REDIS_NOTICE,"Unable to check the AOF length: %s", "appendfd is -1");
        return;
    }
#endif
1227

1228
    latencyStartMonitor(latency);
A
antirez 已提交
1229
    if (redis_fstat(server.aof_fd,&sb) == -1) {
A
antirez 已提交
1230
        redisLog(REDIS_WARNING,"Unable to obtain the AOF file length. stat: %s",
1231 1232
            strerror(errno));
    } else {
1233
        server.aof_current_size = sb.st_size;
1234
    }
1235 1236
    latencyEndMonitor(latency);
    latencyAddSampleIfNeeded("aof-fstat",latency);
1237 1238
}

1239 1240
/* A background append only file rewriting (BGREWRITEAOF) terminated its work.
 * Handle this. */
1241
void backgroundRewriteDoneHandler(int exitcode, int bysignal) {
1242 1243 1244 1245
#ifdef _WIN32
    char tmpfile_old[256];
#endif

1246
    if (!bysignal && exitcode == 0) {
1247
        int newfd, oldfd;
1248
        char tmpfile[256];
1249
        long long now = ustime();
1250
        mstime_t latency;
1251 1252

        redisLog(REDIS_NOTICE,
1253 1254
            "Background AOF rewrite terminated with success");

1255 1256
        /* Flush the differences accumulated by the parent to the
         * rewritten AOF. */
1257
        latencyStartMonitor(latency);
H
Henry Rawas 已提交
1258
#ifdef _WIN32
1259 1260
        snprintf(tmpfile,256,"temp-rewriteaof-bg-%d.aof",
            getpid());
H
Henry Rawas 已提交
1261 1262
        newfd = open(tmpfile,O_WRONLY|O_APPEND|O_CREAT|_O_BINARY,_S_IREAD|_S_IWRITE);
#else
1263
        snprintf(tmpfile,256,"temp-rewriteaof-bg-%d.aof",
A
antirez 已提交
1264
            (int)server.aof_child_pid);
1265
        newfd = open(tmpfile,O_WRONLY|O_APPEND);
H
Henry Rawas 已提交
1266
#endif
1267 1268 1269
        if (newfd == -1) {
            redisLog(REDIS_WARNING,
                "Unable to open the temporary AOF produced by the child: %s", strerror(errno));
1270 1271
            goto cleanup;
        }
1272

1273 1274 1275
        if (aofRewriteBufferWrite(newfd) == -1) {
            redisLog(REDIS_WARNING,
                "Error trying to flush the parent diff to the rewritten AOF: %s", strerror(errno));
1276
            close(newfd);
1277 1278
            goto cleanup;
        }
1279 1280
        latencyEndMonitor(latency);
        latencyAddSampleIfNeeded("aof-rewrite-diff-write",latency);
1281 1282

        redisLog(REDIS_NOTICE,
1283
            "Parent diff successfully flushed to the rewritten AOF (%lu bytes)", aofRewriteBufferSize());
1284 1285 1286

        /* 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
1287 1288 1289 1290
         * writes. We don't want close(2) or rename(2) calls to block the
         * server on old file deletion.
         *
         * There are two possible scenarios:
1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304
         *
         * 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
1305
         * use a background thread to take care of this. First, we
1306 1307 1308 1309 1310 1311
         * 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. */
H
Henry Rawas 已提交
1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326
#ifdef _WIN32
        oldfd = -1; /* We'll set this to the current AOF filedes later. */

        /* Close files before renaming */
        close(newfd);
        if (server.aof_fd != -1) close(server.aof_fd);
        /* now rename the existing file to allow new file to be renamed */
        snprintf(tmpfile_old,256,"temp-rewriteaof-old-%d.aof",
            (int)server.aof_child_pid);
        if (server.aof_fd != -1) {
            if (rename(server.aof_filename, tmpfile_old) == -1) {
                redisLog(REDIS_WARNING,
                    "Error trying to rename the existing AOF to old tempfile: %s", strerror(errno));
            }
        }
1327
        latencyStartMonitor(latency);
H
Henry Rawas 已提交
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340
        if (rename(tmpfile,server.aof_filename) == -1) {
            redisLog(REDIS_WARNING,
                "Error trying to rename the temporary AOF: %s", strerror(errno));
            if (server.aof_fd != -1) {
                if (rename(tmpfile_old, server.aof_filename) == -1) {
                    redisLog(REDIS_WARNING,
                        "Error trying to rename the existing AOF from old tempfile: %s", strerror(errno));
                }
            }
            if (oldfd != -1) close(oldfd);
            goto cleanup;
        }
        /* now open the files again with new names */
1341
        newfd = open(server.aof_filename, O_WRONLY|O_APPEND|_O_BINARY,0);
H
Henry Rawas 已提交
1342 1343 1344 1345 1346 1347 1348 1349 1350
        if (newfd == -1) {
            /* Windows fix: More info */
            redisLog(REDIS_WARNING, "Not able to reopen the temporary AOF file after rename");
            goto cleanup;
        }
        if (server.aof_fd != -1) {
            server.aof_fd = open(tmpfile_old, O_WRONLY|O_APPEND|O_CREAT|_O_BINARY,0644);
        }
#else
A
antirez 已提交
1351
        if (server.aof_fd == -1) {
1352 1353
            /* AOF disabled */

1354 1355 1356
             /* 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. */
1357
             oldfd = open(server.aof_filename,O_RDONLY|O_NONBLOCK);
1358 1359
        } else {
            /* AOF enabled */
1360
            oldfd = -1; /* We'll set this to the current AOF filedes later. */
1361 1362 1363 1364
        }

        /* Rename the temporary file. This will not unlink the target file if
         * it exists, because we reference it with "oldfd". */
1365
        latencyStartMonitor(latency);
1366
        if (rename(tmpfile,server.aof_filename) == -1) {
1367
            redisLog(REDIS_WARNING,
A
antirez 已提交
1368
                "Error trying to rename the temporary AOF file: %s", strerror(errno));
1369
            close(newfd);
1370
            if (oldfd != -1) close(oldfd);
1371 1372
            goto cleanup;
        }
H
Henry Rawas 已提交
1373
#endif
1374 1375
        latencyEndMonitor(latency);
        latencyAddSampleIfNeeded("aof-rename",latency);
1376

A
antirez 已提交
1377
        if (server.aof_fd == -1) {
1378 1379
            /* AOF disabled, we don't need to set the AOF file descriptor
             * to this new file, so we can close it. */
1380 1381
            close(newfd);
        } else {
1382
            /* AOF enabled, replace the old fd with the new one. */
A
antirez 已提交
1383 1384
            oldfd = server.aof_fd;
            server.aof_fd = newfd;
1385
            if (server.aof_fsync == AOF_FSYNC_ALWAYS)
1386
                aof_fsync(newfd);
1387
            else if (server.aof_fsync == AOF_FSYNC_EVERYSEC)
1388
                aof_background_fsync(newfd);
A
antirez 已提交
1389
            server.aof_selected_db = -1; /* Make sure SELECT is re-issued */
1390
            aofUpdateCurrentSize();
1391
            server.aof_rewrite_base_size = server.aof_current_size;
1392 1393 1394

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

1399 1400
        server.aof_lastbgrewrite_status = REDIS_OK;

A
antirez 已提交
1401
        redisLog(REDIS_NOTICE, "Background AOF rewrite finished successfully");
1402 1403 1404
        /* Change state from WAIT_REWRITE to ON if needed */
        if (server.aof_state == REDIS_AOF_WAIT_REWRITE)
            server.aof_state = REDIS_AOF_ON;
1405 1406

        /* Asynchronously close the overwritten AOF. */
1407
        if (oldfd != -1) bioCreateBackgroundJob(REDIS_BIO_CLOSE_FILE,(void*)(long)oldfd,NULL,NULL);
1408 1409 1410

        redisLog(REDIS_VERBOSE,
            "Background AOF rewrite signal handler took %lldus", ustime()-now);
1411
    } else if (!bysignal && exitcode != 0) {
1412 1413
        server.aof_lastbgrewrite_status = REDIS_ERR;

1414 1415
        redisLog(REDIS_WARNING,
            "Background AOF rewrite terminated with error");
1416
    } else {
1417 1418
        server.aof_lastbgrewrite_status = REDIS_ERR;

1419
        redisLog(REDIS_WARNING,
1420
            "Background AOF rewrite terminated by signal %d", bysignal);
1421
    }
1422

1423
cleanup:
1424
    aofRewriteBufferReset();
A
antirez 已提交
1425
    aofRemoveTempFile(server.aof_child_pid);
1426 1427 1428
#ifdef _WIN32
    unlink(tmpfile_old);
#endif
A
antirez 已提交
1429
    server.aof_child_pid = -1;
1430 1431
    server.aof_rewrite_time_last = time(NULL)-server.aof_rewrite_time_start;
    server.aof_rewrite_time_start = -1;
1432 1433
    /* Schedule a new rewrite if we are waiting for it to switch the AOF ON. */
    if (server.aof_state == REDIS_AOF_WAIT_REWRITE)
1434
        server.aof_rewrite_scheduled = 1;
1435
}