From 7b83558ce33f3dde33b70c56ef037aafa174c04f Mon Sep 17 00:00:00 2001
From: Arkadiusz Szczepkowicz <arek.szczepkowicz@ng-analytics.com>
Date: Tue, 23 Jul 2024 15:48:43 +0200
Subject: [PATCH] #268: Add comments in the deserializeType method

---
 src/checkpoint/dispatch/dispatch.h      |  4 ++--
 src/checkpoint/dispatch/dispatch.impl.h | 27 ++++++++++++++++---------
 2 files changed, 19 insertions(+), 12 deletions(-)

diff --git a/src/checkpoint/dispatch/dispatch.h b/src/checkpoint/dispatch/dispatch.h
index 706b5d4c..046a5680 100644
--- a/src/checkpoint/dispatch/dispatch.h
+++ b/src/checkpoint/dispatch/dispatch.h
@@ -213,7 +213,7 @@ struct Prefixed {
   /**
    * \brief Unpack \c T from packed byte-buffer \c mem
    *
-   * \param[in] t_buf bytes holding a serialized \c T
+   * \param[in] mem bytes holding a serialized \c T
    * \param[in] check_type the flag to control type validation
    * \param[in] check_mem the flag to control memory validation
    * \param[in] args arguments to the unpacker's constructor
@@ -221,7 +221,7 @@ struct Prefixed {
    * \return a pointer to an unpacked \c T
    */
   template <typename T, typename UnpackerT, typename... Args>
-  static T* unpack(T* t_buf, bool check_type = true, bool check_mem = true, Args&&... args);
+  static T* unpack(T* mem, bool check_type = true, bool check_mem = true, Args&&... args);
 };
 
 template <typename T>
diff --git a/src/checkpoint/dispatch/dispatch.impl.h b/src/checkpoint/dispatch/dispatch.impl.h
index 2367444d..fd514c85 100644
--- a/src/checkpoint/dispatch/dispatch.impl.h
+++ b/src/checkpoint/dispatch/dispatch.impl.h
@@ -303,7 +303,9 @@ packBuffer(T& target, SerialSizeType size, BufferObtainFnType fn) {
 }
 
 template <typename T>
-typename std::enable_if<!std::is_class<T>::value || !vrt::VirtualSerializeTraits<T>::has_virtual_serialize, buffer::ImplReturnType>::type
+typename std::enable_if<
+  !std::is_class<T>::value || !vrt::VirtualSerializeTraits<T>::has_virtual_serialize,
+  buffer::ImplReturnType>::type
 serializeType(T& target, BufferObtainFnType fn) {
   auto len = Standard::size<T, Sizer>(target);
   debug_checkpoint("serializeType: len=%ld\n", len);
@@ -311,8 +313,9 @@ serializeType(T& target, BufferObtainFnType fn) {
 }
 
 template <typename T>
-typename std::enable_if<!std::is_class<T>::value
-  || !vrt::VirtualSerializeTraits<T>::has_virtual_serialize, T*>::type
+typename std::enable_if<
+  !std::is_class<T>::value || !vrt::VirtualSerializeTraits<T>::has_virtual_serialize,
+  T*>::type
 deserializeType(SerialByteType* data, SerialByteType* allocBuf) {
   auto mem = allocBuf ? allocBuf : Standard::allocate<T>();
   auto t_buf = std::unique_ptr<T>(Standard::construct<T>(mem));
@@ -322,7 +325,6 @@ deserializeType(SerialByteType* data, SerialByteType* allocBuf) {
   return traverser;
 }
 
-// TODO: this also needs to be updated
 template <typename T>
 void deserializeType(InPlaceTag, SerialByteType* data, T* t) {
   Standard::unpack<T, UnpackerBuffer<buffer::UserBuffer>>(t, data);
@@ -345,30 +347,35 @@ struct PrefixedType {
 };
 
 template <typename T>
-typename std::enable_if<std::is_class<T>::value && vrt::VirtualSerializeTraits<T>::has_virtual_serialize, buffer::ImplReturnType>::type
+typename std::enable_if<
+  std::is_class<T>::value && vrt::VirtualSerializeTraits<T>::has_virtual_serialize,
+  buffer::ImplReturnType>::type
 serializeType(T& target, BufferObtainFnType fn) {
   auto prefixed = PrefixedType(&target);
-  auto len = Standard::size<PrefixedType<T>, Sizer>(prefixed);
+  auto len = Standard::size<decltype(prefixed), Sizer>(prefixed);
   debug_checkpoint("serializeType: len=%ld\n", len);
-  return packBuffer<PrefixedType<T>>(prefixed, len, fn);
+  return packBuffer<decltype(prefixed)>(prefixed, len, fn);
 }
 
 template <typename T>
-typename std::enable_if<std::is_class<T>::value
-  && vrt::VirtualSerializeTraits<T>::has_virtual_serialize, T*>::type
+typename std::enable_if<
+  std::is_class<T>::value && vrt::VirtualSerializeTraits<T>::has_virtual_serialize,
+  T*>::type
 deserializeType(SerialByteType* data, SerialByteType* allocBuf) {
   using BaseType = vrt::checkpoint_base_type_t<T>;
 
   auto prefix_mem = Standard::allocate<vrt::TypeIdx>();
   auto prefix_buf = std::unique_ptr<vrt::TypeIdx>(Standard::construct<vrt::TypeIdx>(prefix_mem));
+  // Unpack TypeIdx, ignore checks for type and memory used - unpacking will only use a part of the data
   vrt::TypeIdx* prefix =
     Prefixed::unpack<vrt::TypeIdx, UnpackerBuffer<buffer::UserBuffer>>(prefix_buf.get(), false, false, data);
   prefix_buf.release();
 
+  // allocate memory based on the readed TypeIdx
   auto mem = allocBuf ? allocBuf : vrt::objregistry::allocateConcreteType<BaseType>(*prefix);
   auto t_buf = vrt::objregistry::constructConcreteType<BaseType>(*prefix, mem);
   auto prefixed = PrefixedType(t_buf);
-
+  // Unpack PrefixedType, ignore checks for unpacked type and execute checks for memory used
   auto* traverser =
     Prefixed::unpack<decltype(prefixed), UnpackerBuffer<buffer::UserBuffer>>(&prefixed, false, true, data);
   return static_cast<T*>(traverser->target_);