From 251716d8549140040c519c4b45936b8430140288 Mon Sep 17 00:00:00 2001
From: Joel Rosdahl <joel@rosdahl.net>
Date: Tue, 19 Oct 2021 20:38:54 +0200
Subject: [PATCH] enhance: Add util::XXH3_128

---
 src/util/XXH3_128.hpp           | 124 ++++++++++++++++++++++++++++++++
 unittest/CMakeLists.txt         |   1 +
 unittest/test_util_XXH3_128.cpp |  48 +++++++++++++
 3 files changed, 173 insertions(+)
 create mode 100644 src/util/XXH3_128.hpp
 create mode 100644 unittest/test_util_XXH3_128.cpp

diff --git a/src/util/XXH3_128.hpp b/src/util/XXH3_128.hpp
new file mode 100644
index 000000000..e7edbb3f6
--- /dev/null
+++ b/src/util/XXH3_128.hpp
@@ -0,0 +1,124 @@
+// Copyright (C) 2021 Joel Rosdahl and other contributors
+//
+// See doc/AUTHORS.adoc for a complete list of contributors.
+//
+// This program is free software; you can redistribute it and/or modify it
+// under the terms of the GNU General Public License as published by the Free
+// Software Foundation; either version 3 of the License, or (at your option)
+// any later version.
+//
+// This program is distributed in the hope that it will be useful, but WITHOUT
+// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+// FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+// more details.
+//
+// You should have received a copy of the GNU General Public License along with
+// this program; if not, write to the Free Software Foundation, Inc., 51
+// Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+#pragma once
+
+#ifdef USE_XXH_DISPATCH
+#  include "third_party/xxh_x86dispatch.h"
+#else
+#  include "third_party/xxhash.h"
+#endif
+
+#include <Util.hpp>
+
+#include <cstdint>
+#include <cstring>
+
+namespace util {
+
+class XXH3_128
+{
+public:
+  struct Digest
+  {
+  public:
+    const uint8_t* bytes() const;
+    uint8_t* bytes();
+    constexpr static size_t size();
+
+    bool operator==(const Digest& other) const;
+    bool operator!=(const Digest& other) const;
+
+  private:
+    uint8_t m_bytes[16] = {};
+  };
+
+  XXH3_128();
+  ~XXH3_128();
+
+  void reset();
+  void update(const void* data, size_t length);
+  Digest digest() const;
+
+private:
+  XXH3_state_t* m_state;
+};
+
+inline const uint8_t*
+XXH3_128::Digest::bytes() const
+{
+  return m_bytes;
+}
+
+inline uint8_t*
+XXH3_128::Digest::bytes()
+{
+  return m_bytes;
+}
+
+inline constexpr size_t
+XXH3_128::Digest::size()
+{
+  return sizeof(m_bytes);
+}
+
+inline bool
+XXH3_128::Digest::operator==(const XXH3_128::Digest& other) const
+{
+  return memcmp(bytes(), other.bytes(), size()) == 0;
+}
+
+inline bool
+XXH3_128::Digest::operator!=(const XXH3_128::Digest& other) const
+{
+  return !(*this == other);
+}
+
+inline XXH3_128::XXH3_128() : m_state(XXH3_createState())
+{
+  reset();
+}
+
+inline XXH3_128::~XXH3_128()
+{
+  XXH3_freeState(m_state);
+}
+
+inline void
+XXH3_128::reset()
+{
+  XXH3_128bits_reset(m_state);
+}
+
+inline void
+XXH3_128::update(const void* data, size_t length)
+{
+  XXH3_128bits_update(m_state, data, length);
+}
+
+inline XXH3_128::Digest
+XXH3_128::digest() const
+{
+  const auto result = XXH3_128bits_digest(m_state);
+  XXH3_128::Digest digest;
+  Util::int_to_big_endian(result.high64, digest.bytes());
+  Util::int_to_big_endian(result.low64, digest.bytes() + 8);
+  return digest;
+}
+
+} // namespace util
diff --git a/unittest/CMakeLists.txt b/unittest/CMakeLists.txt
index 39d63fd45..06d137046 100644
--- a/unittest/CMakeLists.txt
+++ b/unittest/CMakeLists.txt
@@ -25,6 +25,7 @@ set(
   test_storage_primary_util.cpp
   test_util_TextTable.cpp
   test_util_Tokenizer.cpp
+  test_util_XXH3_128.cpp
   test_util_XXH3_64.cpp
   test_util_expected.cpp
   test_util_path.cpp
diff --git a/unittest/test_util_XXH3_128.cpp b/unittest/test_util_XXH3_128.cpp
new file mode 100644
index 000000000..3845fc582
--- /dev/null
+++ b/unittest/test_util_XXH3_128.cpp
@@ -0,0 +1,48 @@
+// Copyright (C) 2011-2021 Joel Rosdahl and other contributors
+//
+// See doc/AUTHORS.adoc for a complete list of contributors.
+//
+// This program is free software; you can redistribute it and/or modify it
+// under the terms of the GNU General Public License as published by the Free
+// Software Foundation; either version 3 of the License, or (at your option)
+// any later version.
+//
+// This program is distributed in the hope that it will be useful, but WITHOUT
+// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+// FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+// more details.
+//
+// You should have received a copy of the GNU General Public License along with
+// this program; if not, write to the Free Software Foundation, Inc., 51
+// Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+#include <util/XXH3_128.hpp>
+
+#include <third_party/doctest.h>
+
+TEST_SUITE_BEGIN("util::XXH3_128");
+
+TEST_CASE("util::XXH3_128")
+{
+  util::XXH3_128 checksum;
+  auto digest = checksum.digest();
+  CHECK(Util::format_base16(digest.bytes(), 16)
+        == "99aa06d3014798d86001c324468d497f");
+
+  checksum.update("foo", 3);
+  digest = checksum.digest();
+  CHECK(Util::format_base16(digest.bytes(), 16)
+        == "79aef92e83454121ab6e5f64077e7d8a");
+
+  checksum.update("t", 1);
+  digest = checksum.digest();
+  CHECK(Util::format_base16(digest.bytes(), 16)
+        == "e6045075b5bf1ae7a3e4c87775e6c97f");
+
+  checksum.reset();
+  digest = checksum.digest();
+  CHECK(Util::format_base16(digest.bytes(), 16)
+        == "99aa06d3014798d86001c324468d497f");
+}
+
+TEST_SUITE_END();
-- 
2.47.2