RootSerializableKeyValueStore.h

Go to the documentation of this file.

// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
// All rights not expressly granted are reserved.
//
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
 
#ifndef ALICEO2_ROOTSERKEYVALUESTORE_H
#define ALICEO2_ROOTSERKEYVALUESTORE_H
 
#include <map>
#include <string>
#include <TClass.h>
#include <Rtypes.h>
#include <typeinfo>
#include <typeindex>
#include <TBufferFile.h>
#include <type_traits>
#include <cstring>
#include <memory>
 
namespace o2
{
namespace utils
{
 
class RootSerializableKeyValueStore
{
 public:
  struct SerializedInfo {
    SerializedInfo() = default;
    SerializedInfo(int N,
                   std::unique_ptr<char> buffer, TClass const* cl, std::string const& s) : N(N), cl(cl), typeinfo_name(s)
    {
      bufferptr = buffer.get();
      buffer.release();
    }
    SerializedInfo(SerializedInfo const& other)
    {
      // we do a deep copy
      N = other.N;
      bufferptr = new char[N];
 
      std::memcpy(bufferptr, other.bufferptr, sizeof(char) * N);
      cl = other.cl;
      typeinfo_name = other.typeinfo_name;
    }
    SerializedInfo& operator=(SerializedInfo const& other)
    {
      SerializedInfo temp(other);
      std::swap(*this, temp);
      return *this;
    }
    ~SerializedInfo()
    {
      // we are the owner of this ... so delete it
      delete bufferptr;
    }
 
    void* objptr = nullptr; 
    Int_t N = 0;
    char* bufferptr = nullptr; //[N]  pointer to serialized buffer
 
    // we use the TClass and/or the type_index_hash for type idendification
    TClass const* cl = nullptr;
    std::string typeinfo_name; // typeinfo name that can be used to store type if TClass not available (for PODs!)
    ClassDefNV(SerializedInfo, 1);
  };
 
  enum class GetState {
    kOK = 0,
    kNOSUCHKEY = 1,
    kWRONGTYPE = 2,
    kNOTCLASS = 3
  };
 
 private:
  static constexpr const char* GetStateString[4] = {
    "ok",
    "no such key",
    "wrong type",
    "no TClass"};
 
 public:
  static const char* getStateString(GetState state)
  {
    return (int)state < 4 ? GetStateString[(int)state] : nullptr;
  };
 
  RootSerializableKeyValueStore() = default;
 
  template <typename T>
  void put(std::string const& key, T const& value)
  {
    remove_entry(key);
    GetState s;
    return put_impl(key, value, s, int{});
  }
 
  template <typename T>
  const T* get(std::string const& key) const
  {
    GetState s;
    return get_impl<T>(key, s, int{});
  }
 
  template <typename T>
  const T* get(std::string const& key, GetState& state) const
  {
    return get_impl<T>(key, state, int{});
  }
 
  template <typename T>
  const T& getRef(std::string const& key, GetState& state) const
  {
    auto ptr = get_impl<T>(key, state, int{});
    if (ptr) {
      return *ptr;
    } else {
      static T t = T();
      // in case of error we return a default object
      return t;
    }
  }
 
  bool has(std::string const& key) const
  {
    return mStore.find(key) != mStore.end();
  }
 
  void clear()
  {
    mStore.clear();
  }
 
  void print(bool includetypeinfo = false) const;
 
  void copyFrom(RootSerializableKeyValueStore const& other)
  {
    mStore.clear();
    mStore = other.mStore;
  }
 
 private:
  std::map<std::string, SerializedInfo> mStore;
 
  // generic implementation for put relying on TClass
  template <typename T>
  void put_impl(std::string const& key, T const& value, GetState& state, ...)
  {
    // make sure we have a TClass for this
    // if there is a TClass, we'll use ROOT serialization to encode into the buffer
    auto ptr = std::make_unique<T>(T{value});
    auto cl = TClass::GetClass(typeid(value));
    if (!cl) {
      state = GetState::kNOTCLASS;
      return;
    }
    std::unique_ptr<char> bufferptr(nullptr);
    TBufferFile buff(TBuffer::kWrite);
    buff.WriteObjectAny(ptr.get(), cl);
    int N = buff.Length();
    bufferptr.reset(new char[N]);
    memcpy(bufferptr.get(), buff.Buffer(), sizeof(char) * N);
 
    auto name = std::type_index(typeid(value)).name();
    mStore.insert(std::pair<std::string, SerializedInfo>(key, SerializedInfo(N, std::move(bufferptr), cl, name)));
  }
 
  // implementation for put for trivial types
  template <typename T, typename std::enable_if<std::is_trivial<T>::value, T>::type* = nullptr>
  void put_impl(std::string const& key, T const& value, GetState& state, int)
  {
    // we forbid pointers
    static_assert(!std::is_pointer<T>::value);
    // serialization of trivial types is easy (not based on ROOT)
    auto ptr = std::make_unique<T>(T{value});
    int N = sizeof(T);
    std::unique_ptr<char> bufferptr(new char[N]);
    memcpy(bufferptr.get(), (char*)ptr.get(), sizeof(char) * N);
 
    auto name = std::type_index(typeid(value)).name();
    mStore.insert(std::pair<std::string, SerializedInfo>(key, SerializedInfo(N, std::move(bufferptr), nullptr, name)));
  }
 
  // generic implementation for get relying on TClass
  template <typename T>
  const T* get_impl(std::string const& key, GetState& state, ...) const
  {
    state = GetState::kOK;
    auto iter = mStore.find(key);
    if (iter != mStore.end()) {
      auto& info = const_cast<SerializedInfo&>(iter->second);
      auto cl = TClass::GetClass(typeid(T));
      if (!cl) {
        state = GetState::kNOTCLASS;
        return nullptr;
      }
      if (info.cl && strcmp(cl->GetName(), info.cl->GetName()) == 0) {
        // if there is a (cached) object pointer ... we return it
        if (info.objptr) {
          return (T*)info.objptr;
        }
        // do this only once and cache instance into info.objptr
        TBufferFile buff(TBuffer::kRead, info.N, info.bufferptr, false, nullptr);
        buff.Reset();
        auto instance = (T*)buff.ReadObjectAny(cl);
        info.objptr = instance;
        return (T*)info.objptr;
      } else {
        state = GetState::kWRONGTYPE;
        return nullptr;
      }
    }
    state = GetState::kNOSUCHKEY;
    return nullptr;
  }
 
  // implementation for standard POD types
  template <typename T, typename std::enable_if<std::is_trivial<T>::value, T>::type* = nullptr>
  const T* get_impl(std::string const& key, GetState& state, int) const
  {
    state = GetState::kOK;
    auto iter = mStore.find(key);
    if (iter != mStore.end()) {
      auto& info = const_cast<SerializedInfo&>(iter->second);
      if (strcmp(std::type_index(typeid(T)).name(), info.typeinfo_name.c_str()) == 0) {
        // if there is a (cached) object pointer ... we return it
        if (info.objptr) {
          return (T*)info.objptr;
        }
        info.objptr = (T*)info.bufferptr;
        return (T*)info.objptr;
      } else {
        state = GetState::kWRONGTYPE;
        return nullptr;
      }
    }
    state = GetState::kNOSUCHKEY;
    return nullptr;
  }
 
  // removes a previous entry
  void remove_entry(std::string const& key)
  {
    auto iter = mStore.find(key);
    if (iter != mStore.end()) {
      mStore.erase(iter);
    }
  }
 
  ClassDefNV(RootSerializableKeyValueStore, 2);
};
 
} // namespace utils
} // namespace o2
 
#endif