test: Use span for raw data

This change allows to drop brittle sizeof calls in favor of the std::span::size method. Other improvements include: * Use of a namespace to mark test and bench data * Use of the modern std::byte * Drop of a no longer used std::vector copy and the bench/data module
bitcoin-core · Sep 5, 2024 · faecca9 · faecca9
1 parent fac9736
commit faecca9
Show file tree

Hide file tree

Showing 12 changed files with 24 additions and 54 deletions.
diff --git a/cmake/module/GenerateHeaders.cmake b/cmake/module/GenerateHeaders.cmake
@@ -11,10 +11,10 @@ function(generate_header_from_json json_source_relpath)
   )
 endfunction()
 
-function(generate_header_from_raw raw_source_relpath)
+function(generate_header_from_raw raw_source_relpath raw_namespace)
   add_custom_command(
     OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${raw_source_relpath}.h
-    COMMAND ${CMAKE_COMMAND} -DRAW_SOURCE_PATH=${CMAKE_CURRENT_SOURCE_DIR}/${raw_source_relpath} -DHEADER_PATH=${CMAKE_CURRENT_BINARY_DIR}/${raw_source_relpath}.h -P ${PROJECT_SOURCE_DIR}/cmake/script/GenerateHeaderFromRaw.cmake
+    COMMAND ${CMAKE_COMMAND} -DRAW_SOURCE_PATH=${CMAKE_CURRENT_SOURCE_DIR}/${raw_source_relpath} -DHEADER_PATH=${CMAKE_CURRENT_BINARY_DIR}/${raw_source_relpath}.h -DRAW_NAMESPACE=${raw_namespace} -P ${PROJECT_SOURCE_DIR}/cmake/script/GenerateHeaderFromRaw.cmake
     DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/${raw_source_relpath} ${PROJECT_SOURCE_DIR}/cmake/script/GenerateHeaderFromRaw.cmake
     VERBATIM
   )

diff --git a/cmake/script/GenerateHeaderFromRaw.cmake b/cmake/script/GenerateHeaderFromRaw.cmake
@@ -5,18 +5,23 @@
 file(READ ${RAW_SOURCE_PATH} hex_content HEX)
 string(REGEX MATCHALL "([A-Za-z0-9][A-Za-z0-9])" bytes "${hex_content}")
 
+file(WRITE ${HEADER_PATH} "#include <cstddef>\n")
+file(APPEND ${HEADER_PATH} "#include <span>\n")
+file(APPEND ${HEADER_PATH} "namespace ${RAW_NAMESPACE} {\n")
 get_filename_component(raw_source_basename ${RAW_SOURCE_PATH} NAME_WE)
-file(WRITE ${HEADER_PATH} "static unsigned const char ${raw_source_basename}_raw[] = {\n")
+file(APPEND ${HEADER_PATH} "inline constexpr std::byte detail_${raw_source_basename}_raw[]{\n")
 
 set(i 0)
 foreach(byte ${bytes})
   math(EXPR i "${i} + 1")
   math(EXPR remainder "${i} % 8")
   if(remainder EQUAL 0)
-    file(APPEND ${HEADER_PATH} "0x${byte},\n")
+    file(APPEND ${HEADER_PATH} "std::byte{0x${byte}},\n")
   else()
-    file(APPEND ${HEADER_PATH} "0x${byte}, ")
+    file(APPEND ${HEADER_PATH} "std::byte{0x${byte}}, ")
   endif()
 endforeach()
 
-file(APPEND ${HEADER_PATH} "\n};")
+file(APPEND ${HEADER_PATH} "\n};\n")
+file(APPEND ${HEADER_PATH} "inline constexpr std::span ${raw_source_basename}{detail_${raw_source_basename}_raw};\n")
+file(APPEND ${HEADER_PATH} "}")
diff --git a/src/bench/CMakeLists.txt b/src/bench/CMakeLists.txt
@@ -3,12 +3,11 @@
 # file COPYING or https://opensource.org/license/mit/.
 
 include(GenerateHeaders)
-generate_header_from_raw(data/block413567.raw)
+generate_header_from_raw(data/block413567.raw benchmark::data)
 
 add_executable(bench_bitcoin
   bench_bitcoin.cpp
   bench.cpp
-  data.cpp
   nanobench.cpp
   ${CMAKE_CURRENT_BINARY_DIR}/data/block413567.raw.h
 # Benchmarks:

diff --git a/src/bench/checkblock.cpp b/src/bench/checkblock.cpp
@@ -3,7 +3,7 @@
 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
 #include <bench/bench.h>
-#include <bench/data.h>
+#include <bench/data/block413567.raw.h>
 #include <chainparams.h>
 #include <common/args.h>
 #include <consensus/validation.h>

diff --git a/src/bench/data.cpp b/src/bench/data.cpp
diff --git a/src/bench/data.h b/src/bench/data.h
diff --git a/src/bench/load_external.cpp b/src/bench/load_external.cpp
@@ -3,7 +3,7 @@
 // file COPYING or https://www.opensource.org/licenses/mit-license.php.
 
 #include <bench/bench.h>
-#include <bench/data.h>
+#include <bench/data/block413567.raw.h>
 #include <chainparams.h>
 #include <flatfile.h>
 #include <node/blockstorage.h>

diff --git a/src/bench/readblock.cpp b/src/bench/readblock.cpp
@@ -3,7 +3,7 @@
 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
 #include <bench/bench.h>
-#include <bench/data.h>
+#include <bench/data/block413567.raw.h>
 #include <flatfile.h>
 #include <node/blockstorage.h>
 #include <primitives/block.h>

diff --git a/src/bench/rpc_blockchain.cpp b/src/bench/rpc_blockchain.cpp
@@ -3,7 +3,7 @@
 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
 #include <bench/bench.h>
-#include <bench/data.h>
+#include <bench/data/block413567.raw.h>
 #include <chain.h>
 #include <core_io.h>
 #include <primitives/block.h>

diff --git a/src/bench/strencodings.cpp b/src/bench/strencodings.cpp
@@ -3,7 +3,7 @@
 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
 #include <bench/bench.h>
-#include <bench/data.h>
+#include <bench/data/block413567.raw.h>
 #include <span.h>
 #include <util/strencodings.h>
 

diff --git a/src/test/CMakeLists.txt b/src/test/CMakeLists.txt
@@ -12,7 +12,7 @@ generate_header_from_json(data/script_tests.json)
 generate_header_from_json(data/sighash.json)
 generate_header_from_json(data/tx_invalid.json)
 generate_header_from_json(data/tx_valid.json)
-generate_header_from_raw(data/asmap.raw)
+generate_header_from_raw(data/asmap.raw test::data)
 
 # Do not use generator expressions in test sources because the
 # SOURCES property is processed to gather test suite macros.

diff --git a/src/test/addrman_tests.cpp b/src/test/addrman_tests.cpp
@@ -47,11 +47,12 @@ static CService ResolveService(const std::string& ip, uint16_t port = 0)
 }
 
 
-static std::vector<bool> FromBytes(const unsigned char* source, int vector_size)
+static std::vector<bool> FromBytes(std::span<const std::byte> source)
 {
+    int vector_size(source.size() * 8);
     std::vector<bool> result(vector_size);
     for (int byte_i = 0; byte_i < vector_size / 8; ++byte_i) {
-        unsigned char cur_byte = source[byte_i];
+        uint8_t cur_byte{std::to_integer<uint8_t>(source[byte_i])};
         for (int bit_i = 0; bit_i < 8; ++bit_i) {
             result[byte_i * 8 + bit_i] = (cur_byte >> bit_i) & 1;
         }
@@ -576,7 +577,7 @@ BOOST_AUTO_TEST_CASE(caddrinfo_get_new_bucket_legacy)
 // 101.8.0.0/16 AS8
 BOOST_AUTO_TEST_CASE(caddrinfo_get_tried_bucket)
 {
-    std::vector<bool> asmap = FromBytes(asmap_raw, sizeof(asmap_raw) * 8);
+    std::vector<bool> asmap = FromBytes(test::data::asmap);
     NetGroupManager ngm_asmap{asmap};
 
     CAddress addr1 = CAddress(ResolveService("250.1.1.1", 8333), NODE_NONE);
@@ -630,7 +631,7 @@ BOOST_AUTO_TEST_CASE(caddrinfo_get_tried_bucket)
 
 BOOST_AUTO_TEST_CASE(caddrinfo_get_new_bucket)
 {
-    std::vector<bool> asmap = FromBytes(asmap_raw, sizeof(asmap_raw) * 8);
+    std::vector<bool> asmap = FromBytes(test::data::asmap);
     NetGroupManager ngm_asmap{asmap};
 
     CAddress addr1 = CAddress(ResolveService("250.1.2.1", 8333), NODE_NONE);
@@ -708,7 +709,7 @@ BOOST_AUTO_TEST_CASE(caddrinfo_get_new_bucket)
 
 BOOST_AUTO_TEST_CASE(addrman_serialization)
 {
-    std::vector<bool> asmap1 = FromBytes(asmap_raw, sizeof(asmap_raw) * 8);
+    std::vector<bool> asmap1 = FromBytes(test::data::asmap);
     NetGroupManager netgroupman{asmap1};
 
     const auto ratio = GetCheckRatio(m_node);