net: Refactor message parsing (CNetMessage), adds flexibility #14046

  16 | +// base class for format agnostic network messages
  17 | +class NetMessageBase
  18 | +{
  19 | +public:
  20 | +    CDataStream vRecv; // received message data
  21 | +    int64_t nTime;     // time (in microseconds) of message receipt.

---

 754 | +        if (vRecvMsg.empty() || vRecvMsg.back()->complete()) {
 755 | +            vRecvMsg.emplace_back(std::make_shared<CNetMessage>(Params().MessageStart(), SER_NETWORK, INIT_PROTO_VERSION));
 756 | +        }
 757 |  
 758 | -        CNetMessage& msg = vRecvMsg.back();
 759 | +        CNetMessageRef msg = vRecvMsg.back();

---

3014 | +        pfrom->nProcessQueueSize -= msgs.front()->vRecv.size() + CMessageHeader::HEADER_SIZE;
3015 |          pfrom->fPauseRecv = pfrom->nProcessQueueSize > connman->GetReceiveFloodSize();
3016 |          fMoreWork = !pfrom->vProcessMsg.empty();
3017 |      }
3018 | -    CNetMessage& msg(msgs.front());
3019 | +    CNetMessageRef msg(msgs.front());

---

  13 | +/** Maximum length of incoming protocol messages (no message over 4 MB is currently acceptable). */
  14 | +static const unsigned int MAX_PROTOCOL_MESSAGE_LENGTH = 4 * 1000 * 1000;
  15 | +
  16 | +// base class for format agnostic network messages
  17 | +class NetMessageBase
  18 | +{

---

  29 | +    virtual uint32_t getMessageSize() const = 0;           //returns 0 when message has not yet been parsed
  30 | +    virtual uint32_t getMessageSizeWithHeader() const = 0; //return complete message size including header
  31 | +
  32 | +    virtual std::string getCommandName() const = 0; //returns the command name. Returns an empty string when no command name is supported
  33 | +
  34 | +    void SetVersion(int nVersionIn)

---

  38 | +
  39 | +    virtual int read(const char* pch, unsigned int nBytes) = 0; //parse bytes
  40 | +
  41 | +    virtual bool verifyMessageStart() const = 0;
  42 | +    virtual bool verifyHeader() const = 0;
  43 | +    virtual bool verifyChecksum(std::string& error) const = 0;

---

  18 | +{
  19 | +public:
  20 | +    CDataStream vRecv; // received message data
  21 | +    int64_t nTime;     // time (in microseconds) of message receipt.
  22 | +
  23 | +    NetMessageBase(const CMessageHeader::MessageStartChars& pchMessageStartIn, int nTypeIn, int nVersionIn) : vRecv(nTypeIn, nVersionIn)

---

 104 | +    int readHeader(const char* pch, unsigned int nBytes);
 105 | +    int readData(const char* pch, unsigned int nBytes);
 106 | +
 107 | +    bool verifyMessageStart() const;
 108 | +    bool verifyHeader() const;
 109 | +    bool verifyChecksum(std::string& error) const;

---

  65 | +        in_data = false;
  66 | +        nHdrPos = 0;
  67 | +        nDataPos = 0;
  68 | +    }
  69 | +
  70 | +    bool complete() const

---

  72 | +        if (!in_data)
  73 | +            return false;
  74 | +        return (hdr.nMessageSize == nDataPos);
  75 | +    }
  76 | +
  77 | +    uint32_t getMessageSize() const

---

  80 | +            return 0;
  81 | +        }
  82 | +        return hdr.nMessageSize;
  83 | +    }
  84 | +
  85 | +    uint32_t getMessageSizeWithHeader() const

---

  85 | +    uint32_t getMessageSizeWithHeader() const
  86 | +    {
  87 | +        return hdr.nMessageSize + CMessageHeader::HEADER_SIZE;
  88 | +    }
  89 | +
  90 | +    std::string getCommandName() const

---

  92 | +        return hdr.pchCommand;
  93 | +    }
  94 | +
  95 | +    const uint256& GetMessageHash() const;
  96 | +
  97 | +    void SetVersion(int nVersionIn)

---

  98 | +    {
  99 | +        hdrbuf.SetVersion(nVersionIn);
 100 | +        NetMessageBase::SetVersion(nVersionIn);
 101 | +    }
 102 | +
 103 | +    int read(const char* pch, unsigned int nBytes);

---

 107 | +    bool verifyMessageStart() const;
 108 | +    bool verifyHeader() const;
 109 | +    bool verifyChecksum(std::string& error) const;
 110 | +};
 111 | +
 112 | +typedef std::shared_ptr<NetMessageBase> NetMessageBaseRef;

---

 108 | +    bool verifyHeader() const;
 109 | +    bool verifyChecksum(std::string& error) const;
 110 | +};
 111 | +
 112 | +typedef std::shared_ptr<NetMessageBase> NetMessageBaseRef;
 113 | +typedef std::shared_ptr<NetMessage> NetMessageRef;

---

 574 | +    CDataStream vRecv; // received message data
 575 | +    int64_t nTime;     // time (in microseconds) of message receipt.
 576 | +
 577 | +    NetMessageBase(int nTypeIn, int nVersionIn) : vRecv(nTypeIn, nVersionIn)
 578 | +    {
 579 | +        nTime = 0;

---

 632 | @@ -681,6 +633,7 @@ class CNode
 633 |  
 634 |      mapMsgCmdSize mapSendBytesPerMsgCmd;
 635 |      mapMsgCmdSize mapRecvBytesPerMsgCmd;
 636 | +    void RecordRecvBytesPerMsgCmd(const std::string& cmd, uint32_t bytes);

---

  82 | +        return hdr.nMessageSize;
  83 | +    }
  84 | +
  85 | +    uint32_t GetMessageSizeWithHeader() const override
  86 | +    {
  87 | +        return hdr.nMessageSize + CMessageHeader::HEADER_SIZE;

---

  73 | +    return data_hash;
  74 | +}
  75 | +
  76 | +bool NetMessage::VerifyMessageStart() const
  77 | +{
  78 | +    return memcmp(hdr.pchMessageStart, Params().MessageStart(), CMessageHeader::MESSAGE_START_SIZE) == 0 ? true : false;

---

  56 | +    if (vRecv.size() < nDataPos + nCopy) {
  57 | +        // Allocate up to 256 KiB ahead, but never more than the total message size.
  58 | +        vRecv.resize(std::min(hdr.nMessageSize, nDataPos + nCopy + 256 * 1024));
  59 | +    }
  60 | +
  61 | +    hasher.Write((const unsigned char*)pch, nCopy);

---

 579 | +        nTime = 0;
 580 | +    }
 581 | +    virtual ~NetMessageBase() {}
 582 |  
 583 | +    virtual bool Complete() const = 0;
 584 | +    virtual uint32_t GetMessageSize() const = 0;           //returns 0 when message has not yet been parsed

---

1305 | @@ -1372,9 +1306,9 @@ void CConnman::ThreadSocketHandler()
1306 |                          size_t nSizeAdded = 0;
1307 |                          auto it(pnode->vRecvMsg.begin());
1308 |                          for (; it != pnode->vRecvMsg.end(); ++it) {
1309 | -                            if (!it->complete())
1310 | +                            if (!it->get()->Complete())

---

  16 | +// base class for format agnostic network messages
  17 | +class NetMessageBase
  18 | +{
  19 | +public:
  20 | +    CDataStream vRecv; // received message data
  21 | +    int64_t nTime;     // time (in microseconds) of message receipt.

---

  18 | +}
  19 | +
  20 | +int NetMessage::ReadHeader(const char* pch, unsigned int nBytes)
  21 | +{
  22 | +    // copy data to temporary parsing buffer
  23 | +    unsigned int nRemaining = 24 - nHdrPos;

---

  42 | +    virtual bool VerifyMessageStart() const = 0;
  43 | +    virtual bool VerifyHeader() const = 0;
  44 | +    virtual bool VerifyChecksum(std::string& error) const = 0;
  45 | +};
  46 | +
  47 | +//basic network message for the currently used unencryted p2p communication

---