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 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
|
// Copyright 2019 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "base/threading/thread_local_storage.h"
#include <stddef.h>
#include <memory>
#include <vector>
#include "base/barrier_closure.h"
#include "base/functional/bind.h"
#include "base/functional/callback.h"
#include "base/functional/callback_helpers.h"
#include "base/memory/raw_ptr.h"
#include "base/synchronization/waitable_event.h"
#include "base/test/bind.h"
#include "base/threading/simple_thread.h"
#include "base/time/time.h"
#include "build/build_config.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "testing/perf/perf_result_reporter.h"
#if BUILDFLAG(IS_WIN)
#include <windows.h>
#include "base/win/windows_types.h"
#elif BUILDFLAG(IS_POSIX) || BUILDFLAG(IS_FUCHSIA)
#include <pthread.h>
#endif
namespace base::internal {
namespace {
constexpr size_t kCount = 5000000;
constexpr char kMetricPrefixThreadLocalStorage[] = "ThreadLocalStorage.";
constexpr char kMetricBaseRead[] = "read";
constexpr char kMetricBaseWrite[] = "write";
constexpr char kMetricBaseReadWrite[] = "read_write";
constexpr char kMetricSuffixThroughput[] = "_throughput";
constexpr char kMetricSuffixOperationTime[] = "_operation_time";
constexpr char kStoryBaseTLS[] = "thread_local_storage";
#if BUILDFLAG(IS_WIN)
constexpr char kStoryBasePlatformFLS[] = "platform_fiber_local_storage";
#endif // BUILDFLAG(IS_WIN)
constexpr char kStoryBasePlatformTLS[] = "platform_thread_local_storage";
constexpr char kStoryBaseCPPTLS[] = "c++_platform_thread_local_storage";
constexpr char kStorySuffixFourThreads[] = "_4_threads";
perf_test::PerfResultReporter SetUpReporter(const std::string& story_name) {
perf_test::PerfResultReporter reporter(kMetricPrefixThreadLocalStorage,
story_name);
reporter.RegisterImportantMetric(
std::string(kMetricBaseRead) + kMetricSuffixThroughput, "runs/s");
reporter.RegisterImportantMetric(
std::string(kMetricBaseRead) + kMetricSuffixOperationTime, "ns");
reporter.RegisterImportantMetric(
std::string(kMetricBaseWrite) + kMetricSuffixThroughput, "runs/s");
reporter.RegisterImportantMetric(
std::string(kMetricBaseWrite) + kMetricSuffixOperationTime, "ns");
reporter.RegisterImportantMetric(
std::string(kMetricBaseReadWrite) + kMetricSuffixThroughput, "runs/s");
reporter.RegisterImportantMetric(
std::string(kMetricBaseReadWrite) + kMetricSuffixOperationTime, "ns");
return reporter;
}
// A thread that waits for the caller to signal an event before proceeding to
// call action.Run().
class TLSThread : public SimpleThread {
public:
// Creates a PostingThread that waits on |start_event| before calling
// action.Run().
TLSThread(WaitableEvent* start_event,
base::OnceClosure action,
base::OnceClosure completion)
: SimpleThread("TLSThread"),
start_event_(start_event),
action_(std::move(action)),
completion_(std::move(completion)) {
Start();
}
TLSThread(const TLSThread&) = delete;
TLSThread& operator=(const TLSThread&) = delete;
void Run() override {
start_event_->Wait();
std::move(action_).Run();
std::move(completion_).Run();
}
private:
const raw_ptr<WaitableEvent> start_event_;
base::OnceClosure action_;
base::OnceClosure completion_;
};
class ThreadLocalStoragePerfTest : public testing::Test {
public:
ThreadLocalStoragePerfTest(const ThreadLocalStoragePerfTest&) = delete;
ThreadLocalStoragePerfTest& operator=(const ThreadLocalStoragePerfTest&) =
delete;
protected:
ThreadLocalStoragePerfTest() = default;
~ThreadLocalStoragePerfTest() override = default;
template <class Read, class Write>
void Benchmark(const std::string& story_name,
Read read,
Write write,
size_t num_operation,
size_t num_threads) {
write(2);
BenchmarkImpl(kMetricBaseRead, story_name, base::BindLambdaForTesting([&] {
volatile intptr_t total = 0;
for (size_t i = 0; i < num_operation; ++i) {
total = total + read();
}
}),
num_operation, num_threads);
BenchmarkImpl(kMetricBaseWrite, story_name, base::BindLambdaForTesting([&] {
for (size_t i = 0; i < num_operation; ++i) {
write(i);
}
}),
num_operation, num_threads);
BenchmarkImpl(kMetricBaseReadWrite, story_name,
base::BindLambdaForTesting([&] {
for (size_t i = 0; i < num_operation; ++i) {
write(read() + 1);
}
}),
num_operation, num_threads);
}
void BenchmarkImpl(const std::string& metric_base,
const std::string& story_name,
base::RepeatingClosure action,
size_t num_operation,
size_t num_threads) {
WaitableEvent start_thread;
WaitableEvent complete_thread;
base::RepeatingClosure done = BarrierClosure(
num_threads,
base::BindLambdaForTesting([&] { complete_thread.Signal(); }));
std::vector<std::unique_ptr<TLSThread>> threads;
for (size_t i = 0; i < num_threads; ++i) {
threads.emplace_back(
std::make_unique<TLSThread>(&start_thread, action, done));
}
TimeTicks operation_start = TimeTicks::Now();
start_thread.Signal();
complete_thread.Wait();
TimeDelta operation_duration = TimeTicks::Now() - operation_start;
for (auto& thread : threads) {
thread->Join();
}
auto reporter = SetUpReporter(story_name);
reporter.AddResult(metric_base + kMetricSuffixThroughput,
num_operation / operation_duration.InSecondsF());
size_t nanos_per_operation =
operation_duration.InNanoseconds() / num_operation;
reporter.AddResult(metric_base + kMetricSuffixOperationTime,
nanos_per_operation);
}
};
} // namespace
TEST_F(ThreadLocalStoragePerfTest, ThreadLocalStorage) {
ThreadLocalStorage::Slot tls;
auto read = [&] { return reinterpret_cast<intptr_t>(tls.Get()); };
auto write = [&](intptr_t value) { tls.Set(reinterpret_cast<void*>(value)); };
Benchmark(kStoryBaseTLS, read, write, 10000000, 1);
Benchmark(std::string(kStoryBaseTLS) + kStorySuffixFourThreads, read, write,
kCount, 4);
}
#if BUILDFLAG(IS_WIN)
void WINAPI destroy(void*) {}
TEST_F(ThreadLocalStoragePerfTest, PlatformFls) {
DWORD key = FlsAlloc(destroy);
ASSERT_NE(PlatformThreadLocalStorage::TLS_KEY_OUT_OF_INDEXES, key);
auto read = [&] { return reinterpret_cast<intptr_t>(FlsGetValue(key)); };
auto write = [&](intptr_t value) {
FlsSetValue(key, reinterpret_cast<void*>(value));
};
Benchmark(kStoryBasePlatformFLS, read, write, 10000000, 1);
Benchmark(std::string(kStoryBasePlatformFLS) + kStorySuffixFourThreads, read,
write, kCount, 4);
}
TEST_F(ThreadLocalStoragePerfTest, PlatformTls) {
DWORD key = TlsAlloc();
ASSERT_NE(PlatformThreadLocalStorage::TLS_KEY_OUT_OF_INDEXES, key);
auto read = [&] { return reinterpret_cast<intptr_t>(TlsGetValue(key)); };
auto write = [&](intptr_t value) {
TlsSetValue(key, reinterpret_cast<void*>(value));
};
Benchmark(kStoryBasePlatformTLS, read, write, 10000000, 1);
Benchmark(std::string(kStoryBasePlatformTLS) + kStorySuffixFourThreads, read,
write, kCount, 4);
}
#elif BUILDFLAG(IS_POSIX) || BUILDFLAG(IS_FUCHSIA)
TEST_F(ThreadLocalStoragePerfTest, PlatformTls) {
pthread_key_t key;
ASSERT_FALSE(pthread_key_create(&key, [](void*) {}));
ASSERT_NE(PlatformThreadLocalStorage::TLS_KEY_OUT_OF_INDEXES, key);
auto read = [&] {
return reinterpret_cast<intptr_t>(pthread_getspecific(key));
};
auto write = [&](intptr_t value) {
pthread_setspecific(key, reinterpret_cast<void*>(value));
};
Benchmark(kStoryBasePlatformTLS, read, write, 10000000, 1);
Benchmark(std::string(kStoryBasePlatformTLS) + kStorySuffixFourThreads, read,
write, kCount, 4);
}
#endif
TEST_F(ThreadLocalStoragePerfTest, Cpp11Tls) {
thread_local intptr_t thread_local_variable;
auto read = [&] { return thread_local_variable; };
auto write = [&](intptr_t value) {
reinterpret_cast<volatile intptr_t*>(&thread_local_variable)[0] = value;
};
Benchmark(kStoryBaseCPPTLS, read, write, 10000000, 1);
Benchmark(std::string(kStoryBaseCPPTLS) + kStorySuffixFourThreads, read,
write, kCount, 4);
}
} // namespace base::internal
|