path: root/src/mongo/db/pipeline/expression_bm.cpp

/**
 *    Copyright (C) 2020-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/platform/basic.h"

#include <benchmark/benchmark.h>

#include "mongo/db/matcher/expression_parser.h"
#include "mongo/db/pipeline/expression.h"
#include "mongo/db/pipeline/expression_context_for_test.h"
#include "mongo/db/query/query_test_service_context.h"

namespace mongo {
namespace {
void benchmarkExpression(BSONObj expressionSpec,
                         benchmark::State& state,
                         const std::vector<Document>& documents) {
    QueryTestServiceContext testServiceContext;
    auto opContext = testServiceContext.makeOperationContext();
    NamespaceString nss("test.bm");
    auto exprContext = make_intrusive<ExpressionContextForTest>(opContext.get(), nss);

    // Build an expression.
    auto expression = Expression::parseExpression(
        exprContext.get(), expressionSpec, exprContext->variablesParseState);

    expression = expression->optimize();

    // Prepare parameters for the 'evaluate()' call.
    auto variables = &(exprContext->variables);

    // Run the test.
    for (auto keepRunning : state) {
        for (auto document : documents) {
            benchmark::DoNotOptimize(expression->evaluate(document, variables));
        }
        benchmark::ClobberMemory();
    }
}

void benchmarkExpression(BSONObj expressionSpec, benchmark::State& state) {
    std::vector<Document> documents = {{}};
    benchmarkExpression(expressionSpec, state, documents);
}

/**
 * Tests performance of 'evaluate()' of $dateDiff expression.
 *
 * startDate - start date in milliseconds from the UNIX epoch.
 * endDate - end date in milliseconds from the UNIX epoch.
 * unit - a string expression of units to use for date difference calculation.
 * timezone - a string representation of timezone to use for date difference calculation.
 * startOfWeek - a string representation of the first day of the week to use for date difference
 * calculation when unit is a week.
 * state - benchmarking state.
 */
void testDateDiffExpression(long long startDate,
                            long long endDate,
                            std::string unit,
                            boost::optional<std::string> timezone,
                            boost::optional<std::string> startOfWeek,
                            benchmark::State& state) {
    // Build a $dateDiff expression.
    BSONObjBuilder objBuilder;
    objBuilder << "startDate" << Date_t::fromMillisSinceEpoch(startDate) << "endDate"
               << Date_t::fromMillisSinceEpoch(endDate) << "unit" << unit;
    if (timezone) {
        objBuilder << "timezone" << *timezone;
    }
    if (startOfWeek) {
        objBuilder << "startOfWeek" << *startOfWeek;
    }
    benchmarkExpression(BSON("$dateDiff" << objBuilder.obj()), state);
}

void BM_DateDiffEvaluateMinute300Years(benchmark::State& state) {
    testDateDiffExpression(-1640989478000LL /* 1918-01-01*/,
                           7826117722000LL /* 2218-01-01*/,
                           "minute",
                           boost::none /*timezone*/,
                           boost::none /*startOfWeek*/,
                           state);
}

void BM_DateDiffEvaluateMinute2Years(benchmark::State& state) {
    testDateDiffExpression(1542448721000LL /* 2018-11-17*/,
                           1605607121000LL /* 2020-11-17*/,
                           "minute",
                           boost::none /*timezone*/,
                           boost::none /*startOfWeek*/,
                           state);
}

void BM_DateDiffEvaluateMinute2YearsWithTimezone(benchmark::State& state) {
    testDateDiffExpression(1542448721000LL /* 2018-11-17*/,
                           1605607121000LL /* 2020-11-17*/,
                           "minute",
                           std::string{"America/New_York"},
                           boost::none /*startOfWeek*/,
                           state);
}

void BM_DateDiffEvaluateWeek(benchmark::State& state) {
    testDateDiffExpression(7826117722000LL /* 2218-01-01*/,
                           4761280721000LL /*2120-11-17*/,
                           "week",
                           boost::none /*timezone*/,
                           std::string("Sunday") /*startOfWeek*/,
                           state);
}

BENCHMARK(BM_DateDiffEvaluateMinute300Years);
BENCHMARK(BM_DateDiffEvaluateMinute2Years);
BENCHMARK(BM_DateDiffEvaluateMinute2YearsWithTimezone);
BENCHMARK(BM_DateDiffEvaluateWeek);

/**
 * Tests performance of evaluate() method of $dateAdd
 */
void testDateAddExpression(long long startDate,
                           std::string unit,
                           long long amount,
                           boost::optional<std::string> timezone,
                           benchmark::State& state) {
    BSONObjBuilder objBuilder;
    objBuilder << "startDate" << Date_t::fromMillisSinceEpoch(startDate) << "unit" << unit
               << "amount" << amount;
    if (timezone) {
        objBuilder << "timezone" << *timezone;
    }
    benchmarkExpression(BSON("$dateAdd" << objBuilder.obj()), state);
}

void BM_DateAddEvaluate10Days(benchmark::State& state) {
    testDateAddExpression(1604131115000LL,
                          "day",
                          10LL,
                          boost::none, /* timezone */
                          state);
}

void BM_DateAddEvaluate600Minutes(benchmark::State& state) {
    testDateAddExpression(1604131115000LL,
                          "minute",
                          600LL,
                          boost::none, /* timezone */
                          state);
}

void BM_DateAddEvaluate100KSeconds(benchmark::State& state) {
    testDateAddExpression(1604131115000LL,
                          "second",
                          100000LL,
                          boost::none, /* timezone */
                          state);
}

void BM_DateAddEvaluate100Years(benchmark::State& state) {
    testDateAddExpression(1604131115000LL,
                          "year",
                          100LL,
                          boost::none, /* timezone */
                          state);
}

void BM_DateAddEvaluate12HoursWithTimezone(benchmark::State& state) {
    testDateAddExpression(1604131115000LL, "hour", 12LL, std::string{"America/New_York"}, state);
}

BENCHMARK(BM_DateAddEvaluate10Days);
BENCHMARK(BM_DateAddEvaluate600Minutes);
BENCHMARK(BM_DateAddEvaluate100KSeconds);
BENCHMARK(BM_DateAddEvaluate100Years);
BENCHMARK(BM_DateAddEvaluate12HoursWithTimezone);

/**
 * Tests performance of 'evaluate()' of $dateTrunc expression.
 *
 * date - start date in milliseconds from the UNIX epoch.
 * unit - a string expression of units to use for date difference calculation.
 * timezone - a string representation of timezone to use for date difference calculation.
 * startOfWeek - a string representation of the first day of the week to use for date difference
 * calculation when unit is a week.
 * state - benchmarking state.
 */
void testDateTruncExpression(long long date,
                             std::string unit,
                             unsigned long binSize,
                             boost::optional<std::string> timezone,
                             boost::optional<std::string> startOfWeek,
                             benchmark::State& state) {
    // Build a $dateTrunc expression.
    BSONObjBuilder objBuilder;
    objBuilder << "date" << Date_t::fromMillisSinceEpoch(date) << "unit" << unit << "binSize"
               << static_cast<long long>(binSize);
    if (timezone) {
        objBuilder << "timezone" << *timezone;
    }
    if (startOfWeek) {
        objBuilder << "startOfWeek" << *startOfWeek;
    }
    benchmarkExpression(BSON("$dateTrunc" << objBuilder.obj()), state);
}

void BM_DateTruncEvaluateMinute15NewYork(benchmark::State& state) {
    testDateTruncExpression(1615460825000LL /* year 2021*/,
                            "minute",
                            15,
                            std::string{"America/New_York"},
                            boost::none /* startOfWeek */,
                            state);
}

void BM_DateTruncEvaluateMinute15UTC(benchmark::State& state) {
    testDateTruncExpression(1615460825000LL /* year 2021*/,
                            "minute",
                            15,
                            boost::none,
                            boost::none /* startOfWeek */,
                            state);
}

void BM_DateTruncEvaluateHour1UTCMinus0700(benchmark::State& state) {
    testDateTruncExpression(1615460825000LL /* year 2021*/,
                            "hour",
                            1,
                            std::string{"-07:00"},
                            boost::none /* startOfWeek */,
                            state);
}

void BM_DateTruncEvaluateWeek2NewYorkValue2100(benchmark::State& state) {
    testDateTruncExpression(4108446425000LL /* year 2100*/,
                            "week",
                            2,
                            std::string{"America/New_York"},
                            std::string{"monday"} /* startOfWeek */,
                            state);
}

void BM_DateTruncEvaluateWeek2UTCValue2100(benchmark::State& state) {
    testDateTruncExpression(4108446425000LL /* year 2100*/,
                            "week",
                            2,
                            std::string{"UTC"},
                            std::string{"monday"} /* startOfWeek */,
                            state);
}

void BM_DateTruncEvaluateMonth6NewYorkValue2100(benchmark::State& state) {
    testDateTruncExpression(4108446425000LL /* year 2100*/,
                            "month",
                            6,
                            std::string{"America/New_York"},
                            boost::none /* startOfWeek */,
                            state);
}

void BM_DateTruncEvaluateMonth6NewYorkValue2030(benchmark::State& state) {
    testDateTruncExpression(1893466800000LL /* year 2030*/,
                            "month",
                            6,
                            std::string{"America/New_York"},
                            boost::none /* startOfWeek */,
                            state);
}

void BM_DateTruncEvaluateMonth6UTCValue2030(benchmark::State& state) {
    testDateTruncExpression(1893466800000LL /* year 2030*/,
                            "month",
                            8,
                            boost::none,
                            boost::none /* startOfWeek */,
                            state);
}

void BM_DateTruncEvaluateYear1NewYorkValue2020(benchmark::State& state) {
    testDateTruncExpression(1583924825000LL /* year 2020*/,
                            "year",
                            1,
                            std::string{"America/New_York"},
                            boost::none /* startOfWeek */,
                            state);
}

void BM_DateTruncEvaluateYear1UTCValue2020(benchmark::State& state) {
    testDateTruncExpression(1583924825000LL /* year 2020*/,
                            "year",
                            1,
                            boost::none,
                            boost::none /* startOfWeek */,
                            state);
}

void BM_DateTruncEvaluateYear1NewYorkValue2100(benchmark::State& state) {
    testDateTruncExpression(4108446425000LL /* year 2100*/,
                            "year",
                            1,
                            std::string{"America/New_York"},
                            boost::none /* startOfWeek */,
                            state);
}

BENCHMARK(BM_DateTruncEvaluateMinute15NewYork);
BENCHMARK(BM_DateTruncEvaluateMinute15UTC);
BENCHMARK(BM_DateTruncEvaluateHour1UTCMinus0700);
BENCHMARK(BM_DateTruncEvaluateWeek2NewYorkValue2100);
BENCHMARK(BM_DateTruncEvaluateWeek2UTCValue2100);
BENCHMARK(BM_DateTruncEvaluateMonth6NewYorkValue2100);
BENCHMARK(BM_DateTruncEvaluateMonth6NewYorkValue2030);
BENCHMARK(BM_DateTruncEvaluateMonth6UTCValue2030);
BENCHMARK(BM_DateTruncEvaluateYear1NewYorkValue2020);
BENCHMARK(BM_DateTruncEvaluateYear1UTCValue2020);
BENCHMARK(BM_DateTruncEvaluateYear1NewYorkValue2100);

/**
 * Tests performance of 'evaluate()' of $getField expression.
 */
void BM_GetFieldEvaluateExpression(benchmark::State& state) {
    BSONObjBuilder objBuilder;
    objBuilder << "field"
               << "x.y$z"
               << "input"
               << BSON("$const" << BSON("x.y$z"
                                        << "abc"));

    benchmarkExpression(BSON("$getField" << objBuilder.obj()), state);
}

void BM_GetFieldEvaluateShortSyntaxExpression(benchmark::State& state) {
    benchmarkExpression(BSON("$getField" << BSON("$const"
                                                 << "$foo")),
                        state);
}

void BM_GetFieldNestedExpression(benchmark::State& state) {
    BSONObjBuilder innerObjBuilder;
    innerObjBuilder << "field"
                    << "a.b"
                    << "input" << BSON("$const" << BSON("a.b" << BSON("c" << 123)));
    BSONObjBuilder outerObjBuilder;
    outerObjBuilder << "field"
                    << "c"
                    << "input" << BSON("$getField" << innerObjBuilder.obj());
    benchmarkExpression(BSON("$getField" << outerObjBuilder.obj()), state);
}

BENCHMARK(BM_GetFieldEvaluateExpression);
BENCHMARK(BM_GetFieldEvaluateShortSyntaxExpression);
BENCHMARK(BM_GetFieldNestedExpression);

/**
 * Tests performance of 'evaluate()' of $setField and $unsetField expressions.
 */
void testSetFieldExpression(std::string fieldname,
                            std::string oldFieldValue,
                            std::string newFieldValue,
                            benchmark::State& state) {
    BSONObjBuilder objBuilder;
    objBuilder << "field" << fieldname << "input"
               << BSON("$const" << BSON(fieldname << oldFieldValue << "f1" << 1 << "f2" << 2))
               << "value" << newFieldValue;

    benchmarkExpression(BSON("$setField" << objBuilder.obj()), state);
}

void BM_SetFieldEvaluateExpression(benchmark::State& state) {
    testSetFieldExpression("a.b", "x", "y", state);
}

// The following two functions test different syntax for equivalent expressions:
// $unsetField is an alias for $setField with $$REMOVE.
void BM_SetFieldWithRemoveExpression(benchmark::State& state) {
    testSetFieldExpression("a$b", "x", "$$REMOVE", state);
}

void BM_UnsetFieldEvaluateExpression(benchmark::State& state) {
    BSONObjBuilder objBuilder;
    objBuilder << "field"
               << "a$b.c"
               << "input"
               << BSON("$const" << BSON("a$b.c"
                                        << "x"
                                        << "f1" << 1 << "f2" << 2));

    benchmarkExpression(BSON("$unsetField" << objBuilder.obj()), state);
}

BENCHMARK(BM_SetFieldEvaluateExpression);
BENCHMARK(BM_SetFieldWithRemoveExpression);
BENCHMARK(BM_UnsetFieldEvaluateExpression);

BSONArray randomBSONArray(int count, int max, int offset = 0) {
    BSONArrayBuilder builder;
    auto rng = PseudoRandom(std::random_device()());
    for (int i = 0; i < count; i++) {
        builder.append(std::to_string(offset + rng.nextInt32(max)));
    }
    return builder.arr();
}

BSONArray rangeBSONArray(int count) {
    BSONArrayBuilder builder;
    for (int i = 0; i < count; i++) {
        builder.append(std::to_string(i));
    }
    return builder.arr();
}

/**
 * Tests performance of $set* expressions.
 */
void BM_SetIsSubset_allPresent(benchmark::State& state) {
    const int kMax = 100000;
    BSONArray lhs = randomBSONArray(100000, kMax);
    BSONArray rhs = rangeBSONArray(kMax);

    benchmarkExpression(BSON("$setIsSubset" << BSON_ARRAY("$arr" << rhs)),
                        state,
                        std::vector<Document>(100, {{"arr"_sd, lhs}}));
}

void BM_SetIsSubset_nonePresent(benchmark::State& state) {
    const int kMax = 100000;
    BSONArray lhs = randomBSONArray(100000, kMax, kMax);
    BSONArray rhs = rangeBSONArray(kMax);

    benchmarkExpression(BSON("$setIsSubset" << BSON_ARRAY("$arr" << rhs)),
                        state,
                        std::vector<Document>(100, {{"arr"_sd, lhs}}));
}

void BM_SetIntersection(benchmark::State& state) {
    const int kMax = 100000;
    BSONArray lhs = randomBSONArray(100000, kMax);
    BSONArray rhs = randomBSONArray(100000, kMax);

    benchmarkExpression(BSON("$setIntersection" << BSON_ARRAY("$arr" << rhs)),
                        state,
                        std::vector<Document>(100, {{"arr"_sd, lhs}}));
}

void BM_SetDifference(benchmark::State& state) {
    const int kMax = 100000;
    BSONArray lhs = randomBSONArray(100000, kMax);
    BSONArray rhs = randomBSONArray(100000, kMax);

    benchmarkExpression(BSON("$setDifference" << BSON_ARRAY("$arr" << rhs)),
                        state,
                        std::vector<Document>(100, {{"arr"_sd, lhs}}));
}

void BM_SetEquals(benchmark::State& state) {
    const int kMax = 100000;
    BSONArray lhs = randomBSONArray(100000, kMax);
    BSONArray rhs = randomBSONArray(100000, kMax);

    benchmarkExpression(BSON("$setEquals" << BSON_ARRAY("$arr" << rhs)),
                        state,
                        std::vector<Document>(100, {{"arr"_sd, lhs}}));
}

void BM_SetUnion(benchmark::State& state) {
    const int kMax = 100000;
    BSONArray lhs = randomBSONArray(100000, kMax);
    BSONArray rhs = randomBSONArray(100000, kMax);

    benchmarkExpression(BSON("$setUnion" << BSON_ARRAY("$arr" << rhs)),
                        state,
                        std::vector<Document>(100, {{"arr"_sd, lhs}}));
}

BENCHMARK(BM_SetIsSubset_allPresent);
BENCHMARK(BM_SetIsSubset_nonePresent);
BENCHMARK(BM_SetIntersection);
BENCHMARK(BM_SetDifference);
BENCHMARK(BM_SetEquals);
BENCHMARK(BM_SetUnion);

}  // namespace
}  // namespace mongo