Rename head2 to arrayhead, allow empty files in validate().

evoskuil · evoskuil · commit a5b6e4e240b2 · 2025-01-07T21:43:08.000-05:00
diff --git a/Makefile.am b/Makefile.am
@@ -76,10 +76,10 @@ test_libbitcoin_database_test_SOURCES = \
     test/mocks/chunk_storage.hpp \
     test/mocks/chunk_store.hpp \
     test/mocks/map_store.hpp \
+    test/primitives/arrayhead.cpp \
     test/primitives/arraymap.cpp \
     test/primitives/hashmap.cpp \
     test/primitives/head.cpp \
-    test/primitives/head2.cpp \
     test/primitives/iterator.cpp \
     test/primitives/linkage.cpp \
     test/primitives/manager.cpp \
@@ -159,10 +159,10 @@ include_bitcoin_database_impl_memory_HEADERS = \
 
 include_bitcoin_database_impl_primitivesdir = ${includedir}/bitcoin/database/impl/primitives
 include_bitcoin_database_impl_primitives_HEADERS = \
+    include/bitcoin/database/impl/primitives/arrayhead.ipp \
     include/bitcoin/database/impl/primitives/arraymap.ipp \
     include/bitcoin/database/impl/primitives/hashmap.ipp \
     include/bitcoin/database/impl/primitives/head.ipp \
-    include/bitcoin/database/impl/primitives/head2.ipp \
     include/bitcoin/database/impl/primitives/iterator.ipp \
     include/bitcoin/database/impl/primitives/linkage.ipp \
     include/bitcoin/database/impl/primitives/manager.ipp \
@@ -206,10 +206,10 @@ include_bitcoin_database_memory_interfaces_HEADERS = \
 
 include_bitcoin_database_primitivesdir = ${includedir}/bitcoin/database/primitives
 include_bitcoin_database_primitives_HEADERS = \
+    include/bitcoin/database/primitives/arrayhead.hpp \
     include/bitcoin/database/primitives/arraymap.hpp \
     include/bitcoin/database/primitives/hashmap.hpp \
     include/bitcoin/database/primitives/head.hpp \
-    include/bitcoin/database/primitives/head2.hpp \
     include/bitcoin/database/primitives/iterator.hpp \
     include/bitcoin/database/primitives/linkage.hpp \
     include/bitcoin/database/primitives/manager.hpp \
diff --git a/builds/cmake/CMakeLists.txt b/builds/cmake/CMakeLists.txt
@@ -284,10 +284,10 @@ if (with-tests)
         "../../test/mocks/chunk_storage.hpp"
         "../../test/mocks/chunk_store.hpp"
         "../../test/mocks/map_store.hpp"
+        "../../test/primitives/arrayhead.cpp"
         "../../test/primitives/arraymap.cpp"
         "../../test/primitives/hashmap.cpp"
         "../../test/primitives/head.cpp"
-        "../../test/primitives/head2.cpp"
         "../../test/primitives/iterator.cpp"
         "../../test/primitives/linkage.cpp"
         "../../test/primitives/manager.cpp"
diff --git a/builds/msvc/vs2022/libbitcoin-database-test/libbitcoin-database-test.vcxproj b/builds/msvc/vs2022/libbitcoin-database-test/libbitcoin-database-test.vcxproj
@@ -85,10 +85,10 @@
       <ObjectFileName>$(IntDir)test_memory_utilities.obj</ObjectFileName>
     </ClCompile>
     <ClCompile Include="..\..\..\..\test\mocks\chunk_storage.cpp" />
+    <ClCompile Include="..\..\..\..\test\primitives\arrayhead.cpp" />
     <ClCompile Include="..\..\..\..\test\primitives\arraymap.cpp" />
     <ClCompile Include="..\..\..\..\test\primitives\hashmap.cpp" />
     <ClCompile Include="..\..\..\..\test\primitives\head.cpp" />
-    <ClCompile Include="..\..\..\..\test\primitives\head2.cpp" />
     <ClCompile Include="..\..\..\..\test\primitives\iterator.cpp" />
     <ClCompile Include="..\..\..\..\test\primitives\linkage.cpp" />
     <ClCompile Include="..\..\..\..\test\primitives\manager.cpp" />
diff --git a/builds/msvc/vs2022/libbitcoin-database-test/libbitcoin-database-test.vcxproj.filters b/builds/msvc/vs2022/libbitcoin-database-test/libbitcoin-database-test.vcxproj.filters
@@ -78,6 +78,9 @@
     <ClCompile Include="..\..\..\..\test\mocks\chunk_storage.cpp">
       <Filter>src\mocks</Filter>
     </ClCompile>
+    <ClCompile Include="..\..\..\..\test\primitives\arrayhead.cpp">
+      <Filter>src\primitives</Filter>
+    </ClCompile>
     <ClCompile Include="..\..\..\..\test\primitives\arraymap.cpp">
       <Filter>src\primitives</Filter>
     </ClCompile>
@@ -87,9 +90,6 @@
     <ClCompile Include="..\..\..\..\test\primitives\head.cpp">
       <Filter>src\primitives</Filter>
     </ClCompile>
-    <ClCompile Include="..\..\..\..\test\primitives\head2.cpp">
-      <Filter>src\primitives</Filter>
-    </ClCompile>
     <ClCompile Include="..\..\..\..\test\primitives\iterator.cpp">
       <Filter>src\primitives</Filter>
     </ClCompile>
diff --git a/builds/msvc/vs2022/libbitcoin-database/libbitcoin-database.vcxproj b/builds/msvc/vs2022/libbitcoin-database/libbitcoin-database.vcxproj
@@ -113,10 +113,10 @@
     <ClInclude Include="..\..\..\..\include\bitcoin\database\memory\simple_writer.hpp" />
     <ClInclude Include="..\..\..\..\include\bitcoin\database\memory\streamers.hpp" />
     <ClInclude Include="..\..\..\..\include\bitcoin\database\memory\utilities.hpp" />
+    <ClInclude Include="..\..\..\..\include\bitcoin\database\primitives\arrayhead.hpp" />
     <ClInclude Include="..\..\..\..\include\bitcoin\database\primitives\arraymap.hpp" />
     <ClInclude Include="..\..\..\..\include\bitcoin\database\primitives\hashmap.hpp" />
     <ClInclude Include="..\..\..\..\include\bitcoin\database\primitives\head.hpp" />
-    <ClInclude Include="..\..\..\..\include\bitcoin\database\primitives\head2.hpp" />
     <ClInclude Include="..\..\..\..\include\bitcoin\database\primitives\iterator.hpp" />
     <ClInclude Include="..\..\..\..\include\bitcoin\database\primitives\linkage.hpp" />
     <ClInclude Include="..\..\..\..\include\bitcoin\database\primitives\manager.hpp" />
@@ -153,10 +153,10 @@
     <None Include="..\..\..\..\include\bitcoin\database\impl\memory\accessor.ipp" />
     <None Include="..\..\..\..\include\bitcoin\database\impl\memory\simple_reader.ipp" />
     <None Include="..\..\..\..\include\bitcoin\database\impl\memory\simple_writer.ipp" />
+    <None Include="..\..\..\..\include\bitcoin\database\impl\primitives\arrayhead.ipp" />
     <None Include="..\..\..\..\include\bitcoin\database\impl\primitives\arraymap.ipp" />
     <None Include="..\..\..\..\include\bitcoin\database\impl\primitives\hashmap.ipp" />
     <None Include="..\..\..\..\include\bitcoin\database\impl\primitives\head.ipp" />
-    <None Include="..\..\..\..\include\bitcoin\database\impl\primitives\head2.ipp" />
     <None Include="..\..\..\..\include\bitcoin\database\impl\primitives\iterator.ipp" />
     <None Include="..\..\..\..\include\bitcoin\database\impl\primitives\linkage.ipp" />
     <None Include="..\..\..\..\include\bitcoin\database\impl\primitives\manager.ipp" />
diff --git a/builds/msvc/vs2022/libbitcoin-database/libbitcoin-database.vcxproj.filters b/builds/msvc/vs2022/libbitcoin-database/libbitcoin-database.vcxproj.filters
@@ -182,6 +182,9 @@
     <ClInclude Include="..\..\..\..\include\bitcoin\database\memory\utilities.hpp">
       <Filter>include\bitcoin\database\memory</Filter>
     </ClInclude>
+    <ClInclude Include="..\..\..\..\include\bitcoin\database\primitives\arrayhead.hpp">
+      <Filter>include\bitcoin\database\primitives</Filter>
+    </ClInclude>
     <ClInclude Include="..\..\..\..\include\bitcoin\database\primitives\arraymap.hpp">
       <Filter>include\bitcoin\database\primitives</Filter>
     </ClInclude>
@@ -191,9 +194,6 @@
     <ClInclude Include="..\..\..\..\include\bitcoin\database\primitives\head.hpp">
       <Filter>include\bitcoin\database\primitives</Filter>
     </ClInclude>
-    <ClInclude Include="..\..\..\..\include\bitcoin\database\primitives\head2.hpp">
-      <Filter>include\bitcoin\database\primitives</Filter>
-    </ClInclude>
     <ClInclude Include="..\..\..\..\include\bitcoin\database\primitives\iterator.hpp">
       <Filter>include\bitcoin\database\primitives</Filter>
     </ClInclude>
@@ -298,6 +298,9 @@
     <None Include="..\..\..\..\include\bitcoin\database\impl\memory\simple_writer.ipp">
       <Filter>include\bitcoin\database\impl\memory</Filter>
     </None>
+    <None Include="..\..\..\..\include\bitcoin\database\impl\primitives\arrayhead.ipp">
+      <Filter>include\bitcoin\database\impl\primitives</Filter>
+    </None>
     <None Include="..\..\..\..\include\bitcoin\database\impl\primitives\arraymap.ipp">
       <Filter>include\bitcoin\database\impl\primitives</Filter>
     </None>
@@ -307,9 +310,6 @@
     <None Include="..\..\..\..\include\bitcoin\database\impl\primitives\head.ipp">
       <Filter>include\bitcoin\database\impl\primitives</Filter>
     </None>
-    <None Include="..\..\..\..\include\bitcoin\database\impl\primitives\head2.ipp">
-      <Filter>include\bitcoin\database\impl\primitives</Filter>
-    </None>
     <None Include="..\..\..\..\include\bitcoin\database\impl\primitives\iterator.ipp">
       <Filter>include\bitcoin\database\impl\primitives</Filter>
     </None>
diff --git a/include/bitcoin/database.hpp b/include/bitcoin/database.hpp
@@ -42,10 +42,10 @@
 #include <bitcoin/database/memory/utilities.hpp>
 #include <bitcoin/database/memory/interfaces/memory.hpp>
 #include <bitcoin/database/memory/interfaces/storage.hpp>
+#include <bitcoin/database/primitives/arrayhead.hpp>
 #include <bitcoin/database/primitives/arraymap.hpp>
 #include <bitcoin/database/primitives/hashmap.hpp>
 #include <bitcoin/database/primitives/head.hpp>
-#include <bitcoin/database/primitives/head2.hpp>
 #include <bitcoin/database/primitives/iterator.hpp>
 #include <bitcoin/database/primitives/linkage.hpp>
 #include <bitcoin/database/primitives/manager.hpp>
diff --git a/include/bitcoin/database/impl/primitives/arrayhead.ipp b/include/bitcoin/database/impl/primitives/arrayhead.ipp
@@ -16,8 +16,8 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-#ifndef LIBBITCOIN_DATABASE_PRIMITIVES_HEAD2_IPP
-#define LIBBITCOIN_DATABASE_PRIMITIVES_HEAD2_IPP
+#ifndef LIBBITCOIN_DATABASE_PRIMITIVES_ARRAYHEAD_IPP
+#define LIBBITCOIN_DATABASE_PRIMITIVES_ARRAYHEAD_IPP
 
 #include <algorithm>
 #include <bitcoin/system.hpp>
@@ -27,7 +27,7 @@ namespace libbitcoin {
 namespace database {
 
 TEMPLATE
-CLASS::head2(storage& head, const Link& buckets) NOEXCEPT
+CLASS::arrayhead(storage& head, const Link& buckets) NOEXCEPT
   : file_(head), initial_buckets_(buckets)
 {
 }
@@ -98,7 +98,7 @@ TEMPLATE
 bool CLASS::get_body_count(Link& count) const NOEXCEPT
 {
     const auto ptr = file_.get();
-    if (!ptr)
+    if (!ptr || Link::size > file_.size())
         return false;
 
     count = array_cast<Link::size>(ptr->data());
@@ -109,7 +109,7 @@ TEMPLATE
 bool CLASS::set_body_count(const Link& count) NOEXCEPT
 {
     const auto ptr = file_.get();
-    if (!ptr)
+    if (!ptr || Link::size > file_.size())
         return false;
 
     array_cast<Link::size>(ptr->data()) = count;
diff --git a/include/bitcoin/database/primitives/arrayhead.hpp b/include/bitcoin/database/primitives/arrayhead.hpp
@@ -16,8 +16,8 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-#ifndef LIBBITCOIN_DATABASE_PRIMITIVES_HEAD2_HPP
-#define LIBBITCOIN_DATABASE_PRIMITIVES_HEAD2_HPP
+#ifndef LIBBITCOIN_DATABASE_PRIMITIVES_ARRAYHEAD_HPP
+#define LIBBITCOIN_DATABASE_PRIMITIVES_ARRAYHEAD_HPP
 
 #include <shared_mutex>
 #include <bitcoin/system.hpp>
@@ -30,15 +30,15 @@ namespace database {
 /// Dynamically expanding array map header.
 /// Less efficient than a fixed-size header.
 template <typename Link, typename Key = size_t>
-class head2
+class arrayhead
 {
 public:
-    DEFAULT_COPY_MOVE_DESTRUCT(head2);
+    DEFAULT_COPY_MOVE_DESTRUCT(arrayhead);
 
     using bytes = typename Link::bytes;
 
-    /// An array head has zero buckets (and cannot call index()).
-    head2(storage& head, const Link& buckets) NOEXCEPT;
+    /// An array head is disabled it if has one or less buckets.
+    arrayhead(storage& head, const Link& buckets) NOEXCEPT;
 
     /// Sizing is dynamic (thread safe).
     size_t size() const NOEXCEPT;
@@ -99,9 +99,9 @@ class head2
 } // namespace libbitcoin
 
 #define TEMPLATE template <typename Link, typename Key>
-#define CLASS head2<Link, Key>
+#define CLASS arrayhead<Link, Key>
 
-#include <bitcoin/database/impl/primitives/head2.ipp>
+#include <bitcoin/database/impl/primitives/arrayhead.ipp>
 
 #undef CLASS
 #undef TEMPLATE
diff --git a/include/bitcoin/database/primitives/arraymap.hpp b/include/bitcoin/database/primitives/arraymap.hpp
@@ -22,7 +22,7 @@
 #include <bitcoin/system.hpp>
 #include <bitcoin/database/define.hpp>
 #include <bitcoin/database/memory/memory.hpp>
-#include <bitcoin/database/primitives/head2.hpp>
+#include <bitcoin/database/primitives/arrayhead.hpp>
 #include <bitcoin/database/primitives/iterator.hpp>
 #include <bitcoin/database/primitives/linkage.hpp>
 #include <bitcoin/database/primitives/manager.hpp>
@@ -120,7 +120,7 @@ class arraymap
 private:
     static constexpr auto is_slab = (Size == max_size_t);
 
-    using head = database::head2<Link>;
+    using head = database::arrayhead<Link>;
     using manager = database::manager<Link, Key, Size>;
 
     // Thread safe (index/top/push).
diff --git a/include/bitcoin/database/primitives/primitives.hpp b/include/bitcoin/database/primitives/primitives.hpp
@@ -19,13 +19,13 @@
 #ifndef LIBBITCOIN_DATABASE_PRIMITIVES_PRIMITIVES_HPP
 #define LIBBITCOIN_DATABASE_PRIMITIVES_PRIMITIVES_HPP
 
-#include <bitcoin/database/primitives/nomap.hpp>
-#include <bitcoin/database/primitives/hashmap.hpp>
+#include <bitcoin/database/primitives/arrayhead.hpp>
 #include <bitcoin/database/primitives/arraymap.hpp>
 #include <bitcoin/database/primitives/head.hpp>
-#include <bitcoin/database/primitives/head2.hpp>
+#include <bitcoin/database/primitives/hashmap.hpp>
 #include <bitcoin/database/primitives/iterator.hpp>
 #include <bitcoin/database/primitives/linkage.hpp>
 #include <bitcoin/database/primitives/manager.hpp>
+#include <bitcoin/database/primitives/nomap.hpp>
 
 #endif
diff --git a/test/primitives/arrayhead.cpp b/test/primitives/arrayhead.cpp
@@ -19,7 +19,7 @@
 #include "../test.hpp"
 #include "../mocks/chunk_storage.hpp"
 
-BOOST_AUTO_TEST_SUITE(head2_tests)
+BOOST_AUTO_TEST_SUITE(arrayhead_tests)
 
 using namespace system;
 
@@ -35,7 +35,7 @@ constexpr auto buckets = sub1(links);
 static_assert(buckets == 20u);
 
 using link = linkage<link_size>;
-using test_header = head2<link, size_t>;
+using test_header = arrayhead<link, size_t>;
 
 class nullptr_storage
   : public test::chunk_storage
@@ -49,7 +49,7 @@ class nullptr_storage
     }
 };
 
-BOOST_AUTO_TEST_CASE(head__create__size__expected)
+BOOST_AUTO_TEST_CASE(arrayhead__create__size__expected)
 {
     data_chunk data;
     test::chunk_storage store{ data };
@@ -58,7 +58,7 @@ BOOST_AUTO_TEST_CASE(head__create__size__expected)
     BOOST_REQUIRE_EQUAL(data.size(), head_size);
 }
 
-BOOST_AUTO_TEST_CASE(head__verify__uncreated__false)
+BOOST_AUTO_TEST_CASE(arrayhead__verify__uncreated__false)
 {
     data_chunk data;
     test::chunk_storage store{ data };
@@ -67,7 +67,7 @@ BOOST_AUTO_TEST_CASE(head__verify__uncreated__false)
     BOOST_REQUIRE(!head.verify());
 }
 
-BOOST_AUTO_TEST_CASE(head__verify__created__false)
+BOOST_AUTO_TEST_CASE(arrayhead__verify__created__false)
 {
     data_chunk data;
     test::chunk_storage store{ data };
@@ -76,7 +76,7 @@ BOOST_AUTO_TEST_CASE(head__verify__created__false)
     BOOST_REQUIRE(head.verify());
 }
 
-BOOST_AUTO_TEST_CASE(head__get_body_count__created__zero)
+BOOST_AUTO_TEST_CASE(arrayhead__get_body_count__created__zero)
 {
     data_chunk data;
     test::chunk_storage store{ data };
@@ -88,7 +88,7 @@ BOOST_AUTO_TEST_CASE(head__get_body_count__created__zero)
     BOOST_REQUIRE_EQUAL(count, zero);
 }
 
-BOOST_AUTO_TEST_CASE(head__set_body_count__get__expected)
+BOOST_AUTO_TEST_CASE(arrayhead__set_body_count__get__expected)
 {
     data_chunk data;
     test::chunk_storage store{ data };
@@ -103,23 +103,23 @@ BOOST_AUTO_TEST_CASE(head__set_body_count__get__expected)
     BOOST_REQUIRE_EQUAL(count, expected);
 }
 
-BOOST_AUTO_TEST_CASE(head__top__link__terminal)
+BOOST_AUTO_TEST_CASE(arrayhead__top__link__terminal)
 {
     test::chunk_storage store;
     test_header head{ store, buckets };
     BOOST_REQUIRE(head.create());
     BOOST_REQUIRE(head.top(9).is_terminal());
 }
 
-BOOST_AUTO_TEST_CASE(head__top__nullptr__terminal)
+BOOST_AUTO_TEST_CASE(arrayhead__top__nullptr__terminal)
 {
     nullptr_storage store;
     test_header head{ store, buckets };
     BOOST_REQUIRE(head.create());
     BOOST_REQUIRE(head.top(9).is_terminal());
 }
 
-BOOST_AUTO_TEST_CASE(head__top__key__terminal)
+BOOST_AUTO_TEST_CASE(arrayhead__top__key__terminal)
 {
     test::chunk_storage store;
     test_header head{ store, buckets };
