summaryrefslogtreecommitdiff
path: root/src/mongo/db/storage/mmap_v1/mmap_v1_options.h
blob: f70dea73af7a4669e676629878ae3f3a603645b7 (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
90
91
92
93
94
95
96
/*
 *    Copyright (C) 2014 MongoDB 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

#include <string>

/*
 * This file defines the storage for options that come from the command line related to the
 * mmap v1 storage engine.
 */

namespace mongo {

    struct MMAPV1Options {

        MMAPV1Options() :
            lenForNewNsFiles(16 * 1024 * 1024),
            preallocj(true),
            prealloc(false),
            journalCommitInterval(0), // 0 means use default
            quota(false),
            quotaFiles(8) {}

        // --nssize
        // Specifies the default size for namespace files, which are files that end in .ns.
        // Each collection and index counts as a namespace.
        unsigned lenForNewNsFiles;

        bool preallocj;        // --nopreallocj no preallocation of journal files
        bool prealloc;         // --noprealloc no preallocation of data files
        bool smallfiles;       // --smallfiles allocate smaller data files

        // --journalCommitInterval
        // The maximum amount of time the mongod process allows between journal operations.
        // Values can range from 2 to 300 milliseconds. Lower values increase the durability
        // of the journal, at the expense of disk performance.
        unsigned journalCommitInterval; // group/batch commit interval ms

        // --journalOptions 7            dump journal and terminate without doing anything further
        // --journalOptions 4            recover and terminate without listening
        enum { // bits to be ORed
            JournalDumpJournal = 1,   // dump diagnostics on the journal during recovery
            JournalScanOnly = 2,      // don't do any real work, just scan and dump if dump
                                      // specified
            JournalRecoverOnly = 4,   // terminate after recovery step
            JournalParanoid = 8,      // paranoid mode enables extra checks
            JournalAlwaysCommit = 16, // do a group commit every time the writelock is released
            JournalAlwaysRemap = 32,  // remap the private view after every group commit
                                      // (may lag to the next write lock acquisition,
                                      // but will do all files then)
            JournalNoCheckSpace = 64  // don't check that there is enough room for journal files
                                      // before startup (for diskfull tests)
        };
        int journalOptions;    // --journalOptions <n> for debugging

        // --quota
        // Enables a maximum limit for the number data files each database can have.
        // When running with the --quota option, MongoDB has a maximum of 8 data files
        // per database. Adjust the quota with --quotaFiles.
        bool quota;

        // --quotaFiles
        // Modifies the limit on the number of data files per database.
        // --quotaFiles option requires that you set --quota.
        int quotaFiles;        // --quotaFiles
    };

    extern MMAPV1Options mmapv1GlobalOptions;

} // namespace mongo