summaryrefslogtreecommitdiff
path: root/src/mongo/db/storage/mmap_v1/dur_journal.h
blob: 07def586090a1ba75caa2d8e51ebc34d7d90acda (plain)
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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
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
80
81
82
83
84
85
86
87
88
89
// @file dur_journal.h

/**
*    Copyright (C) 2010 10gen Inc.
*
*    This program is free software: you can redistribute it and/or  modify
*    it under the terms of the GNU Affero General Public License, version 3,
*    as published by the Free Software Foundation.
*
*    This program is distributed in the hope that it will be useful,
*    but WITHOUT ANY WARRANTY; without even the implied warranty of
*    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*    GNU Affero General Public License for more details.
*
*    You should have received a copy of the GNU Affero General Public License
*    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*
*    As a special exception, the copyright holders give permission to link the
*    code of portions of this program with the OpenSSL library under certain
*    conditions as described in each individual source file and distribute
*    linked combinations including the program with the OpenSSL library. You
*    must comply with the GNU Affero General Public License in all respects for
*    all of the code used other than as permitted herein. If you modify file(s)
*    with this exception, you may extend this exception to your version of the
*    file(s), but you are not obligated to do so. If you do not wish to do so,
*    delete this exception statement from your version. If you delete this
*    exception statement from all source files in the program, then also delete
*    it in the license file.
*/

#pragma once

namespace mongo {

class AlignedBuilder;
class JSectHeader;

namespace dur {

/** true if ok to cleanup journal files at termination. otherwise, files journal will be retained.
*/
extern bool okToCleanUp;

/** at termination after db files closed & fsynced
    also after recovery
    closes and removes journal files
    @param log report in log that we are cleaning up if we actually do any work
*/
void journalCleanup(bool log = false);

/** assure journal/ dir exists. throws */
void journalMakeDir();

/** check if time to rotate files; assure a file is open.
     done separately from the journal() call as we can do this part
     outside of lock.
    only called by durThread.
 */
void journalRotate();

/** flag that something has gone wrong during writing to the journal
    (not for recovery mode)
*/
void journalingFailure(const char* msg);

/** read lsn from disk from the last run before doing recovery */
unsigned long long journalReadLSN();

unsigned long long getLastDataFileFlushTime();

/** never throws.
    @param anyFiles by default we only look at j._* files. If anyFiles is true, return true
           if there are any files in the journal directory. acquirePathLock() uses this to
           make sure that the journal directory is mounted.
    @return true if there are any journal files in the journal dir.
*/
bool haveJournalFiles(bool anyFiles = false);

/**
 * Writes the specified uncompressed buffer to the journal.
 */
void WRITETOJOURNAL(const JSectHeader& h, const AlignedBuilder& uncompressed);

// in case disk controller buffers writes
const long long ExtraKeepTimeMs = 10000;

const unsigned JournalCommitIntervalDefault = 100;
}
}