Skip to content

refactor: replace CDeterministicMNStateDiff macros with boost::hana #6636

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
PastaPastaPasta merged 1 commit into from
Apr 22, 2025
Merged

refactor: replace CDeterministicMNStateDiff macros with boost::hana #6636

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 67 additions & 37 deletions src/evo/dmnstate.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@
#include <memory>
#include <utility>

#include <boost/hana/for_each.hpp>
#include <boost/hana/tuple.hpp>

class CProRegTx;
class UniValue;

Expand Down Expand Up @@ -173,26 +176,38 @@ class CDeterministicMNStateDiff
Field_nVersion = 0x40000,
};

#define DMN_STATE_DIFF_ALL_FIELDS \
DMN_STATE_DIFF_LINE(nRegisteredHeight) \
DMN_STATE_DIFF_LINE(nLastPaidHeight) \
DMN_STATE_DIFF_LINE(nPoSePenalty) \
DMN_STATE_DIFF_LINE(nPoSeRevivedHeight) \
DMN_STATE_DIFF_LINE(nPoSeBanHeight) \
DMN_STATE_DIFF_LINE(nRevocationReason) \
DMN_STATE_DIFF_LINE(confirmedHash) \
DMN_STATE_DIFF_LINE(confirmedHashWithProRegTxHash) \
DMN_STATE_DIFF_LINE(keyIDOwner) \
DMN_STATE_DIFF_LINE(pubKeyOperator) \
DMN_STATE_DIFF_LINE(keyIDVoting) \
DMN_STATE_DIFF_LINE(addr) \
DMN_STATE_DIFF_LINE(scriptPayout) \
DMN_STATE_DIFF_LINE(scriptOperatorPayout) \
DMN_STATE_DIFF_LINE(nConsecutivePayments) \
DMN_STATE_DIFF_LINE(platformNodeID) \
DMN_STATE_DIFF_LINE(platformP2PPort) \
DMN_STATE_DIFF_LINE(platformHTTPPort) \
DMN_STATE_DIFF_LINE(nVersion)
private:
template <auto CDeterministicMNState::*Field, uint32_t Mask>
struct Member
{
static constexpr uint32_t mask = Mask;
static auto& get(CDeterministicMNState& state) { return state.*Field; }
static const auto& get(const CDeterministicMNState& state) { return state.*Field; }
};

#define DMN_STATE_MEMBER(name) Member<&CDeterministicMNState::name, Field_##name>{}
static constexpr auto members = boost::hana::make_tuple(
DMN_STATE_MEMBER(nRegisteredHeight),
DMN_STATE_MEMBER(nLastPaidHeight),
DMN_STATE_MEMBER(nPoSePenalty),
DMN_STATE_MEMBER(nPoSeRevivedHeight),
DMN_STATE_MEMBER(nPoSeBanHeight),
DMN_STATE_MEMBER(nRevocationReason),
DMN_STATE_MEMBER(confirmedHash),
DMN_STATE_MEMBER(confirmedHashWithProRegTxHash),
DMN_STATE_MEMBER(keyIDOwner),
DMN_STATE_MEMBER(pubKeyOperator),
DMN_STATE_MEMBER(keyIDVoting),
DMN_STATE_MEMBER(addr),
DMN_STATE_MEMBER(scriptPayout),
DMN_STATE_MEMBER(scriptOperatorPayout),
DMN_STATE_MEMBER(nConsecutivePayments),
DMN_STATE_MEMBER(platformNodeID),
DMN_STATE_MEMBER(platformP2PPort),
DMN_STATE_MEMBER(platformHTTPPort),
DMN_STATE_MEMBER(nVersion)
);
#undef DMN_STATE_MEMBER

public:
uint32_t fields{0};
Expand All @@ -203,27 +218,41 @@ class CDeterministicMNStateDiff
CDeterministicMNStateDiff() = default;
CDeterministicMNStateDiff(const CDeterministicMNState& a, const CDeterministicMNState& b)
{
#define DMN_STATE_DIFF_LINE(f) if (a.f != b.f) { state.f = b.f; fields |= Field_##f; }
DMN_STATE_DIFF_ALL_FIELDS
#undef DMN_STATE_DIFF_LINE
if (fields & Field_pubKeyOperator) { state.nVersion = b.nVersion; fields |= Field_nVersion; }
boost::hana::for_each(members, [&](auto&& member) {
if (member.get(a) != member.get(b)) {
member.get(state) = member.get(b);
fields |= member.mask;
}
});
if (fields & Field_pubKeyOperator) {
// pubKeyOperator needs nVersion
state.nVersion = b.nVersion;
fields |= Field_nVersion;
}
}

[[nodiscard]] UniValue ToJson(MnType nType) const;

SERIALIZE_METHODS(CDeterministicMNStateDiff, obj)
{
READWRITE(VARINT(obj.fields));

// NOTE: reading pubKeyOperator requires nVersion
bool read_pubkey{false};
READWRITE(VARINT(obj.fields));
#define DMN_STATE_DIFF_LINE(f) \
if (strcmp(#f, "pubKeyOperator") == 0 && (obj.fields & Field_pubKeyOperator)) {\
SER_READ(obj, read_pubkey = true); \
READWRITE(CBLSLazyPublicKeyVersionWrapper(const_cast<CBLSLazyPublicKey&>(obj.state.pubKeyOperator), obj.state.nVersion == ProTxVersion::LegacyBLS)); \
} else if (obj.fields & Field_##f) READWRITE(obj.state.f);

DMN_STATE_DIFF_ALL_FIELDS
#undef DMN_STATE_DIFF_LINE
boost::hana::for_each(members, [&](auto&& member) {
using BaseType = std::decay_t<decltype(member)>;
if constexpr (BaseType::mask == Field_pubKeyOperator) {
if (obj.fields & member.mask) {
SER_READ(obj, read_pubkey = true);
READWRITE(CBLSLazyPublicKeyVersionWrapper(const_cast<CBLSLazyPublicKey&>(obj.state.pubKeyOperator), obj.state.nVersion == ProTxVersion::LegacyBLS));
}
} else {
if (obj.fields & member.mask) {
Copy link
Copy Markdown
Collaborator

@knst knst Apr 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like conditions in implementation are changed after refactoring:

A = is pubKeyOperator
B = obj.fields & pubkeyOperator
C = obj.fields & mask

if ((!A || !B) && C) is changed to if (!A && C)

It seems as this change is valid. Let's simplify code furthermore:

if (obj.fields & member.mask) {
    if constexpr (BaseType::mask == Field_pubKeyOperator) {
        SER_READ(obj, read_pubkey = true);
        READWRITE(CBLSLazyPublicKeyVersionWrapper(const_cast<CBLSLazyPublicKey&>(obj.state.pubKeyOperator), obj.state.nVersion == CProRegTx::LEGACY_BLS_VERSION));
    } else {
        READWRITE(member.get(obj.state));
    }
}

Copy link
Copy Markdown
Collaborator Author

@kwvg kwvg Apr 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would this simplification retain the compile-time nature of the constexpr evaluation? From what I understand, attempting a constexpr evaluation within a non-constexpr evaluation will downgrade the compile-time evaluation to runtime.

READWRITE(member.get(obj.state));
}
}
});

if (read_pubkey) {
SER_READ(obj, obj.fields |= Field_nVersion);
SER_READ(obj, obj.state.pubKeyOperator.SetLegacy(obj.state.nVersion == ProTxVersion::LegacyBLS));
Expand All @@ -232,11 +261,12 @@ class CDeterministicMNStateDiff

void ApplyToState(CDeterministicMNState& target) const
{
#define DMN_STATE_DIFF_LINE(f) if (fields & Field_##f) target.f = state.f;
DMN_STATE_DIFF_ALL_FIELDS
#undef DMN_STATE_DIFF_LINE
boost::hana::for_each(members, [&](auto&& member) {
if (fields & member.mask) {
member.get(target) = member.get(state);
}
});
}
};


#endif // BITCOIN_EVO_DMNSTATE_H
2 changes: 2 additions & 0 deletions test/lint/lint-includes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@
"src/crypto/x11/"]

EXPECTED_BOOST_INCLUDES = ["boost/date_time/posix_time/posix_time.hpp",
"boost/hana/for_each.hpp",
"boost/hana/tuple.hpp",
"boost/multi_index/hashed_index.hpp",
"boost/multi_index/identity.hpp",
"boost/multi_index/indexed_by.hpp",
Expand Down
Loading