From bd3e5bedbbcf1132d230ac24f108457670e945e0 Mon Sep 17 00:00:00 2001 From: Dominik Charousset Date: Sat, 6 Jan 2024 13:48:14 +0100 Subject: [PATCH] Integrate review feedback --- src/OpaqueVal.h | 23 ++++++++++++----------- src/broker/Data.h | 10 +++++----- src/broker/Store.h | 2 +- src/file_analysis/analyzer/x509/X509.h | 2 +- src/logging/Manager.cc | 2 +- src/probabilistic/BloomFilter.h | 4 ++-- src/probabilistic/Topk.h | 2 +- 7 files changed, 23 insertions(+), 22 deletions(-) diff --git a/src/OpaqueVal.h b/src/OpaqueVal.h index 34b1556b0e..b6f8e23411 100644 --- a/src/OpaqueVal.h +++ b/src/OpaqueVal.h @@ -94,7 +94,7 @@ private: /** * Legacy macro to insert into an OpaqueVal-derived class's declaration. Overrides the "old" serialization methods * DoSerialize and DoUnserialize. - * @deprecated Use DECLARE_OPAQUE_VALUE_V2 instead. + * @deprecated Use DECLARE_OPAQUE_VALUE_DATA instead. */ #define DECLARE_OPAQUE_VALUE(T) \ friend class zeek::OpaqueMgr::Register; \ @@ -108,7 +108,7 @@ private: * Macro to insert into an OpaqueVal-derived class's declaration. Overrides the "new" serialization methods * DoSerializeData and DoUnserializeData. */ -#define DECLARE_OPAQUE_VALUE_V2(T) \ +#define DECLARE_OPAQUE_VALUE_DATA(T) \ friend class zeek::OpaqueMgr::Register; \ friend zeek::IntrusivePtr zeek::make_intrusive(); \ std::optional DoSerializeData() const override; \ @@ -138,7 +138,7 @@ public: * @return the broker representation, or an error if serialization * isn't supported or failed. */ - [[deprecated("use SerializeData instead")]] broker::expected Serialize() const; + [[deprecated("Remove in v7.1: use SerializeData instead")]] broker::expected Serialize() const; /** * @copydoc Serialize @@ -151,7 +151,8 @@ public: * @param data Broker representation as returned by *Serialize()*. * @return unserialized instances with reference count at +1 */ - [[deprecated("use UnserializeData instead")]] static OpaqueValPtr Unserialize(const broker::data& data); + [[deprecated("Remove in v7.1: use UnserializeData instead")]] static OpaqueValPtr Unserialize( + const broker::data& data); /** * @copydoc Unserialize @@ -289,7 +290,7 @@ protected: bool DoFeed(const void* data, size_t size) override; StringValPtr DoGet() override; - DECLARE_OPAQUE_VALUE_V2(MD5Val) + DECLARE_OPAQUE_VALUE_DATA(MD5Val) private: StatePtr ctx = nullptr; }; @@ -317,7 +318,7 @@ protected: bool DoFeed(const void* data, size_t size) override; StringValPtr DoGet() override; - DECLARE_OPAQUE_VALUE_V2(SHA1Val) + DECLARE_OPAQUE_VALUE_DATA(SHA1Val) private: StatePtr ctx = nullptr; }; @@ -345,7 +346,7 @@ protected: bool DoFeed(const void* data, size_t size) override; StringValPtr DoGet() override; - DECLARE_OPAQUE_VALUE_V2(SHA256Val) + DECLARE_OPAQUE_VALUE_DATA(SHA256Val) private: StatePtr ctx = nullptr; }; @@ -360,7 +361,7 @@ public: protected: friend class Val; - DECLARE_OPAQUE_VALUE_V2(EntropyVal) + DECLARE_OPAQUE_VALUE_DATA(EntropyVal) private: detail::RandTest state; }; @@ -390,7 +391,7 @@ protected: friend class Val; BloomFilterVal(); - DECLARE_OPAQUE_VALUE_V2(BloomFilterVal) + DECLARE_OPAQUE_VALUE_DATA(BloomFilterVal) private: // Disable. BloomFilterVal(const BloomFilterVal&); @@ -419,7 +420,7 @@ public: protected: CardinalityVal(); - DECLARE_OPAQUE_VALUE_V2(CardinalityVal) + DECLARE_OPAQUE_VALUE_DATA(CardinalityVal) private: TypePtr type; detail::CompositeHash* hash; @@ -436,7 +437,7 @@ public: protected: ParaglobVal() : OpaqueVal(paraglob_type) {} - DECLARE_OPAQUE_VALUE_V2(ParaglobVal) + DECLARE_OPAQUE_VALUE_DATA(ParaglobVal) private: std::unique_ptr internal_paraglob; diff --git a/src/broker/Data.h b/src/broker/Data.h index 091d65354b..e92c75ab85 100644 --- a/src/broker/Data.h +++ b/src/broker/Data.h @@ -125,7 +125,7 @@ public: protected: DataVal() : OpaqueVal(opaque_of_data_type) {} - DECLARE_OPAQUE_VALUE_V2(zeek::Broker::detail::DataVal) + DECLARE_OPAQUE_VALUE_DATA(zeek::Broker::detail::DataVal) }; /** @@ -222,7 +222,7 @@ public: protected: SetIterator() : zeek::OpaqueVal(opaque_of_set_iterator) {} - DECLARE_OPAQUE_VALUE_V2(zeek::Broker::detail::SetIterator) + DECLARE_OPAQUE_VALUE_DATA(zeek::Broker::detail::SetIterator) }; class TableIterator : public zeek::OpaqueVal { @@ -238,7 +238,7 @@ public: protected: TableIterator() : zeek::OpaqueVal(opaque_of_table_iterator) {} - DECLARE_OPAQUE_VALUE_V2(zeek::Broker::detail::TableIterator) + DECLARE_OPAQUE_VALUE_DATA(zeek::Broker::detail::TableIterator) }; class VectorIterator : public zeek::OpaqueVal { @@ -254,7 +254,7 @@ public: protected: VectorIterator() : zeek::OpaqueVal(opaque_of_vector_iterator) {} - DECLARE_OPAQUE_VALUE_V2(zeek::Broker::detail::VectorIterator) + DECLARE_OPAQUE_VALUE_DATA(zeek::Broker::detail::VectorIterator) }; class RecordIterator : public zeek::OpaqueVal { @@ -270,7 +270,7 @@ public: protected: RecordIterator() : zeek::OpaqueVal(opaque_of_record_iterator) {} - DECLARE_OPAQUE_VALUE_V2(zeek::Broker::detail::RecordIterator) + DECLARE_OPAQUE_VALUE_DATA(zeek::Broker::detail::RecordIterator) }; } // namespace zeek::Broker::detail diff --git a/src/broker/Store.h b/src/broker/Store.h index 6558611573..db5333d3c9 100644 --- a/src/broker/Store.h +++ b/src/broker/Store.h @@ -127,7 +127,7 @@ public: protected: IntrusivePtr DoClone(CloneState* state) override { return {NewRef{}, this}; } - DECLARE_OPAQUE_VALUE_V2(StoreHandleVal) + DECLARE_OPAQUE_VALUE_DATA(StoreHandleVal) }; // Helper function to construct a broker backend type from script land. diff --git a/src/file_analysis/analyzer/x509/X509.h b/src/file_analysis/analyzer/x509/X509.h index c1e41b8be5..4295f68790 100644 --- a/src/file_analysis/analyzer/x509/X509.h +++ b/src/file_analysis/analyzer/x509/X509.h @@ -184,7 +184,7 @@ protected: */ X509Val(); - DECLARE_OPAQUE_VALUE_V2(X509Val) + DECLARE_OPAQUE_VALUE_DATA(X509Val) private: ::X509* certificate; // the wrapped certificate }; diff --git a/src/logging/Manager.cc b/src/logging/Manager.cc index 19248b91d1..e79cdaf09f 100644 --- a/src/logging/Manager.cc +++ b/src/logging/Manager.cc @@ -56,7 +56,7 @@ public: protected: explicit LogDelayTokenVal() : LogDelayTokenVal(0) {} - DECLARE_OPAQUE_VALUE_V2(LogDelayTokenVal) + DECLARE_OPAQUE_VALUE_DATA(LogDelayTokenVal) private: DelayTokenType token; diff --git a/src/probabilistic/BloomFilter.h b/src/probabilistic/BloomFilter.h index 50b23eec2f..b3cfb34eb6 100644 --- a/src/probabilistic/BloomFilter.h +++ b/src/probabilistic/BloomFilter.h @@ -105,8 +105,8 @@ public: */ virtual std::string InternalState() const = 0; - [[deprecated("use SerializeData instead")]] broker::expected Serialize() const; - [[deprecated("use UnserializeData instead")]] static std::unique_ptr Unserialize( + [[deprecated("Remove in v7.1: use SerializeData instead")]] broker::expected Serialize() const; + [[deprecated("Remove in v7.1: use UnserializeData instead")]] static std::unique_ptr Unserialize( const broker::data& data); std::optional SerializeData() const; static std::unique_ptr UnserializeData(BrokerDataView data); diff --git a/src/probabilistic/Topk.h b/src/probabilistic/Topk.h index 925f456f8e..8ea23ee799 100644 --- a/src/probabilistic/Topk.h +++ b/src/probabilistic/Topk.h @@ -132,7 +132,7 @@ public: */ ValPtr DoClone(CloneState* state) override; - DECLARE_OPAQUE_VALUE_V2(TopkVal) + DECLARE_OPAQUE_VALUE_DATA(TopkVal) protected: /**