quorums_debug.h

Go to the documentation of this file.

// Copyright (c) 2018-2021 The Dash Core developers
// Copyright (c) 2022 The PIVX Core developers
// Distributed under the MIT/X11 software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
#ifndef PIVX_LLMQ_QUORUMS_DEBUG_H
#define PIVX_LLMQ_QUORUMS_DEBUG_H
 
#include "consensus/params.h"
#include "sync.h"
#include "univalue.h"
 
#include <functional>
#include <set>
 
class CDataStream;
class CInv;
class CScheduler;
 
namespace llmq
{
 
class CDKGDebugMemberStatus
{
public:
    union {
        struct
        {
            // is it locally considered as bad (and thus removed from the validMembers set)
            bool bad : 1;
            // did we complain about this member
            bool weComplain : 1;
 
            // received message for DKG phases
            bool receivedContribution : 1;
            bool receivedComplaint : 1;
            bool receivedJustification : 1;
            bool receivedPrematureCommitment : 1;
        };
        uint8_t statusBitset;
    };
 
    std::set<uint16_t> complaintsFromMembers;
 
public:
    CDKGDebugMemberStatus() : statusBitset(0) {}
};
 
class CDKGDebugSessionStatus
{
public:
    Consensus::LLMQType llmqType{Consensus::LLMQ_NONE};
    uint256 quorumHash;
    uint32_t quorumHeight{0};
    uint8_t phase{0};
 
    union {
        struct
        {
            // sent messages for DKG phases
            bool sentContributions : 1;
            bool sentComplaint : 1;
            bool sentJustification : 1;
            bool sentPrematureCommitment : 1;
 
            bool aborted : 1;
        };
        uint8_t statusBitset;
    };
 
    std::vector<CDKGDebugMemberStatus> members;
    bool receivedFinalCommitment{false};
 
public:
    CDKGDebugSessionStatus() : statusBitset(0) {}
 
    UniValue ToJson(int detailLevel) const;
};
 
class CDKGDebugStatus
{
public:
    int64_t nTime{0};
 
    std::map<Consensus::LLMQType, CDKGDebugSessionStatus> sessions;
 
public:
    UniValue ToJson(int detailLevel) const;
};
 
class CDKGDebugManager
{
private:
    RecursiveMutex cs;
    CDKGDebugStatus localStatus;
 
public:
    CDKGDebugManager() = default;
 
    void GetLocalDebugStatus(CDKGDebugStatus& ret);
 
    void ResetLocalSessionStatus(Consensus::LLMQType llmqType);
    void InitLocalSessionStatus(Consensus::LLMQType llmqType, const uint256& quorumHash, int quorumHeight);
 
    void UpdateLocalSessionStatus(Consensus::LLMQType llmqType, std::function<bool(CDKGDebugSessionStatus& status)>&& func);
    void UpdateLocalMemberStatus(Consensus::LLMQType llmqType, size_t memberIdx, std::function<bool(CDKGDebugMemberStatus& status)>&& func);
};
 
extern std::unique_ptr<CDKGDebugManager> quorumDKGDebugManager;
 
} // namespace llmq
 
#endif // PIVX_LLMQ_QUORUMS_DEBUG_H