Files
carbon-lang/common/BUILD
T
Chandler Carruth 632a81fcb6 Keep benchmark values passed to DoNotOptimize in registers (#7870)
Clang implements the `"+r,m"` constraint in `benchmark::DoNotOptimize`
by always choosing memory, so each call stores the value to the stack
and loads it back. Most of our benchmarks call it on a loop counter or
another value carried to the next iteration, which puts that store and
reload on the loop's critical path.

On an Apple M1, the cost of that round trip depends on which register
the compiler uses to address the stack slot, and unrelated code changes
move it. Changing only that register from `x29` to `sp`, with the same
address, made `BM_SetLookupHitPtr<Set<int>>` 41.5% to 49.1% slower.

Add `Carbon::Testing::DoNotOptimize` in
`//testing/base:benchmark_helpers`, and switch every benchmark to it. It
only accepts types it can keep in registers: integers, enums, and
pointers go into a `"+r"` constraint with a `"memory"` clobber, and
containers pass their `data()` pointer to that form, so the compiler
must assume the call reads and writes their contents. Any other type is
a compile error. The container form doesn't block optimizing based on a
container's size; passing the container's address does.

Benchmarks that pass a loop counter or carried value no longer measure a
store and reload per iteration, so their numbers aren't comparable with
earlier runs. For example, the hashing latency benchmarks no longer
include one in each hash's latency.

Assisted-by: Claude Code
2026-10-02 00:15:21 +00:00

856 lines
19 KiB
Python

# Part of the Carbon Language project, under the Apache License v2.0 with LLVM
# Exceptions. See /LICENSE for license information.
# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
load("@rules_shell//shell:sh_test.bzl", "sh_test")
load("//bazel/cc_rules:defs.bzl", "cc_binary", "cc_library", "cc_test")
load("//bazel/version:rules.bzl", "expand_version_build_info")
package(default_visibility = ["//visibility:public"])
cc_library(
name = "array_stack",
hdrs = ["array_stack.h"],
deps = [
":check",
"@llvm-project//llvm:Support",
],
)
cc_test(
name = "array_stack_test",
size = "small",
srcs = ["array_stack_test.cpp"],
deps = [
":array_stack",
"//testing/base:gtest_main",
"@googletest//:gtest",
],
)
cc_library(
name = "bazel_working_dir",
hdrs = ["bazel_working_dir.h"],
deps = [
":check",
":filesystem",
"@llvm-project//llvm:Support",
],
)
cc_library(
name = "build_data",
srcs = [
"build_data.cpp",
"build_data_linkstamp.h",
],
hdrs = ["build_data.h"],
linkstamp = "build_data_linkstamp.cpp",
deps = ["@llvm-project//llvm:Support"],
)
cc_test(
name = "build_data_test",
size = "small",
srcs = ["build_data_test.cpp"],
deps = [
":build_data",
":ostream",
"//testing/base:gtest_main",
"@googletest//:gtest",
],
)
cc_library(
name = "command_line",
srcs = ["command_line.cpp"],
hdrs = ["command_line.h"],
deps = [
":check",
":error",
":ostream",
":raw_string_ostream",
"@llvm-project//llvm:Support",
],
)
cc_test(
name = "command_line_test",
size = "small",
srcs = ["command_line_test.cpp"],
deps = [
":command_line",
":error_test_helpers",
":raw_string_ostream",
"//testing/base:gtest_main",
"@googletest//:gtest",
"@llvm-project//llvm:Support",
],
)
cc_library(
name = "check",
srcs = [
"check_internal.cpp",
"check_internal.h",
],
hdrs = ["check.h"],
deps = [
":ostream",
":template_string",
"@llvm-project//llvm:Support",
],
)
cc_test(
name = "check_test",
size = "small",
srcs = ["check_test.cpp"],
deps = [
":check",
"//testing/base:gtest_main",
"@googletest//:gtest",
],
)
cc_library(
name = "concepts",
hdrs = ["concepts.h"],
)
cc_library(
name = "emplace_by_calling",
hdrs = ["emplace_by_calling.h"],
)
cc_test(
name = "emplace_by_calling_test",
srcs = ["emplace_by_calling_test.cpp"],
deps = [
":emplace_by_calling",
"//testing/base:gtest_main",
"@googletest//:gtest",
],
)
cc_library(
name = "enum_base",
hdrs = ["enum_base.h"],
deps = [
"//common:ostream",
"@llvm-project//llvm:Support",
],
)
cc_library(
name = "enum_base_test_def",
testonly = 1,
textual_hdrs = ["enum_base_test.def"],
)
cc_test(
name = "enum_base_test",
size = "small",
srcs = ["enum_base_test.cpp"],
deps = [
":enum_base",
":enum_base_test_def",
":raw_string_ostream",
"//testing/base:gtest_main",
"@googletest//:gtest",
],
)
cc_library(
name = "enum_mask_base",
hdrs = ["enum_mask_base.h"],
deps = [
":enum_base",
"@llvm-project//llvm:Support",
],
)
cc_test(
name = "enum_mask_base_test",
size = "small",
srcs = ["enum_mask_base_test.cpp"],
deps = [
":enum_mask_base",
":raw_string_ostream",
"//testing/base:gtest_main",
"@googletest//:gtest",
],
)
cc_library(
name = "error",
hdrs = ["error.h"],
deps = [
":check",
":ostream",
":raw_string_ostream",
"@llvm-project//llvm:Support",
],
)
cc_library(
name = "error_test_helpers",
testonly = 1,
hdrs = ["error_test_helpers.h"],
deps = [
":error",
":ostream",
"@googletest//:gtest",
],
)
cc_test(
name = "error_test",
size = "small",
srcs = ["error_test.cpp"],
deps = [
":error",
":error_test_helpers",
":raw_string_ostream",
"//testing/base:gtest_main",
"@googletest//:gtest",
],
)
cc_library(
name = "exe_path",
srcs = ["exe_path.cpp"],
hdrs = ["exe_path.h"],
deps = [
"@llvm-project//llvm:Support",
],
)
cc_test(
name = "exe_path_test",
size = "small",
srcs = ["exe_path_test.cpp"],
deps = [
":exe_path",
"//testing/base:gtest_main",
"@googletest//:gtest",
"@llvm-project//llvm:Support",
],
)
cc_library(
name = "filesystem",
srcs = ["filesystem.cpp"],
hdrs = ["filesystem.h"],
deps = [
":build_data",
":check",
":error",
":ostream",
":raw_string_ostream",
":template_string",
"@llvm-project//llvm:Support",
],
)
cc_test(
name = "filesystem_test",
size = "small",
srcs = ["filesystem_test.cpp"],
deps = [
":error_test_helpers",
":filesystem",
"//testing/base:gtest_main",
"@googletest//:gtest",
"@llvm-project//llvm:Support",
],
)
cc_binary(
name = "filesystem_benchmark",
testonly = 1,
srcs = ["filesystem_benchmark.cpp"],
deps = [
":check",
":filesystem",
"//testing/base:benchmark_helpers",
"//testing/base:benchmark_main",
"@abseil-cpp//absl/hash",
"@abseil-cpp//absl/random",
"@google_benchmark//:benchmark",
"@llvm-project//llvm:Support",
],
)
sh_test(
name = "filesystem_benchmark_test",
size = "small",
srcs = [":filesystem_benchmark"],
args = [
"--benchmark_dry_run",
# Restrict the sizes to 2-digit ones or smaller to keep test times low.
# The `$$` is repeated for Bazel escaping of `$`.
"--benchmark_filter=^[^/]+(/[0-9]{1,2}(/[0-9]+)?)?/real_time$$",
],
)
cc_library(
name = "find",
hdrs = ["find.h"],
deps = [
":check",
":ostream",
":raw_string_ostream",
"@llvm-project//llvm:Support",
],
)
cc_test(
name = "find_test",
size = "small",
srcs = ["find_test.cpp"],
deps = [
":find",
"//testing/base:gtest_main",
"@googletest//:gtest",
],
)
cc_library(
name = "growing_range",
hdrs = ["growing_range.h"],
)
cc_test(
name = "growing_range_test",
size = "small",
srcs = ["growing_range_test.cpp"],
deps = [
":growing_range",
"//testing/base:gtest_main",
"@googletest//:gtest",
],
)
cc_library(
name = "hashing",
srcs = ["hashing.cpp"],
hdrs = ["hashing.h"],
deps = [
":check",
":ostream",
"@llvm-project//llvm:Support",
],
)
cc_library(
name = "hashing_llvm",
hdrs = ["hashing_llvm.h"],
deps = [
":hashing",
"@llvm-project//llvm:Support",
],
)
cc_test(
name = "hashing_test",
size = "small",
srcs = ["hashing_test.cpp"],
deps = [
":hashing",
":hashing_llvm",
":raw_string_ostream",
"//testing/base:gtest_main",
"@googletest//:gtest",
"@llvm-project//llvm:Support",
],
)
cc_binary(
name = "hashing_benchmark",
testonly = 1,
srcs = ["hashing_benchmark.cpp"],
deps = [
":check",
":hashing",
"//testing/base:benchmark_helpers",
"//testing/base:benchmark_main",
"@abseil-cpp//absl/hash",
"@abseil-cpp//absl/random",
"@google_benchmark//:benchmark",
"@llvm-project//llvm:Support",
],
)
cc_library(
name = "hashtable_key_context",
hdrs = ["hashtable_key_context.h"],
deps = [
":hashing",
"@llvm-project//llvm:Support",
],
)
cc_test(
name = "hashtable_key_context_test",
size = "small",
srcs = ["hashtable_key_context_test.cpp"],
deps = [
":hashing_llvm",
":hashtable_key_context",
"//testing/base:gtest_main",
"@googletest//:gtest",
"@llvm-project//llvm:Support",
],
)
cc_library(
name = "init_llvm",
srcs = ["init_llvm.cpp"],
hdrs = ["init_llvm.h"],
deps = [
"@llvm-project//llvm:Support",
],
)
# Link against this to cause `:init_llvm` to pull in all LLVM targets.
#
# Be careful when depending on this: it pulls in several hundred megabytes of
# LLVM binary size in -c fastbuild. This should only be depended on by a
# `cc_binary` or `cc_test` target, never a `cc_library`.
cc_library(
name = "all_llvm_targets",
srcs = ["all_llvm_targets.cpp"],
deps = [
":init_llvm",
"@llvm-project//llvm:AllTargetsAsmParsers",
"@llvm-project//llvm:AllTargetsCodeGens",
"@llvm-project//llvm:Support",
],
alwayslink = 1,
)
cc_library(
name = "latch",
srcs = ["latch.cpp"],
hdrs = ["latch.h"],
deps = [
":check",
"@llvm-project//llvm:Support",
],
)
cc_test(
name = "latch_test",
size = "small",
srcs = ["latch_test.cpp"],
deps = [
":latch",
"//testing/base:gtest_main",
"@googletest//:gtest",
"@llvm-project//llvm:Support",
],
)
cc_library(
name = "map",
hdrs = ["map.h"],
deps = [
":check",
":concepts",
":hashtable_key_context",
":raw_hashtable",
"@llvm-project//llvm:Support",
],
)
cc_test(
name = "map_test",
size = "small",
srcs = ["map_test.cpp"],
deps = [
":map",
":raw_hashtable_test_helpers",
"//testing/base:gtest_main",
"@googletest//:gtest",
"@llvm-project//llvm:Support",
],
)
cc_binary(
name = "map_benchmark",
testonly = 1,
srcs = ["map_benchmark.cpp"],
deps = [
":map",
":raw_hashtable_benchmark_helpers",
"//testing/base:benchmark_helpers",
"//testing/base:benchmark_main",
"@abseil-cpp//absl/container:flat_hash_map",
"@abseil-cpp//absl/random",
"@boost.unordered",
"@google_benchmark//:benchmark",
"@llvm-project//llvm:Support",
],
)
sh_test(
name = "map_benchmark_test",
# The benchmark allocates a large amount of memory.
size = "enormous",
# We configure the test to run somewhat quickly.
timeout = "moderate",
srcs = [":map_benchmark"],
args = [
"--benchmark_dry_run",
# The `$$` is repeated for Bazel escaping of `$`.
"--benchmark_filter=^[^/]*/[1-9][0-9]{0,2}(/[0-9]+)?$$",
],
)
cc_library(
name = "move_only",
hdrs = ["move_only.h"],
)
cc_library(
name = "ostream",
hdrs = ["ostream.h"],
deps = [
"@llvm-project//llvm:Support",
],
)
cc_test(
name = "ostream_test",
size = "small",
srcs = ["ostream_test.cpp"],
deps = [
":ostream",
":raw_string_ostream",
"//testing/base:gtest_main",
"@googletest//:gtest",
"@llvm-project//llvm:Support",
],
)
cc_library(
name = "pretty_stack_trace_function",
hdrs = ["pretty_stack_trace_function.h"],
deps = [
"@llvm-project//llvm:Support",
],
)
cc_library(
name = "raw_hashtable",
srcs = ["raw_hashtable.cpp"],
hdrs = ["raw_hashtable.h"],
deps = [
":check",
":concepts",
":hashing",
":hashtable_key_context",
":raw_hashtable_metadata_group",
"@llvm-project//llvm:Support",
],
)
cc_library(
name = "raw_hashtable_metadata_group",
srcs = ["raw_hashtable_metadata_group.cpp"],
hdrs = ["raw_hashtable_metadata_group.h"],
deps = [
":check",
":ostream",
"@llvm-project//llvm:Support",
],
)
cc_binary(
name = "raw_hashtable_metadata_group_benchmark",
testonly = 1,
srcs = ["raw_hashtable_metadata_group_benchmark.cpp"],
deps = [
":raw_hashtable_metadata_group",
"//testing/base:benchmark_helpers",
"//testing/base:benchmark_main",
"@abseil-cpp//absl/random",
"@google_benchmark//:benchmark",
"@llvm-project//llvm:Support",
],
)
sh_test(
name = "raw_hashtable_metadata_group_benchmark_test",
size = "small",
srcs = ["raw_hashtable_metadata_group_benchmark"],
args = [
"--benchmark_dry_run",
],
)
cc_library(
name = "raw_hashtable_benchmark_helpers",
testonly = 1,
srcs = ["raw_hashtable_benchmark_helpers.cpp"],
hdrs = ["raw_hashtable_benchmark_helpers.h"],
copts = [
"-O2", # Always optimize to make testing benchmarks faster.
],
deps = [
":check",
":hashing",
":raw_hashtable",
":set",
"@abseil-cpp//absl/base:no_destructor",
"@abseil-cpp//absl/hash",
"@abseil-cpp//absl/random",
"@boost.unordered",
"@google_benchmark//:benchmark",
"@llvm-project//llvm:Support",
],
)
cc_library(
name = "raw_hashtable_test_helpers",
testonly = 1,
hdrs = ["raw_hashtable_test_helpers.h"],
deps = [
":check",
":hashing",
":hashtable_key_context",
":ostream",
],
)
cc_library(
name = "raw_string_ostream",
hdrs = ["raw_string_ostream.h"],
deps = [
":check",
":ostream",
],
)
cc_test(
name = "raw_string_ostream_test",
size = "small",
srcs = ["raw_string_ostream_test.cpp"],
deps = [
":raw_string_ostream",
"//testing/base:gtest_main",
"@googletest//:gtest",
],
)
cc_library(
name = "set",
hdrs = ["set.h"],
deps = [
":check",
":hashtable_key_context",
":raw_hashtable",
"@llvm-project//llvm:Support",
],
)
cc_test(
name = "set_test",
size = "small",
srcs = ["set_test.cpp"],
deps = [
":raw_hashtable_test_helpers",
":set",
"//testing/base:gtest_main",
"@googletest//:gtest",
"@llvm-project//llvm:Support",
],
)
cc_binary(
name = "set_benchmark",
testonly = 1,
srcs = ["set_benchmark.cpp"],
deps = [
":raw_hashtable_benchmark_helpers",
":set",
"//testing/base:benchmark_helpers",
"//testing/base:benchmark_main",
"@abseil-cpp//absl/container:flat_hash_set",
"@google_benchmark//:benchmark",
"@llvm-project//llvm:Support",
],
)
sh_test(
name = "set_benchmark_test",
# The benchmark allocates a large amount of memory.
size = "enormous",
# We configure the test to run somewhat quickly.
timeout = "moderate",
srcs = [":set_benchmark"],
args = [
"--benchmark_dry_run",
# The `$$` is repeated for Bazel escaping of `$`.
"--benchmark_filter=^[^/]*/[1-9][0-9]{0,2}(/[0-9]+)?$$",
],
)
cc_library(
name = "string_helpers",
srcs = ["string_helpers.cpp"],
hdrs = ["string_helpers.h"],
deps = [
":check",
":error",
"@llvm-project//llvm:Support",
],
)
cc_test(
name = "string_helpers_test",
size = "small",
srcs = ["string_helpers_test.cpp"],
deps = [
":string_helpers",
"//testing/base:gtest_main",
"@googletest//:gtest",
"@llvm-project//llvm:Support",
],
)
cc_library(
name = "struct_reflection",
hdrs = ["struct_reflection.h"],
)
cc_test(
name = "struct_reflection_test",
size = "small",
srcs = ["struct_reflection_test.cpp"],
deps = [
":struct_reflection",
"//testing/base:gtest_main",
"@googletest//:gtest",
],
)
cc_library(
name = "template_string",
hdrs = ["template_string.h"],
deps = [
"@llvm-project//llvm:Support",
],
)
cc_test(
name = "template_string_test",
size = "small",
srcs = ["template_string_test.cpp"],
deps = [
":template_string",
"//testing/base:gtest_main",
"@googletest//:gtest",
],
)
cc_library(
name = "type_enum",
hdrs = ["type_enum.h"],
deps = [":ostream"],
)
# The base version source file only uses non-stamped parts of the version
# information so we expand it once here without any stamping.
expand_version_build_info(
name = "version_cpp_gen",
out = "version.cpp",
stamp = 0,
template = "version.tmpl.cpp",
)
# Build a nostamp version of the stamp source, but mark its definitions as weak.
# We'll include this in the library to satisfy definitions of library and test
# users, but still allow binaries that want full build stamping to depend on the
# stamp library below to override with strong, stamped definitions.
expand_version_build_info(
name = "version_nostamp_cpp_gen",
out = "version_nostamp.cpp",
stamp = 0,
substitutions = {"MAKE_WEAK": "1"},
template = "version_stamp.tmpl.cpp",
)
# Provides APIs for accessing Carbon version information.
#
# These provide full access to the major, minor, and patch version. It also
# provides an API for querying version strings that may contain detailed build
# information such as the commit SHA.
#
# By default, this provides the API and an *unstamped* implementations of
# version strings. As a consequence, depending on this library doesn't introduce
# any dependency on the commit SHA or loss of build caching.
#
# Targets that want full build info stamping in the data produced by these APIs
# should additionally depend on `:version_stamp` below -- the data these APIs
# return will be overridden in any binaries depending on that rule with the
# fully stamped details.
cc_library(
name = "version",
srcs = [
"version.cpp",
"version_nostamp.cpp",
],
hdrs = ["version.h"],
deps = [
"@llvm-project//llvm:Support",
],
)
# Generate the fully stamped sourcefile if stamping is enabled in the build.
expand_version_build_info(
name = "version_stamp_cpp_gen",
out = "version_stamp.cpp",
template = "version_stamp.tmpl.cpp",
)
# Depend on this library to enable fully-stamped build information in the
# version API provided by `:version`. This doesn't provide the API, it injects
# an override of stamped versions of the data.
#
# Note that depending on this will significantly reduce build caching with
# `--stamp` builds. It should be used sparingly, typically in user-facing
# binaries or systems that need to render a maximally detailed version string
# with build information stamped into it.
cc_library(
name = "version_stamp",
srcs = ["version_stamp.cpp"],
deps = [
":version",
"@llvm-project//llvm:Support",
],
)
cc_library(
name = "vlog",
hdrs = ["vlog.h"],
deps = [
":ostream",
":template_string",
"@llvm-project//llvm:Support",
],
)
cc_test(
name = "vlog_test",
size = "small",
srcs = ["vlog_test.cpp"],
deps = [
":raw_string_ostream",
":vlog",
"//testing/base:gtest_main",
"@googletest//:gtest",
],
)