From 53366c5787a331908b3b88931a2c14ff35e0df57 Mon Sep 17 00:00:00 2001 From: Jacob Lifshay Date: Wed, 20 Jul 2022 00:42:54 -0700 Subject: [PATCH 1/1] initial commit --- .clang-format | 2 + .gitignore | 3 + .vscode/settings.json | 7 + CMakeLists.txt | 12 + COPYING.LGPLv3 | 165 ++++++++++ Makefile | 39 +++ README.md | 7 + harness.cpp | 8 + harness.h | 57 ++++ install-deps.sh | 19 ++ main.cpp | 417 ++++++++++++++++++++++++++ toolchain-aarch64-linux-gnu.cmake | 8 + toolchain-powerpc64le-linux-gnu.cmake | 8 + toolchain-x86_64-linux-gnu.cmake | 10 + 14 files changed, 762 insertions(+) create mode 100644 .clang-format create mode 100644 .gitignore create mode 100644 .vscode/settings.json create mode 100644 CMakeLists.txt create mode 100644 COPYING.LGPLv3 create mode 100644 Makefile create mode 100644 README.md create mode 100644 harness.cpp create mode 100644 harness.h create mode 100755 install-deps.sh create mode 100644 main.cpp create mode 100644 toolchain-aarch64-linux-gnu.cmake create mode 100644 toolchain-powerpc64le-linux-gnu.cmake create mode 100644 toolchain-x86_64-linux-gnu.cmake diff --git a/.clang-format b/.clang-format new file mode 100644 index 0000000..4f236ca --- /dev/null +++ b/.clang-format @@ -0,0 +1,2 @@ +BasedOnStyle: Microsoft +ColumnLimit: 79 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..821c2c2 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +/build* +/.cache +/compile_commands.json \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..630965c --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,7 @@ +{ + "cmake.buildDirectory": "${workspaceFolder}/build-x86_64", + "cmake.configureArgs": [ + "-DCMAKE_TOOLCHAIN_FILE=toolchain-x86_64-linux-gnu.cmake" + ], + "cmake.copyCompileCommands": "${workspaceFolder}/compile_commands.json", +} \ No newline at end of file diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 0000000..ca7c63d --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,12 @@ +cmake_minimum_required(VERSION 3.11.0) +project(atomic-benchmarks VERSION 0.1.0) + +set(CMAKE_CXX_STANDARD 17) +set(CMAKE_CXX_STANDARD_REQUIRED ON) + +add_compile_options(-Wall -Wextra -Wimplicit-fallthrough) +add_executable(atomic-benchmarks main.cpp harness.cpp) + +set(CPACK_PROJECT_NAME ${PROJECT_NAME}) +set(CPACK_PROJECT_VERSION ${PROJECT_VERSION}) +include(CPack) diff --git a/COPYING.LGPLv3 b/COPYING.LGPLv3 new file mode 100644 index 0000000..65c5ca8 --- /dev/null +++ b/COPYING.LGPLv3 @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..0c9321a --- /dev/null +++ b/Makefile @@ -0,0 +1,39 @@ +.PHONY: all clean configure +all: build-ppc64le/atomic-benchmarks build-aarch64/atomic-benchmarks build-x86_64/atomic-benchmarks + +common_cmake_flags = -S . +common_cmake_flags += -DCMAKE_EXPORT_COMPILE_COMMANDS:BOOL=TRUE + +reset_make_env = "MAKEFLAGS=" "MFLAGS=" "MAKELEVEL=" "MAKE_TERMERR=" "MAKE_TERMOUT=" + +build-ppc64le/Makefile: toolchain-powerpc64le-linux-gnu.cmake CMakeLists.txt + ./install-deps.sh + rm -fr build-ppc64le + env $(reset_make_env) cmake $(common_cmake_flags) -B build-ppc64le -DCMAKE_TOOLCHAIN_FILE=toolchain-powerpc64le-linux-gnu.cmake + +build-aarch64/Makefile: toolchain-aarch64-linux-gnu.cmake CMakeLists.txt + ./install-deps.sh + rm -fr build-aarch64 + env $(reset_make_env) cmake $(common_cmake_flags) -B build-aarch64 -DCMAKE_TOOLCHAIN_FILE=toolchain-aarch64-linux-gnu.cmake + +build-x86_64/Makefile: toolchain-x86_64-linux-gnu.cmake CMakeLists.txt + ./install-deps.sh + rm -fr build-x86_64 + env $(reset_make_env) cmake $(common_cmake_flags) -B build-x86_64 -DCMAKE_TOOLCHAIN_FILE=toolchain-x86_64-linux-gnu.cmake + +configure: build-ppc64le/Makefile build-aarch64/Makefile build-x86_64/Makefile + +.PHONY: __force-run + +build-ppc64le/atomic-benchmarks: build-ppc64le/Makefile __force-run + $(MAKE) -C build-ppc64le atomic-benchmarks + +build-aarch64/atomic-benchmarks: build-aarch64/Makefile __force-run + $(MAKE) -C build-aarch64 atomic-benchmarks + +build-x86_64/atomic-benchmarks: build-x86_64/Makefile __force-run + $(MAKE) -C build-x86_64 atomic-benchmarks + +clean: + rm -fr build-ppc64le build-aarch64 build-x86_64 + diff --git a/README.md b/README.md new file mode 100644 index 0000000..15518e3 --- /dev/null +++ b/README.md @@ -0,0 +1,7 @@ +# Tool for benchmarking atomic operations + +# Building (installs dependencies and configures cmake builds for all 3 targets): + +``` +make +``` \ No newline at end of file diff --git a/harness.cpp b/harness.cpp new file mode 100644 index 0000000..2de66f0 --- /dev/null +++ b/harness.cpp @@ -0,0 +1,8 @@ +#include "harness.h" + +void BenchHarnessBase::base_run( + Config config, void (*fn)(BenchHarnessBase *bench_harness_base, + std::uint64_t iteration_count)) +{ + // FIXME: finish +} \ No newline at end of file diff --git a/harness.h b/harness.h new file mode 100644 index 0000000..3c4cd28 --- /dev/null +++ b/harness.h @@ -0,0 +1,57 @@ +#pragma once + +#include +#include +#include +#include +#include + +struct Config final +{ + std::optional thread_count; + std::optional iteration_count; +}; + +template > +class BenchHarness; + +class BenchHarnessBase +{ + template + friend class BenchHarness; + + private: + void base_run(Config config, + void (*fn)(BenchHarnessBase *bench_harness_base, + std::uint64_t iteration_count)); +}; + +template +class BenchHarness> final + : private BenchHarnessBase +{ + private: + Fn fn; + + public: + void run(Config config) + { + base_run(config, [](BenchHarnessBase *bench_harness_base, + std::uint64_t iteration_count) { + auto &fn = static_cast(bench_harness_base)->fn; + for (std::uint64_t i = 0; i < iteration_count; i++) + { + Input input; + + // optimization barrier + asm("" : : "r"(std::addressof(input)) : "memory"); + + auto output = fn(input); + + // optimization barrier + asm("" : : "r"(std::addressof(output)) : "memory"); + } + }); + } +}; \ No newline at end of file diff --git a/install-deps.sh b/install-deps.sh new file mode 100755 index 0000000..6d6084a --- /dev/null +++ b/install-deps.sh @@ -0,0 +1,19 @@ +#!/bin/bash +set -e + +# need to install g++ first so the local arch will get filtered out later +which g++ > /dev/null || (set -x; sudo apt install build-essential g++) + +needed=() + +which x86_64-linux-gnu-g++ > /dev/null || needed+=(g++-x86_64-linux-gnu) +which aarch64-linux-gnu-g++ > /dev/null || needed+=(g++-aarch64-linux-gnu) +which powerpc64le-linux-gnu-g++ > /dev/null || needed+=(g++-powerpc64le-linux-gnu) +which clang++-11 > /dev/null || needed+=(clang-11) +which make > /dev/null || needed+=(make) +which cmake > /dev/null || needed+=(cmake) +which ccache > /dev/null || needed+=(ccache) + +if ((${#needed[@]})); then + (set -x; sudo apt install "${needed[@]}") +fi diff --git a/main.cpp b/main.cpp new file mode 100644 index 0000000..7062ec8 --- /dev/null +++ b/main.cpp @@ -0,0 +1,417 @@ +#include "harness.h" +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +using namespace std::literals; + +enum class OptionValueKind +{ + None, + Required, +}; + +class OptionsParser; + +struct Option final +{ + char short_name = '\0'; + std::string_view long_name = "", description = ""; + bool required = false; + bool all_other_args_not_required = false; + OptionValueKind value_kind = OptionValueKind::None; + std::function value)> + parse_value; + bool has_short_name() const + { + return short_name != '\0'; + } + bool has_long_name() const + { + return !long_name.empty(); + } + friend std::ostream &operator<<(std::ostream &os, const Option &option) + { + if (option.has_long_name()) + { + os << "--" << option.long_name; + } + else if (option.has_short_name()) + { + os << "-" << option.short_name; + } + else + { + os << "--"; + } + return os; + } +}; + +class Options final +{ + friend class OptionsParser; + + private: + std::vector