summaryrefslogtreecommitdiff
path: root/src/mongo/db/query/ce/benchmark_utils.cpp
blob: 7a42bb637e157cca9e54ac16cce3a151aec23329 (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
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
/**
 *    Copyright (C) 2022-present MongoDB, Inc.
 *
 *    This program is free software: you can redistribute it and/or modify
 *    it under the terms of the Server Side Public License, version 1,
 *    as published by MongoDB, Inc.
 *
 *    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
 *    Server Side Public License for more details.
 *
 *    You should have received a copy of the Server Side Public License
 *    along with this program. If not, see
 *    <http://www.mongodb.com/licensing/server-side-public-license>.
 *
 *    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 Server Side 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.
 */

#include "mongo/db/query/ce/benchmark_utils.h"

namespace mongo::optimizer::ce {
BSONObj BenchmarkResults::toBSON() const {
    BSONObjBuilder bob;
    bob.append("benchmarkName", _descriptor.benchmarkName)
        .appendNumber("iterations", static_cast<long long>(_descriptor.numIterations))
        .appendNumber("buckets", static_cast<long long>(_descriptor.numBuckets));

    BSONArrayBuilder valueTypesBab(bob.subarrayStart("fields"));
    for (auto&& [fieldName, valueType] : _descriptor.valueTypes) {
        auto fieldPathParameters = _runtimeParameters.getFieldPathParameters(fieldName);
        valueTypesBab.append(
            BSON(fieldName << BSON("valueType" << toStringData(valueType) << "histogramSize"
                                               << fieldPathParameters.histogramSize)));
    }
    valueTypesBab.doneFast();

    BSONArrayBuilder indexesBab(bob.subarrayStart("indexes"));
    for (auto&& [indexName, indexDef] : _descriptor.indexes) {
        indexesBab.append(BSON(indexName << BSON("isMultiKey" << indexDef.isMultiKey())));
    }
    indexesBab.doneFast();

    bob.appendNumber("predicates", static_cast<long long>(_descriptor.numPredicates))
        .append("timeUnits", "microseconds");

    BSONObjBuilder resultsBob(bob.subobjStart("results"));
    for (auto&& [estimationType, timeMetrics] : _results) {
        BSONObjBuilder estimationTypeBob(resultsBob.subobjStart(estimationType));
        for (auto&& [metricName, times] : timeMetrics) {
            BSONObjBuilder metricBob(estimationTypeBob.subobjStart(metricName));

            auto [total, min, max, avg, calls] = aggregateTimeMetrics(times);

            metricBob.append("totalTime", total)
                .appendNumber("minTime", min)
                .appendNumber("maxTime", max)
                .appendNumber("avgTime", avg)
                .appendNumber("calls", calls);

            metricBob.doneFast();
        }
        estimationTypeBob.doneFast();
    }
    resultsBob.doneFast();

    return bob.obj();
}

std::string BenchmarkResults::toString() const {
    const std::string valueTypes = std::accumulate(
        _descriptor.valueTypes.begin(),
        _descriptor.valueTypes.end(),
        std::string{},
        [](std::string str, const std::pair<std::string, BucketValueType>& type) {
            return std::move(str) + "_" + type.first + "_" + toStringData(type.second);
        });
    const std::string prefix = str::stream()
        << _descriptor.benchmarkName << "_iterations_" << _descriptor.numIterations << "_buckets_"
        << _descriptor.numBuckets << "_types" << valueTypes << "_predicates_"
        << _descriptor.numPredicates;
    std::ostringstream ss;

    for (auto&& [estimationType, timeMetrics] : _results) {
        for (auto&& [metricName, times] : timeMetrics) {
            auto [total, min, max, avg, calls] = aggregateTimeMetrics(times);

            ss << prefix << "_" << estimationType << "_" << metricName << ": totalTime=" << total
               << "µs, minTime=" << min << "µs, maxTime=" << max << "µs, avgTime=" << avg
               << "µs, calls=" << calls << std::endl;
        }
    }

    return ss.str();
}

std::tuple<BenchmarkResults::DurationType,
           BenchmarkResults::DurationType,
           BenchmarkResults::DurationType,
           BenchmarkResults::DurationType,
           long long>
BenchmarkResults::aggregateTimeMetrics(std::vector<Nanoseconds> times) const {
    auto total =
        durationCount<Microseconds>(std::accumulate(times.begin(), times.end(), Nanoseconds(0)));
    auto min = durationCount<Microseconds>(*std::min_element(times.begin(), times.end()));
    auto max = durationCount<Microseconds>(*std::max_element(times.begin(), times.end()));
    auto avg = times.empty() ? 0.0 : static_cast<double>(total) / times.size();

    return {total, min, max, avg, times.size()};
}

void Benchmark::runBenchmark(const std::string& pipeline, size_t numIterations) {
    Metadata metadata = {{{getCollName(), createScanDef({}, {})}}};
    PrefixId prefixId = PrefixId::createForTests();
    ABT abt =
        translatePipeline(metadata, pipeline, prefixId.getNextId("scan"), getCollName(), prefixId);
    for (size_t iter = 0; iter < numIterations; ++iter) {
        ABT copy = abt;
        ASSERT_GTE(getCE(copy), 0);
    }
}

CEType CardinalityEstimatorWrapper::deriveCE(const Metadata& metadata,
                                             const cascades::Memo& memo,
                                             const properties::LogicalProps& logicalProps,
                                             ABT::reference_type logicalNodeRef) const {
    Nanoseconds elapsed(0);
    CEType ce = [&]() {
        auto timer = _benchmark->getTimer(&elapsed);
        return _estimator->deriveCE(metadata, memo, logicalProps, logicalNodeRef);
    }();

    // Accumulate total 'deriveCE' time per query.
    _elapsedTimePerQuery += elapsed;

    // Collect 'deriveCE' per ABT node. We currently do not distinguish between different
    // instances of the same ABT type.
    _benchmark->collectElapsedTime("deriveCE_" + abtNodeName(logicalNodeRef), elapsed);
    return ce;
}

void FullOptimizerBenchmark::optimize(OptPhaseManager& phaseManager, ABT& abt) const {
    Nanoseconds elapsed(0);
    {
        auto timer = getTimer(&elapsed);
        Benchmark::optimize(phaseManager, abt);
    }
    collectElapsedTime("optimize", elapsed);
}

}  // namespace mongo::optimizer::ce