Files
clang-p2996/libcxx/test/benchmarks/containers/ContainerBenchmarks.h
Peng Liu 0298e58c7d [libc++] Optimize input_iterator-pair insert for std::vector (#113768)
As a follow-up to #113852, this PR optimizes the performance of the
`insert(const_iterator pos, InputIt first, InputIt last)` function for
`input_iterator`-pair inputs in `std::vector` for cases where
reallocation occurs during insertion. Additionally, this optimization
enhances exception safety by replacing the traditional `try-catch`
mechanism with a modern exception guard for the `insert` function.

The optimization targets cases where insertion trigger reallocation. In
scenarios without reallocation, the implementation remains unchanged.

Previous implementation
-----------------------
The previous implementation of `insert` is inefficient in reallocation
scenarios because it performs the following steps separately:
- `reserve()`: This leads to the first round of relocating old
elements to new memory;
- `rotate()`: This leads to the second round of reorganizing the
existing elements;
- Move-forward: Moves the elements after the insertion position to
their final positions.
- Insert: performs the actual insertion.

This approach results in a lot of redundant operations, requiring the
elements to undergo three rounds of relocations/reorganizations to be
placed in their final positions.

Proposed implementation
-----------------------
The proposed implementation jointly optimize the above 4 steps in the
previous implementation such that each element is placed in its final
position in just one round of relocation. Specifically, this
optimization reduces the total cost from 2 relocations + 1 std::rotate
call to just 1 relocation, without needing to call `std::rotate`,
thereby significantly improving overall performance.
2025-01-14 11:40:29 -05:00

333 lines
9.7 KiB
C++

// -*- C++ -*-
//===----------------------------------------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#ifndef BENCHMARK_CONTAINER_BENCHMARKS_H
#define BENCHMARK_CONTAINER_BENCHMARKS_H
#include <cassert>
#include <iterator>
#include <utility>
#include "benchmark/benchmark.h"
#include "../Utilities.h"
#include "test_iterators.h"
namespace ContainerBenchmarks {
template <class Container>
void BM_ConstructSize(benchmark::State& st, Container) {
auto size = st.range(0);
for (auto _ : st) {
Container c(size);
DoNotOptimizeData(c);
}
}
template <class Container>
void BM_CopyConstruct(benchmark::State& st, Container) {
auto size = st.range(0);
Container c(size);
for (auto _ : st) {
auto v = c;
DoNotOptimizeData(v);
}
}
template <class Container>
void BM_Assignment(benchmark::State& st, Container) {
auto size = st.range(0);
Container c1;
Container c2(size);
for (auto _ : st) {
c1 = c2;
DoNotOptimizeData(c1);
DoNotOptimizeData(c2);
}
}
template <std::size_t... sz, typename Container, typename GenInputs>
void BM_AssignInputIterIter(benchmark::State& st, Container c, GenInputs gen) {
auto v = gen(1, sz...);
c.resize(st.range(0), v[0]);
auto in = gen(st.range(1), sz...);
benchmark::DoNotOptimize(&in);
benchmark::DoNotOptimize(&c);
for (auto _ : st) {
c.assign(cpp17_input_iterator(in.begin()), cpp17_input_iterator(in.end()));
benchmark::ClobberMemory();
}
}
template <class Container>
void BM_ConstructSizeValue(benchmark::State& st, Container, typename Container::value_type const& val) {
const auto size = st.range(0);
for (auto _ : st) {
Container c(size, val);
DoNotOptimizeData(c);
}
}
template <class Container, class GenInputs>
void BM_ConstructIterIter(benchmark::State& st, Container, GenInputs gen) {
auto in = gen(st.range(0));
const auto begin = in.begin();
const auto end = in.end();
benchmark::DoNotOptimize(&in);
while (st.KeepRunning()) {
Container c(begin, end);
DoNotOptimizeData(c);
}
}
template <class Container, class GenInputs>
void BM_ConstructFromRange(benchmark::State& st, Container, GenInputs gen) {
auto in = gen(st.range(0));
benchmark::DoNotOptimize(&in);
while (st.KeepRunning()) {
Container c(std::from_range, in);
DoNotOptimizeData(c);
}
}
template <class Container>
void BM_Pushback_no_grow(benchmark::State& state, Container c) {
int count = state.range(0);
c.reserve(count);
while (state.KeepRunningBatch(count)) {
c.clear();
for (int i = 0; i != count; ++i) {
c.push_back(i);
}
benchmark::DoNotOptimize(c.data());
}
}
template <class Container, class GenInputs>
void BM_InsertValue(benchmark::State& st, Container c, GenInputs gen) {
auto in = gen(st.range(0));
const auto end = in.end();
while (st.KeepRunning()) {
c.clear();
for (auto it = in.begin(); it != end; ++it) {
benchmark::DoNotOptimize(&(*c.insert(*it).first));
}
benchmark::ClobberMemory();
}
}
template <class Container, class GenInputs>
void BM_InsertValueRehash(benchmark::State& st, Container c, GenInputs gen) {
auto in = gen(st.range(0));
const auto end = in.end();
while (st.KeepRunning()) {
c.clear();
c.rehash(16);
for (auto it = in.begin(); it != end; ++it) {
benchmark::DoNotOptimize(&(*c.insert(*it).first));
}
benchmark::ClobberMemory();
}
}
template <class Container, class GenInputs>
void BM_Insert_InputIterIter_NoRealloc(benchmark::State& st, Container c, GenInputs gen) {
auto in = gen(st.range(0));
DoNotOptimizeData(in);
const auto size = c.size();
const auto beg = cpp17_input_iterator(in.begin());
const auto end = cpp17_input_iterator(in.end());
c.reserve(size + in.size()); // force no reallocation
for (auto _ : st) {
benchmark::DoNotOptimize(&(*c.insert(c.begin(), beg, end)));
st.PauseTiming();
c.erase(c.begin() + size, c.end()); // avoid the container to grow indefinitely
st.ResumeTiming();
DoNotOptimizeData(c);
benchmark::ClobberMemory();
}
}
template <class Container, class GenInputs>
void BM_Insert_InputIterIter_Realloc_HalfFilled(benchmark::State& st, Container, GenInputs gen) {
const auto size = st.range(0);
Container a = gen(size);
Container in = gen(size + 10);
DoNotOptimizeData(a);
DoNotOptimizeData(in);
const auto beg = cpp17_input_iterator(in.begin());
const auto end = cpp17_input_iterator(in.end());
for (auto _ : st) {
st.PauseTiming();
Container c;
c.reserve(size * 2); // Reallocation with half-filled container
c = a;
st.ResumeTiming();
benchmark::DoNotOptimize(&(*c.insert(c.begin(), beg, end)));
DoNotOptimizeData(c);
benchmark::ClobberMemory();
}
}
template <class Container, class GenInputs>
void BM_Insert_InputIterIter_Realloc_NearFull(benchmark::State& st, Container, GenInputs gen) {
const auto size = st.range(0);
Container a = gen(size);
Container in = gen(10);
DoNotOptimizeData(a);
DoNotOptimizeData(in);
const auto beg = cpp17_input_iterator(in.begin());
const auto end = cpp17_input_iterator(in.end());
for (auto _ : st) {
st.PauseTiming();
Container c;
c.reserve(size + 5); // Reallocation almost-full container
c = a;
st.ResumeTiming();
benchmark::DoNotOptimize(&(*c.insert(c.begin(), beg, end)));
DoNotOptimizeData(c);
benchmark::ClobberMemory();
}
}
template <class Container, class GenInputs>
void BM_InsertDuplicate(benchmark::State& st, Container c, GenInputs gen) {
auto in = gen(st.range(0));
const auto end = in.end();
c.insert(in.begin(), in.end());
benchmark::DoNotOptimize(&c);
benchmark::DoNotOptimize(&in);
while (st.KeepRunning()) {
for (auto it = in.begin(); it != end; ++it) {
benchmark::DoNotOptimize(&(*c.insert(*it).first));
}
benchmark::ClobberMemory();
}
}
template <class Container, class GenInputs>
void BM_EmplaceDuplicate(benchmark::State& st, Container c, GenInputs gen) {
auto in = gen(st.range(0));
const auto end = in.end();
c.insert(in.begin(), in.end());
benchmark::DoNotOptimize(&c);
benchmark::DoNotOptimize(&in);
while (st.KeepRunning()) {
for (auto it = in.begin(); it != end; ++it) {
benchmark::DoNotOptimize(&(*c.emplace(*it).first));
}
benchmark::ClobberMemory();
}
}
template <class Container, class GenInputs>
void BM_erase_iter_in_middle(benchmark::State& st, Container, GenInputs gen) {
auto in = gen(st.range(0));
Container c(in.begin(), in.end());
assert(c.size() > 2);
for (auto _ : st) {
auto mid = std::next(c.begin(), c.size() / 2);
auto tmp = *mid;
auto result = c.erase(mid); // erase an element in the middle
benchmark::DoNotOptimize(result);
c.push_back(std::move(tmp)); // and then push it back at the end to avoid needing a new container
}
}
template <class Container, class GenInputs>
void BM_erase_iter_at_start(benchmark::State& st, Container, GenInputs gen) {
auto in = gen(st.range(0));
Container c(in.begin(), in.end());
assert(c.size() > 2);
for (auto _ : st) {
auto it = c.begin();
auto tmp = *it;
auto result = c.erase(it); // erase the first element
benchmark::DoNotOptimize(result);
c.push_back(std::move(tmp)); // and then push it back at the end to avoid needing a new container
}
}
template <class Container, class GenInputs>
void BM_Find(benchmark::State& st, Container c, GenInputs gen) {
auto in = gen(st.range(0));
c.insert(in.begin(), in.end());
benchmark::DoNotOptimize(&(*c.begin()));
const auto end = in.data() + in.size();
while (st.KeepRunning()) {
for (auto it = in.data(); it != end; ++it) {
benchmark::DoNotOptimize(&(*c.find(*it)));
}
benchmark::ClobberMemory();
}
}
template <class Container, class GenInputs>
void BM_FindRehash(benchmark::State& st, Container c, GenInputs gen) {
c.rehash(8);
auto in = gen(st.range(0));
c.insert(in.begin(), in.end());
benchmark::DoNotOptimize(&(*c.begin()));
const auto end = in.data() + in.size();
while (st.KeepRunning()) {
for (auto it = in.data(); it != end; ++it) {
benchmark::DoNotOptimize(&(*c.find(*it)));
}
benchmark::ClobberMemory();
}
}
template <class Container, class GenInputs>
void BM_Rehash(benchmark::State& st, Container c, GenInputs gen) {
auto in = gen(st.range(0));
c.max_load_factor(3.0);
c.insert(in.begin(), in.end());
benchmark::DoNotOptimize(c);
const auto bucket_count = c.bucket_count();
while (st.KeepRunning()) {
c.rehash(bucket_count + 1);
c.rehash(bucket_count);
benchmark::ClobberMemory();
}
}
template <class Container, class GenInputs>
void BM_Compare_same_container(benchmark::State& st, Container, GenInputs gen) {
auto in = gen(st.range(0));
Container c1(in.begin(), in.end());
Container c2 = c1;
benchmark::DoNotOptimize(&(*c1.begin()));
benchmark::DoNotOptimize(&(*c2.begin()));
while (st.KeepRunning()) {
bool res = c1 == c2;
benchmark::DoNotOptimize(&res);
benchmark::ClobberMemory();
}
}
template <class Container, class GenInputs>
void BM_Compare_different_containers(benchmark::State& st, Container, GenInputs gen) {
auto in1 = gen(st.range(0));
auto in2 = gen(st.range(0));
Container c1(in1.begin(), in1.end());
Container c2(in2.begin(), in2.end());
benchmark::DoNotOptimize(&(*c1.begin()));
benchmark::DoNotOptimize(&(*c2.begin()));
while (st.KeepRunning()) {
bool res = c1 == c2;
benchmark::DoNotOptimize(&res);
benchmark::ClobberMemory();
}
}
} // namespace ContainerBenchmarks
#endif // BENCHMARK_CONTAINER_BENCHMARKS_H