From 25cc02431b61097b2adfc2fbc493b648b0300c3b Mon Sep 17 00:00:00 2001 From: Mason Reed Date: Mon, 10 Mar 2025 11:05:40 -0400 Subject: [SharedCache] Refactor Shared Cache In absence of a better name, this commit refactors the shared cache code. --- view/sharedcache/core/MetadataSerializable.hpp | 254 ------------------------- 1 file changed, 254 deletions(-) delete mode 100644 view/sharedcache/core/MetadataSerializable.hpp (limited to 'view/sharedcache/core/MetadataSerializable.hpp') diff --git a/view/sharedcache/core/MetadataSerializable.hpp b/view/sharedcache/core/MetadataSerializable.hpp deleted file mode 100644 index 24d8c3fd..00000000 --- a/view/sharedcache/core/MetadataSerializable.hpp +++ /dev/null @@ -1,254 +0,0 @@ -// -// Created by kat on 5/31/23. -// - -/* - * Welcome to, this file. - * - * This is a metadata serialization helper. - * - * Have you ever wished turning a complex datastructure into a Metadata object was as easy in C++ as it is in python? - * Do you like macros and templates? - * - * Great news. - * - * Implement these on your `public MetadataSerializable` subclass: - * ``` - class MyClass : public MetadataSerializable { - void Store(SerializationContext& context) const { - MSS(m_someVariable); - MSS(m_someOtherVariable); - } - void Load(DeserializationContext& context) { - MSL(m_someVariable); - MSL(m_someOtherVariable); - } - } - ``` - * Then, you can turn your object into a Metadata object with `AsMetadata()`, and load it back with - `LoadFromMetadata()`. - * - * Serialized fields will be automatically repopulated. - * - * Other ser/deser formats (rapidjson objects, strings) also exist. You can use these to achieve nesting, but probably - avoid that. - * */ - -#ifndef SHAREDCACHE_CORE_METADATASERIALIZABLE_HPP -#define SHAREDCACHE_CORE_METADATASERIALIZABLE_HPP - -#include -#include "binaryninjaapi.h" -#include "rapidjson/document.h" -#include "rapidjson/stringbuffer.h" -#include "rapidjson/prettywriter.h" -#include "../api/sharedcachecore.h" -#include "view/macho/machoview.h" - -using namespace BinaryNinja; - -namespace SharedCacheCore { - -#define MSS(name) context.store(#name, name) -#define MSS_CAST(name, type) context.store(#name, (type) name) -#define MSS_SUBCLASS(name) Serialize(context, #name, name) -#define MSL(name) name = context.load(#name) -#define MSL_CAST(name, storedType, type) name = (type)context.load(#name) - -struct DeserializationContext; - -struct SerializationContext { - rapidjson::StringBuffer buffer; - rapidjson::Writer writer; - - SerializationContext() : buffer(), writer(buffer) { - } - - template - void store(std::string_view x, const T& y) - { - Serialize(*this, x, y); - } -}; - -struct DeserializationContext { - rapidjson::Document doc; - - template - T load(std::string_view x) - { - T value; - Deserialize(*this, x, value); - return value; - } -}; - -template -class MetadataSerializable { -public: - template - std::string AsString(Args&&... args) const { - SerializationContext context; - Store(context, std::forward(args)...); - - return context.buffer.GetString(); - } - - static LoadResult LoadFromString(const std::string& s) { - DeserializationContext context; - [[maybe_unused]] rapidjson::ParseResult result = context.doc.Parse(s.c_str()); - assert(result); - return Derived::Load(context); - } - - static LoadResult LoadFromValue(rapidjson::Value& s) { - DeserializationContext context; - context.doc.CopyFrom(s, context.doc.GetAllocator()); - return Derived::Load(context); - } - - template - Ref AsMetadata(Args&&... args) const { - return new Metadata(AsString(std::forward(args)...)); - } - - template - void Store(SerializationContext& context, Args&&... args) const { - context.writer.StartObject(); - AsDerived().Store(context, std::forward(args)...); - context.writer.EndObject(); - } - -private: - const Derived& AsDerived() const { return static_cast(*this); } - Derived& AsDerived() { return static_cast(*this); } -}; - -// The functions below are not part of the FFI API, but are exported so they can be shared with sharedcacheui. - -SHAREDCACHE_FFI_API void Serialize(SerializationContext& context, std::string_view str); - -template -inline void Serialize(SerializationContext& context, const MetadataSerializable& value) -{ - value.Store(context); -} - -template -inline void Serialize(SerializationContext& context, std::string_view name, const T& value) -{ - Serialize(context, name); - Serialize(context, value); -} - -template -void Serialize(SerializationContext& context, const std::pair& value) -{ - context.writer.StartArray(); - Serialize(context, value.first); - Serialize(context, value.second); - context.writer.EndArray(); -} - -template -void Serialize(SerializationContext& context, const std::map& value) -{ - context.writer.StartArray(); - for (auto& pair : value) - { - Serialize(context, pair); - } - context.writer.EndArray(); -} - -template -void Serialize(SerializationContext& context, const std::unordered_map& value) -{ - context.writer.StartArray(); - for (auto& pair : value) - { - Serialize(context, pair); - } - context.writer.EndArray(); -} - -template -void Serialize(SerializationContext& context, const std::vector& values) -{ - context.writer.StartArray(); - for (const auto& value : values) - { - Serialize(context, value); - } - context.writer.EndArray(); -} - -template -void Serialize(SerializationContext& context, const std::optional& value) -{ - if (value.has_value()) - Serialize(context, *value); - else - context.writer.Null(); -} - -SHAREDCACHE_FFI_API void Serialize(SerializationContext& context, const char*); -SHAREDCACHE_FFI_API void Serialize(SerializationContext& context, bool b); -SHAREDCACHE_FFI_API void Deserialize(DeserializationContext& context, std::string_view name, bool& b); -SHAREDCACHE_FFI_API void Serialize(SerializationContext& context, uint8_t b); -SHAREDCACHE_FFI_API void Deserialize(DeserializationContext& context, std::string_view name, uint8_t& b); -SHAREDCACHE_FFI_API void Serialize(SerializationContext& context, uint16_t b); -SHAREDCACHE_FFI_API void Deserialize(DeserializationContext& context, std::string_view name, uint16_t& b); -SHAREDCACHE_FFI_API void Serialize(SerializationContext& context, uint32_t b); -SHAREDCACHE_FFI_API void Deserialize(DeserializationContext& context, std::string_view name, uint32_t& b); -SHAREDCACHE_FFI_API void Serialize(SerializationContext& context, uint64_t b); -SHAREDCACHE_FFI_API void Deserialize(DeserializationContext& context, std::string_view name, uint64_t& b); -SHAREDCACHE_FFI_API void Serialize(SerializationContext& context, int8_t b); -SHAREDCACHE_FFI_API void Deserialize(DeserializationContext& context, std::string_view name, int8_t& b); -SHAREDCACHE_FFI_API void Serialize(SerializationContext& context, int16_t b); -SHAREDCACHE_FFI_API void Deserialize(DeserializationContext& context, std::string_view name, int16_t& b); -SHAREDCACHE_FFI_API void Serialize(SerializationContext& context, int32_t b); -SHAREDCACHE_FFI_API void Deserialize(DeserializationContext& context, std::string_view name, int32_t& b); -SHAREDCACHE_FFI_API void Serialize(SerializationContext& context, int64_t b); -SHAREDCACHE_FFI_API void Deserialize(DeserializationContext& context, std::string_view name, int64_t& b); -SHAREDCACHE_FFI_API void Serialize(SerializationContext& context, std::string_view b); -SHAREDCACHE_FFI_API void Serialize(SerializationContext& context, const std::pair>& value); -SHAREDCACHE_FFI_API void Deserialize(DeserializationContext& context, std::string_view name, std::string& b); -SHAREDCACHE_FFI_API void Deserialize(DeserializationContext& context, std::string_view name, std::map& b); -SHAREDCACHE_FFI_API void Deserialize(DeserializationContext& context, std::string_view name, std::unordered_map& b); -SHAREDCACHE_FFI_API void Deserialize(DeserializationContext& context, std::string_view name, std::unordered_map& b); -SHAREDCACHE_FFI_API void Deserialize(DeserializationContext& context, std::string_view name, std::unordered_map>& b); -SHAREDCACHE_FFI_API void Deserialize(DeserializationContext& context, std::string_view name, std::unordered_map& b); -SHAREDCACHE_FFI_API void Deserialize(DeserializationContext& context, std::string_view name, std::vector& b); -SHAREDCACHE_FFI_API void Deserialize(DeserializationContext& context, std::string_view name, std::vector>>& b); -SHAREDCACHE_FFI_API void Deserialize(DeserializationContext& context, std::string_view name, std::vector>& b); -SHAREDCACHE_FFI_API void Deserialize(DeserializationContext& context, std::string_view name, std::vector& b); -SHAREDCACHE_FFI_API void Deserialize(DeserializationContext& context, std::string_view name, std::unordered_map& b); -SHAREDCACHE_FFI_API void Deserialize(DeserializationContext& context, std::string_view name, std::vector>>>& b); -SHAREDCACHE_FFI_API void Serialize(SerializationContext&, const mach_header_64& b); -SHAREDCACHE_FFI_API void Deserialize(DeserializationContext&, std::string_view name, mach_header_64& b); -SHAREDCACHE_FFI_API void Serialize(SerializationContext&, const symtab_command& b); -SHAREDCACHE_FFI_API void Deserialize(DeserializationContext&, std::string_view name, symtab_command& b); -SHAREDCACHE_FFI_API void Serialize(SerializationContext&, const dysymtab_command& b); -SHAREDCACHE_FFI_API void Deserialize(DeserializationContext&, std::string_view name, dysymtab_command& b); -SHAREDCACHE_FFI_API void Serialize(SerializationContext&, const dyld_info_command& b); -SHAREDCACHE_FFI_API void Deserialize(DeserializationContext&, std::string_view name, dyld_info_command& b); -SHAREDCACHE_FFI_API void Serialize(SerializationContext&, const routines_command_64& b); -SHAREDCACHE_FFI_API void Deserialize(DeserializationContext&, std::string_view name, routines_command_64& b); -SHAREDCACHE_FFI_API void Serialize(SerializationContext&, const function_starts_command& b); -SHAREDCACHE_FFI_API void Deserialize(DeserializationContext&, std::string_view name, function_starts_command& b); -SHAREDCACHE_FFI_API void Serialize(SerializationContext&, const section_64& b); -SHAREDCACHE_FFI_API void Deserialize(DeserializationContext&, std::string_view name, std::vector& b); -SHAREDCACHE_FFI_API void Serialize(SerializationContext&, const linkedit_data_command& b); -SHAREDCACHE_FFI_API void Deserialize(DeserializationContext&, std::string_view name, linkedit_data_command& b); -SHAREDCACHE_FFI_API void Serialize(SerializationContext&, const segment_command_64& b); -SHAREDCACHE_FFI_API void Deserialize(DeserializationContext&, std::string_view name, segment_command_64& b); -SHAREDCACHE_FFI_API void Deserialize(DeserializationContext&, std::string_view name, std::vector& b); -SHAREDCACHE_FFI_API void Serialize(SerializationContext&, const build_version_command& b); -SHAREDCACHE_FFI_API void Deserialize(DeserializationContext&, std::string_view name, build_version_command& b); -SHAREDCACHE_FFI_API void Serialize(SerializationContext&, const build_tool_version& b); -SHAREDCACHE_FFI_API void Deserialize(DeserializationContext&, std::string_view name, std::vector& b); - -} // namespace SharedCacheCore - -#endif // SHAREDCACHE_METADATASERIALIZABLE_HPP -- cgit v1.3.1