Rename to KitGenBench

chillenzer · chillenzer · commit 136fe4661ded · 2024-12-12T09:21:31.000+01:00
diff --git a/.github/workflows/standalone.yml b/.github/workflows/standalone.yml
@@ -37,4 +37,4 @@ jobs:
         run: cmake --build build -j4
 
       - name: run
-        run: ./build/MemBenchMC
+        run: ./build/KitGenBench
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -4,7 +4,7 @@ if(POLICY CMP0167)
     cmake_policy(SET CMP0167 NEW)
 endif()
 # ---- Project ----
-project(MemBenchMC VERSION 0.1 LANGUAGES CXX)
+project(KitGenBench VERSION 0.1 LANGUAGES CXX)
 
 # ---- Include guards ----
 
diff --git a/README.md b/README.md
@@ -1,10 +1,10 @@
-[![Actions Status](https://github.com/chillenzer/MemBenchMC/workflows/Ubuntu/badge.svg)](https://github.com/chillenzer/MemBenchMC/actions)
-[![Actions Status](https://github.com/chillenzer/MemBenchMC/workflows/Install/badge.svg)](https://github.com/chillenzer/MemBenchMC/actions)
-[![codecov](https://codecov.io/gh/chillenzer/MemBenchMC/branch/master/graph/badge.svg)](https://codecov.io/gh/chillenzer/MemBenchMC)
+[![Actions Status](https://github.com/chillenzer/KitGenBench/workflows/Ubuntu/badge.svg)](https://github.com/chillenzer/KitGenBench/actions)
+[![Actions Status](https://github.com/chillenzer/KitGenBench/workflows/Install/badge.svg)](https://github.com/chillenzer/KitGenBench/actions)
+[![codecov](https://codecov.io/gh/chillenzer/KitGenBench/branch/master/graph/badge.svg)](https://codecov.io/gh/chillenzer/KitGenBench)
 
-# MemBenchMC
+# KitGenBench
 
-MemBenchMC is a Memory Benchmark for Many-Core Architectures.
+KitGenBench is a Memory Benchmark for Many-Core Architectures.
 
 ### Build and run the standalone target
 
@@ -13,7 +13,7 @@ Use the following command to build and run the executable target.
 ```bash
 cmake -S standalone -B build/standalone
 cmake --build build/standalone
-./build/standalone/MemBenchMC --help
+./build/standalone/KitGenBench --help
 ```
 
 ### Build and run test suite
@@ -26,14 +26,14 @@ cmake --build build/test
 CTEST_OUTPUT_ON_FAILURE=1 cmake --build build/test --target test
 
 # or simply call the executable:
-./build/test/MemBenchMCTests
+./build/test/KitGenBenchTests
 ```
 
 To collect code coverage information, run CMake with the `-DENABLE_TEST_COVERAGE=1` option.
 
 ### Build the documentation
 
-The documentation is automatically built and [published](https://chillenzer.github.io/MemBenchMC) whenever a [GitHub Release](https://help.github.com/en/github/administering-a-repository/managing-releases-in-a-repository) is created.
+The documentation is automatically built and [published](https://chillenzer.github.io/KitGenBench) whenever a [GitHub Release](https://help.github.com/en/github/administering-a-repository/managing-releases-in-a-repository) is created.
 To manually build documentation, call the following command.
 
 ```bash
@@ -55,11 +55,11 @@ cmake -S all -B build
 cmake --build build
 
 # run tests
-./build/test/MemBenchMCTests
+./build/test/KitGenBenchTests
 # format code
 cmake --build build --target fix-format
 # run standalone
-./build/standalone/MemBenchMC --help
+./build/standalone/KitGenBench --help
 # build docs
 cmake --build build --target GenerateDocs
 ```
diff --git a/documentation/CMakeLists.txt b/documentation/CMakeLists.txt
@@ -1,19 +1,19 @@
 cmake_minimum_required(VERSION 3.14...3.22)
 
-project(MemBenchMCDocs)
+project(KitGenBenchDocs)
 
 # ---- Dependencies ----
 
 include(../cmake/CPM.cmake)
 
 cpmaddpackage("gh:mosra/m.css#a0d292ec311b97fefd21e93cdefb60f88d19ede6")
-cpmaddpackage(NAME MemBenchMC SOURCE_DIR ${CMAKE_CURRENT_LIST_DIR}/..)
+cpmaddpackage(NAME KitGenBench SOURCE_DIR ${CMAKE_CURRENT_LIST_DIR}/..)
 
 # ---- Doxygen variables ----
 
 # set Doxyfile variables
-set(DOXYGEN_PROJECT_NAME MemBenchMC)
-set(DOXYGEN_PROJECT_VERSION ${MemBenchMC_VERSION})
+set(DOXYGEN_PROJECT_NAME KitGenBench)
+set(DOXYGEN_PROJECT_VERSION ${KitGenBench_VERSION})
 set(DOXYGEN_PROJECT_ROOT "${CMAKE_CURRENT_LIST_DIR}/..")
 set(DOXYGEN_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/doxygen")
 
diff --git a/documentation/conf.py b/documentation/conf.py
@@ -10,10 +10,10 @@
 
 # LINKS_NAVBAR1 = [
 #     (None, 'pages', [(None, 'about')]),
-#     (None, 'namespaces', [(None, 'namespacemembenchmc')]),
+#     (None, 'namespaces', [(None, 'namespacekitgenbench')]),
 # ]
 #
 # LINKS_NAVBAR2 = [
-#     (None, 'annotated', [(None, 'classmembenchmc_1_1_membenchmc')]),
-#     (None, 'files', [(None, 'membenchmc_8h')]),
+#     (None, 'annotated', [(None, 'classkitgenbench_1_1_kitgenbench')]),
+#     (None, 'files', [(None, 'kitgenbench_8h')]),
 # ]
diff --git a/documentation/pages/about.dox b/documentation/pages/about.dox
@@ -1,4 +1,4 @@
 /** @page about About
-  @section doc MemBenchMC Documentation
-  This is the auto-generated documentation for the MemBenchMC project.
+  @section doc KitGenBench Documentation
+  This is the auto-generated documentation for the KitGenBench project.
 */
diff --git a/include/kitgenbench/DeviceClock.h b/include/kitgenbench/DeviceClock.h
@@ -8,7 +8,7 @@
 #  include <cuda_runtime.h>
 #endif
 
-namespace membenchmc {
+namespace kitgenbench {
   template <typename TAccTag> struct DeviceClock;
 
   template <> struct DeviceClock<alpaka::TagCpuSerial> {
@@ -38,4 +38,4 @@ namespace membenchmc {
   };
 
 #endif
-}  // namespace membenchmc
+}  // namespace kitgenbench
diff --git a/include/kitgenbench/kitgenbench.h b/include/kitgenbench/kitgenbench.h
@@ -1,5 +1,5 @@
 #pragma once
-#include <membenchmc/setup.h>
+#include <kitgenbench/setup.h>
 
 #include <alpaka/acc/Traits.hpp>
 #include <alpaka/alpaka.hpp>
@@ -11,7 +11,7 @@
 
 #include "alpaka/queue/Properties.hpp"
 
-namespace membenchmc {
+namespace kitgenbench {
 
   template <typename TAcc, typename TDev> struct ExecutionDetails {
     alpaka::WorkDivMembers<alpaka::Dim<TAcc>, alpaka::Idx<TAcc>> workdiv{};
@@ -122,4 +122,4 @@ namespace membenchmc {
    * @return nlohmann::json A JSON object containing the gathered metadata.
    */
   nlohmann::json gatherMetadata();
-}  // namespace membenchmc
+}  // namespace kitgenbench
diff --git a/include/kitgenbench/setup.h b/include/kitgenbench/setup.h
@@ -6,14 +6,14 @@
 
 #include "nlohmann/json.hpp"
 
-namespace membenchmc::Actions {
+namespace kitgenbench::Actions {
   // This namespace mimics an enum but is supposed to be extended by the user to allow for more
   // setups. Library-defined actions have negative values, user-defined positive ones.
   static constexpr int STOP = -1;
   static constexpr int CHECK = -2;
-}  // namespace membenchmc::Actions
+}  // namespace kitgenbench::Actions
 
-namespace membenchmc::setup {
+namespace kitgenbench::setup {
   template <typename TExecutionDetails, typename TInstructionDetails> struct Setup {
     std::string name{};
     TExecutionDetails execution{};
@@ -53,4 +53,4 @@ namespace membenchmc::setup {
 
     nlohmann::json generateReport() { return {}; }
   };
-}  // namespace membenchmc::setup
+}  // namespace kitgenbench::setup
diff --git a/source/kitgenbench.cpp b/source/kitgenbench.cpp
@@ -1,4 +1,4 @@
-#include <membenchmc/membenchmc.h>
+#include <kitgenbench/kitgenbench.h>
 #ifdef ALPAKA_ACC_GPU_CUDA_ENABLED
 #  include <cuda_runtime.h>
 #endif
@@ -11,7 +11,7 @@
 #include <sstream>
 #include <string>
 
-namespace membenchmc {
+namespace kitgenbench {
   /**
    * @brief Trims leading and trailing whitespace from a string.
    *
@@ -181,4 +181,4 @@ namespace membenchmc {
     metadata["device info"] = getGPUInfo();
     return metadata;
   }
-}  // namespace membenchmc
+}  // namespace kitgenbench
diff --git a/standalone/CMakeLists.txt b/standalone/CMakeLists.txt
@@ -3,7 +3,7 @@ cmake_minimum_required(VERSION 3.14...3.22)
 if(POLICY CMP0167)
     cmake_policy(SET CMP0167 NEW)
 endif()
-project(MemBenchMCStandalone LANGUAGES CXX)
+project(KitGenBenchStandalone LANGUAGES CXX)
 
 # --- Import tools ----
 
@@ -25,7 +25,7 @@ cpmaddpackage(
   GIT_TAG 1.2.0
 )
 
-cpmaddpackage(NAME MemBenchMC SOURCE_DIR ${CMAKE_CURRENT_LIST_DIR}/..)
+cpmaddpackage(NAME KitGenBench SOURCE_DIR ${CMAKE_CURRENT_LIST_DIR}/..)
 
 # ---- Create standalone executable ----
 
@@ -37,14 +37,14 @@ set_target_properties(
     ${PROJECT_NAME}
     PROPERTIES
         CXX_STANDARD 20
-        OUTPUT_NAME "MemBenchMC"
+        OUTPUT_NAME "KitGenBench"
         CXX_STANDARD_REQUIRED ON
         CXX_EXTENSIONS OFF
 )
 
 target_link_libraries(
     ${PROJECT_NAME}
-    MemBenchMC::MemBenchMC
+    KitGenBench::KitGenBench
     nlohmann_json::nlohmann_json
     alpaka::alpaka
 )
diff --git a/standalone/source/main.cpp b/standalone/source/main.cpp
@@ -1,7 +1,7 @@
-#include <membenchmc/DeviceClock.h>
-#include <membenchmc/membenchmc.h>
-#include <membenchmc/setup.h>
-#include <membenchmc/version.h>
+#include <kitgenbench/DeviceClock.h>
+#include <kitgenbench/kitgenbench.h>
+#include <kitgenbench/setup.h>
+#include <kitgenbench/version.h>
 
 #include <alpaka/workdiv/WorkDivMembers.hpp>
 #include <cstdint>
@@ -26,17 +26,17 @@
 #include "nlohmann/json_fwd.hpp"
 
 using nlohmann::json;
-using namespace membenchmc;
+using namespace kitgenbench;
 
 using Dim = alpaka::DimInt<1>;
 using Idx = std::uint32_t;
 using AccTag = std::remove_cvref_t<decltype(std::get<0>(alpaka::EnabledAccTags{}))>;
 using Acc = alpaka::TagToAcc<AccTag, Dim, Idx>;
 
-namespace membenchmc::Actions {
+namespace kitgenbench::Actions {
   [[maybe_unused]] static constexpr int MALLOC = 1;
   [[maybe_unused]] static constexpr int FREE = 2;
-}  // namespace membenchmc::Actions
+}  // namespace kitgenbench::Actions
 
 auto makeExecutionDetails() {
   auto const platformAcc = alpaka::Platform<Acc>{};
@@ -54,7 +54,7 @@ auto makeExecutionDetails() {
           {numThreads / numThreadsPerBlock}, {numThreadsPerBlock}, {1U}};
     }
   }();
-  return membenchmc::ExecutionDetails<Acc, decltype(dev)>{workdiv, dev};
+  return kitgenbench::ExecutionDetails<Acc, decltype(dev)>{workdiv, dev};
 }
 
 static constexpr std::uint32_t ALLOCATION_SIZE = 16U;
@@ -229,12 +229,12 @@ namespace setups {
 
     ALPAKA_FN_ACC auto next([[maybe_unused]] const auto& acc) {
       if (counter >= numAllocations)
-        return std::make_tuple(+membenchmc::Actions::STOP,
+        return std::make_tuple(+kitgenbench::Actions::STOP,
                                Payload(std::span<std::byte, allocationSize>{
                                    static_cast<std::byte*>(nullptr), allocationSize}));
       pointers[counter] = static_cast<std::byte*>(malloc(allocationSize));
       auto result = std::make_tuple(
-          +membenchmc::Actions::MALLOC,
+          +kitgenbench::Actions::MALLOC,
           Payload(std::span<std::byte, allocationSize>(pointers[counter], allocationSize)));
       counter++;
       return result;
diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt
@@ -3,7 +3,7 @@ cmake_minimum_required(VERSION 3.14...3.22)
 if(POLICY CMP0167)
     cmake_policy(SET CMP0167 NEW)
 endif()
-project(MemBenchMCTests LANGUAGES CXX)
+project(KitGenBenchTests LANGUAGES CXX)
 
 # ---- Options ----
 
@@ -33,9 +33,9 @@ cpmaddpackage(
 )
 
 if(TEST_INSTALLED_VERSION)
-    find_package(MemBenchMC REQUIRED)
+    find_package(KitGenBench REQUIRED)
 else()
-    cpmaddpackage(NAME MemBenchMC SOURCE_DIR ${CMAKE_CURRENT_LIST_DIR}/..)
+    cpmaddpackage(NAME KitGenBench SOURCE_DIR ${CMAKE_CURRENT_LIST_DIR}/..)
 endif()
 
 # ---- Create binary ----
@@ -45,7 +45,7 @@ alpaka_add_executable(${PROJECT_NAME} ${sources})
 target_link_libraries(
     ${PROJECT_NAME}
     doctest::doctest
-    MemBenchMC::MemBenchMC
+    KitGenBench::KitGenBench
     nlohmann_json::nlohmann_json
     alpaka::alpaka
 )
@@ -60,7 +60,7 @@ if(NOT TEST_INSTALLED_VERSION)
         OR CMAKE_CXX_COMPILER_ID MATCHES "GNU"
     )
         target_compile_options(
-            MemBenchMC
+            KitGenBench
             PUBLIC
                 -Wall
                 "$<$<COMPILE_LANGUAGE:CXX>:-Wpedantic>"
@@ -69,15 +69,15 @@ if(NOT TEST_INSTALLED_VERSION)
                 "$<$<COMPILE_LANGUAGE:CUDA>:all-warnings>"
         )
     elseif(MSVC)
-        target_compile_options(MemBenchMC PUBLIC /W4 /WX)
+        target_compile_options(KitGenBench PUBLIC /W4 /WX)
         target_compile_definitions(
             ${PROJECT_NAME}
             PUBLIC DOCTEST_CONFIG_USE_STD_HEADERS
         )
     endif()
 endif()
 
-# ---- Add MemBenchMCTests ----
+# ---- Add KitGenBenchTests ----
 
 enable_testing()
 
@@ -92,8 +92,8 @@ doctest_discover_tests(${PROJECT_NAME})
 
 if(ENABLE_TEST_COVERAGE)
     target_compile_options(
-        MemBenchMC
+        KitGenBench
         PUBLIC -O0 -g -fprofile-arcs -ftest-coverage
     )
-    target_link_options(MemBenchMC PUBLIC -fprofile-arcs -ftest-coverage)
+    target_link_options(KitGenBench PUBLIC -fprofile-arcs -ftest-coverage)
 endif()
diff --git a/test/source/kitgenbench.cpp b/test/source/kitgenbench.cpp
