Skip to content

Commit 973c390

Browse files
author
MarcoFalke
committed
Merge bitcoin#24078: net, refactor: Rename CNetMessage::m_command with CNetMessage::m_type
224d878 net, refactor: Drop tautological local variables (Hennadii Stepanov) 3073a99 scripted-diff: Rename CNetMessage::m_command with CNetMessage::m_type (Hennadii Stepanov) Pull request description: bitcoin#18533 (comment): > a message is not a command, but simply a message of some type Continuation of bitcoin#18533 and bitcoin#18937. ACKs for top commit: theStack: Concept and code-review ACK 224d878 shaavan: Code Review ACK 224d878 w0xlt: crACK 224d878 Tree-SHA512: 898cafb44708dae1413fcc1533d809d75878891354f1b5edaaec1287f4921c31adc9330f4d42d82544a39689886bc17fee71ea587f9199fd5cc849d376f82176
2 parents 6d859cb + 224d878 commit 973c390

File tree

4 files changed

+12
-16
lines changed

4 files changed

+12
-16
lines changed

src/net.cpp

+3-3
Original file line numberDiff line numberDiff line change
@@ -657,7 +657,7 @@ bool CNode::ReceiveMsgBytes(Span<const uint8_t> msg_bytes, bool& complete)
657657

658658
// Store received bytes per message command
659659
// to prevent a memory DOS, only allow valid commands
660-
auto i = mapRecvBytesPerMsgCmd.find(msg.m_command);
660+
auto i = mapRecvBytesPerMsgCmd.find(msg.m_type);
661661
if (i == mapRecvBytesPerMsgCmd.end()) {
662662
i = mapRecvBytesPerMsgCmd.find(NET_MESSAGE_COMMAND_OTHER);
663663
}
@@ -747,7 +747,7 @@ CNetMessage V1TransportDeserializer::GetMessage(const std::chrono::microseconds
747747
CNetMessage msg(std::move(vRecv));
748748

749749
// store command string, time, and sizes
750-
msg.m_command = hdr.GetCommand();
750+
msg.m_type = hdr.GetCommand();
751751
msg.m_time = time;
752752
msg.m_message_size = hdr.nMessageSize;
753753
msg.m_raw_message_size = hdr.nMessageSize + CMessageHeader::HEADER_SIZE;
@@ -760,7 +760,7 @@ CNetMessage V1TransportDeserializer::GetMessage(const std::chrono::microseconds
760760
// Check checksum and header command string
761761
if (memcmp(hash.begin(), hdr.pchChecksum, CMessageHeader::CHECKSUM_SIZE) != 0) {
762762
LogPrint(BCLog::NET, "Header error: Wrong checksum (%s, %u bytes), expected %s was %s, peer=%d\n",
763-
SanitizeString(msg.m_command), msg.m_message_size,
763+
SanitizeString(msg.m_type), msg.m_message_size,
764764
HexStr(Span{hash}.first(CMessageHeader::CHECKSUM_SIZE)),
765765
HexStr(hdr.pchChecksum),
766766
m_node_id);

src/net.h

+2-2
Original file line numberDiff line numberDiff line change
@@ -278,15 +278,15 @@ class CNodeStats
278278

279279
/** Transport protocol agnostic message container.
280280
* Ideally it should only contain receive time, payload,
281-
* command and size.
281+
* type and size.
282282
*/
283283
class CNetMessage {
284284
public:
285285
CDataStream m_recv; //!< received message data
286286
std::chrono::microseconds m_time{0}; //!< time of message receipt
287287
uint32_t m_message_size{0}; //!< size of the payload
288288
uint32_t m_raw_message_size{0}; //!< used wire size of the message (including header/checksum)
289-
std::string m_command;
289+
std::string m_type;
290290

291291
CNetMessage(CDataStream&& recv_in) : m_recv(std::move(recv_in)) {}
292292

src/net_processing.cpp

+5-9
Original file line numberDiff line numberDiff line change
@@ -4177,32 +4177,28 @@ bool PeerManagerImpl::ProcessMessages(CNode* pfrom, std::atomic<bool>& interrupt
41774177
pfrom->GetId(),
41784178
pfrom->m_addr_name.c_str(),
41794179
pfrom->ConnectionTypeAsString().c_str(),
4180-
msg.m_command.c_str(),
4180+
msg.m_type.c_str(),
41814181
msg.m_recv.size(),
41824182
msg.m_recv.data()
41834183
);
41844184

41854185
if (gArgs.GetBoolArg("-capturemessages", false)) {
4186-
CaptureMessage(pfrom->addr, msg.m_command, MakeUCharSpan(msg.m_recv), /*is_incoming=*/true);
4186+
CaptureMessage(pfrom->addr, msg.m_type, MakeUCharSpan(msg.m_recv), /*is_incoming=*/true);
41874187
}
41884188

41894189
msg.SetVersion(pfrom->GetCommonVersion());
4190-
const std::string& msg_type = msg.m_command;
4191-
4192-
// Message size
4193-
unsigned int nMessageSize = msg.m_message_size;
41944190

41954191
try {
4196-
ProcessMessage(*pfrom, msg_type, msg.m_recv, msg.m_time, interruptMsgProc);
4192+
ProcessMessage(*pfrom, msg.m_type, msg.m_recv, msg.m_time, interruptMsgProc);
41974193
if (interruptMsgProc) return false;
41984194
{
41994195
LOCK(peer->m_getdata_requests_mutex);
42004196
if (!peer->m_getdata_requests.empty()) fMoreWork = true;
42014197
}
42024198
} catch (const std::exception& e) {
4203-
LogPrint(BCLog::NET, "%s(%s, %u bytes): Exception '%s' (%s) caught\n", __func__, SanitizeString(msg_type), nMessageSize, e.what(), typeid(e).name());
4199+
LogPrint(BCLog::NET, "%s(%s, %u bytes): Exception '%s' (%s) caught\n", __func__, SanitizeString(msg.m_type), msg.m_message_size, e.what(), typeid(e).name());
42044200
} catch (...) {
4205-
LogPrint(BCLog::NET, "%s(%s, %u bytes): Unknown exception caught\n", __func__, SanitizeString(msg_type), nMessageSize);
4201+
LogPrint(BCLog::NET, "%s(%s, %u bytes): Unknown exception caught\n", __func__, SanitizeString(msg.m_type), msg.m_message_size);
42064202
}
42074203

42084204
return fMoreWork;

src/test/fuzz/p2p_transport_serialization.cpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -70,13 +70,13 @@ FUZZ_TARGET_INIT(p2p_transport_serialization, initialize_p2p_transport_serializa
7070
const std::chrono::microseconds m_time{std::numeric_limits<int64_t>::max()};
7171
bool reject_message{false};
7272
CNetMessage msg = deserializer.GetMessage(m_time, reject_message);
73-
assert(msg.m_command.size() <= CMessageHeader::COMMAND_SIZE);
73+
assert(msg.m_type.size() <= CMessageHeader::COMMAND_SIZE);
7474
assert(msg.m_raw_message_size <= mutable_msg_bytes.size());
7575
assert(msg.m_raw_message_size == CMessageHeader::HEADER_SIZE + msg.m_message_size);
7676
assert(msg.m_time == m_time);
7777

7878
std::vector<unsigned char> header;
79-
auto msg2 = CNetMsgMaker{msg.m_recv.GetVersion()}.Make(msg.m_command, MakeUCharSpan(msg.m_recv));
79+
auto msg2 = CNetMsgMaker{msg.m_recv.GetVersion()}.Make(msg.m_type, MakeUCharSpan(msg.m_recv));
8080
serializer.prepareForTransport(msg2, header);
8181
}
8282
}

0 commit comments

Comments
 (0)