refactor: Rename Checksum to util::XXH3_64

diff --git a/src/CacheEntryReader.hpp b/src/CacheEntryReader.hpp
index f79bca2d1580226366c3d32156989996202167a7..75806b1dc203399f48a8f9ba6d50e6ab76aad305 100644 (file)
--- a/src/CacheEntryReader.hpp
+++ b/src/CacheEntryReader.hpp
@@ -18,10 +18,10 @@
 
 #pragma once
 
-#include "Checksum.hpp"
 #include "Util.hpp"
 
 #include <compression/Decompressor.hpp>
+#include <util/XXH3_64.hpp>
 
 #include <cstdint>
 #include <cstdio>
@@ -93,7 +93,7 @@ public:
 
 private:
   std::unique_ptr<compression::Decompressor> m_decompressor;
-  Checksum m_checksum;
+  util::XXH3_64 m_checksum;
   uint8_t m_magic[4];
   uint8_t m_version;
   compression::Type m_compression_type;

diff --git a/src/CacheEntryWriter.hpp b/src/CacheEntryWriter.hpp
index b0e3a8cada07ed69ba6675f9035659105729b4e9..2f3ae82b5986c2bb7a1915ddacec1d372b9150c6 100644 (file)
--- a/src/CacheEntryWriter.hpp
+++ b/src/CacheEntryWriter.hpp
@@ -18,10 +18,10 @@
 
 #pragma once
 
-#include "Checksum.hpp"
 #include "Util.hpp"
 
 #include <compression/Compressor.hpp>
+#include <util/XXH3_64.hpp>
 
 #include <cstdint>
 #include <cstdio>
@@ -74,7 +74,7 @@ public:
 
 private:
   std::unique_ptr<compression::Compressor> m_compressor;
-  Checksum m_checksum;
+  util::XXH3_64 m_checksum;
 };
 
 template<typename T>

diff --git a/src/Manifest.cpp b/src/Manifest.cpp
index d5e8a3b55f2babc908ed6550543e7965405873e1..a9ab17b1866e7bbea7871094460feb926f2ceb48 100644 (file)
--- a/src/Manifest.cpp
+++ b/src/Manifest.cpp
@@ -21,7 +21,6 @@
 #include "AtomicFile.hpp"
 #include "CacheEntryReader.hpp"
 #include "CacheEntryWriter.hpp"
-#include "Checksum.hpp"
 #include "Config.hpp"
 #include "Context.hpp"
 #include "Digest.hpp"
@@ -32,6 +31,7 @@
 #include "hashutil.hpp"
 
 #include <core/exceptions.hpp>
+#include <util/XXH3_64.hpp>
 
 #include <memory>
 
@@ -150,7 +150,7 @@ template<> struct hash<FileInfo>
   operator()(const FileInfo& file_info) const
   {
     static_assert(sizeof(FileInfo) == 48, "unexpected size"); // No padding.
-    Checksum checksum;
+    util::XXH3_64 checksum;
     checksum.update(&file_info, sizeof(file_info));
     return checksum.digest();
   }

diff --git a/src/core/mainoptions.cpp b/src/core/mainoptions.cpp
index 6d43c0effe375a1b363f3df4f17ad72260641b28..35aa2cc86fe39653fa5a32f4bc7c4c32e2fc998f 100644 (file)
--- a/src/core/mainoptions.cpp
+++ b/src/core/mainoptions.cpp
@@ -18,7 +18,6 @@
 
 #include "mainoptions.hpp"
 
-#include <Checksum.hpp>
 #include <Config.hpp>
 #include <Fd.hpp>
 #include <Hash.hpp>
@@ -35,6 +34,7 @@
 #include <storage/Storage.hpp>
 #include <storage/primary/PrimaryStorage.hpp>
 #include <util/TextTable.hpp>
+#include <util/XXH3_64.hpp>
 #include <util/expected.hpp>
 #include <util/string.hpp>
 
@@ -369,7 +369,7 @@ process_main_options(int argc, const char* const* argv)
       break;
 
     case CHECKSUM_FILE: {
-      Checksum checksum;
+      util::XXH3_64 checksum;
       Fd fd(arg == "-" ? STDIN_FILENO : open(arg.c_str(), O_RDONLY));
       Util::read_fd(*fd, [&checksum](const void* data, size_t size) {
         checksum.update(data, size);

diff --git a/src/storage/Storage.cpp b/src/storage/Storage.cpp
index 7c2d0dff8762979bde25914477650a2c616bd720..50f697bafd08ecbd08dea3998234bd9d136e6b9e 100644 (file)
--- a/src/storage/Storage.cpp
+++ b/src/storage/Storage.cpp
@@ -18,7 +18,6 @@
 
 #include "Storage.hpp"
 
-#include <Checksum.hpp>
 #include <Config.hpp>
 #include <Logging.hpp>
 #include <MiniTrace.hpp>
@@ -35,6 +34,7 @@
 #endif
 #include <util/Timer.hpp>
 #include <util/Tokenizer.hpp>
+#include <util/XXH3_64.hpp>
 #include <util/expected.hpp>
 #include <util/string.hpp>
 
@@ -392,7 +392,7 @@ get_shard_url(const Digest& key,
   double highest_score = -1.0;
   std::string best_shard;
   for (const auto& shard_config : shards) {
-    Checksum checksum;
+    util::XXH3_64 checksum;
     checksum.update(key.bytes(), key.size());
     checksum.update(shard_config.name.data(), shard_config.name.length());
     const double score = to_half_open_unit_interval(checksum.digest());

diff --git a/src/Checksum.hpp b/src/util/XXH3_64.hpp
similarity index 84%
rename from src/Checksum.hpp
rename to src/util/XXH3_64.hpp
index ee8bcc23bc5e322bf13dc1739652afb2940d4f1c..61f0fabebe3c8fb99da5142ee9bfcb2a1be8e785 100644 (file)
--- a/src/Checksum.hpp
+++ b/src/util/XXH3_64.hpp
@@ -26,11 +26,13 @@
 
 #include <cstdint>
 
-class Checksum
+namespace util {
+
+class XXH3_64
 {
 public:
-  Checksum();
-  ~Checksum();
+  XXH3_64();
+  ~XXH3_64();
 
   void reset();
   void update(const void* data, size_t length);
@@ -40,30 +42,32 @@ private:
   XXH3_state_t* m_state;
 };
 
-inline Checksum::Checksum() : m_state(XXH3_createState())
+inline XXH3_64::XXH3_64() : m_state(XXH3_createState())
 {
   reset();
 }
 
-inline Checksum::~Checksum()
+inline XXH3_64::~XXH3_64()
 {
   XXH3_freeState(m_state);
 }
 
 inline void
-Checksum::reset()
+XXH3_64::reset()
 {
   XXH3_64bits_reset(m_state);
 }
 
 inline void
-Checksum::update(const void* data, size_t length)
+XXH3_64::update(const void* data, size_t length)
 {
   XXH3_64bits_update(m_state, data, length);
 }
 
 inline uint64_t
-Checksum::digest() const
+XXH3_64::digest() const
 {
   return XXH3_64bits_digest(m_state);
 }
+
+} // namespace util

diff --git a/unittest/CMakeLists.txt b/unittest/CMakeLists.txt
index f8711a102bf586f9c1c2cac3eb4140b1f845fc48..39d63fd45a4e50607d4399826943eecf1f0fe94c 100644 (file)
--- a/unittest/CMakeLists.txt
+++ b/unittest/CMakeLists.txt
@@ -4,7 +4,6 @@ set(
   main.cpp
   test_Args.cpp
   test_AtomicFile.cpp
-  test_Checksum.cpp
   test_Config.cpp
   test_Depfile.cpp
   test_FormatNonstdStringView.cpp
@@ -26,6 +25,7 @@ set(
   test_storage_primary_util.cpp
   test_util_TextTable.cpp
   test_util_Tokenizer.cpp
+  test_util_XXH3_64.cpp
   test_util_expected.cpp
   test_util_path.cpp
   test_util_string.cpp

diff --git a/unittest/test_Checksum.cpp b/unittest/test_util_XXH3_64.cpp
similarity index 83%
rename from unittest/test_Checksum.cpp
rename to unittest/test_util_XXH3_64.cpp
index 7b3bc869841c9d07df1604e3f7b6909fb5df70ad..744029cccdd063260af550d25058fe185d4747a6 100644 (file)
--- a/unittest/test_Checksum.cpp
+++ b/unittest/test_util_XXH3_64.cpp
@@ -1,4 +1,4 @@
-// Copyright (C) 2011-2020 Joel Rosdahl and other contributors
+// Copyright (C) 2011-2021 Joel Rosdahl and other contributors
 //
 // See doc/AUTHORS.adoc for a complete list of contributors.
 //
@@ -16,15 +16,15 @@
 // this program; if not, write to the Free Software Foundation, Inc., 51
 // Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
-#include "../src/Checksum.hpp"
+#include <util/XXH3_64.hpp>
 
-#include "third_party/doctest.h"
+#include <third_party/doctest.h>
 
-TEST_SUITE_BEGIN("Checksum");
+TEST_SUITE_BEGIN("util::XXH3_64");
 
-TEST_CASE("Checksums")
+TEST_CASE("util::XXH3_64")
 {
-  Checksum checksum;
+  util::XXH3_64 checksum;
   CHECK(checksum.digest() == 0x2d06800538d394c2);
 
   checksum.update("foo", 3);