blob: 44a4b425c13e1d7873635bc9b7eef06b49745909 [file] [log] [blame] [edit]
/*
* Copyright (C) 2022 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include "packet_util.h"
#include <cstring>
namespace chpp::test {
// Utilities for packet creation -----------------------------------------------
ChppEmptyPacket generateEmptyPacket(uint8_t ackSeq, uint8_t seq,
uint8_t error) {
// clang-format off
ChppEmptyPacket pkt = {
.preamble = kPreamble,
.header = {
.flags = CHPP_TRANSPORT_FLAG_FINISHED_DATAGRAM,
.packetCode = static_cast<uint8_t>(CHPP_ATTR_AND_ERROR_TO_PACKET_CODE(
CHPP_TRANSPORT_ATTR_NONE, error)),
.ackSeq = ackSeq,
.seq = seq,
.length = 0,
.reserved = 0,
},
};
// clang-format on
pkt.footer.checksum = computeCrc(pkt);
return pkt;
}
ChppResetPacket generateResetPacket(uint8_t ackSeq, uint8_t seq) {
// clang-format off
ChppResetPacket pkt = {
.preamble = kPreamble,
.header = {
.flags = CHPP_TRANSPORT_FLAG_FINISHED_DATAGRAM,
.packetCode = static_cast<uint8_t>(CHPP_ATTR_AND_ERROR_TO_PACKET_CODE(
CHPP_TRANSPORT_ATTR_RESET,
CHPP_TRANSPORT_ERROR_NONE
)),
.ackSeq = ackSeq,
.seq = seq,
.length = sizeof(ChppTransportConfiguration),
.reserved = 0,
},
.config = {
.version = {
.major = 1,
.minor = 0,
.patch = 0,
},
.reserved1 = 0,
.reserved2 = 0,
.reserved3 = 0,
}
};
// clang-format on
pkt.footer.checksum = computeCrc(pkt);
return pkt;
}
ChppResetPacket generateResetAckPacket(uint8_t ackSeq, uint8_t seq) {
ChppResetPacket pkt = generateResetPacket(ackSeq, seq);
pkt.header.packetCode =
static_cast<uint8_t>(CHPP_ATTR_AND_ERROR_TO_PACKET_CODE(
CHPP_TRANSPORT_ATTR_RESET_ACK, CHPP_TRANSPORT_ERROR_NONE));
pkt.footer.checksum = computeCrc(pkt);
return pkt;
}
ChppEmptyPacket generateAck(std::vector<uint8_t> &pkt) {
// An ACK consists of an empty packet with the ackSeq set to the received
// packet's seq + 1 (since ackSeq indicates the next seq value we expect), and
// seq set to the received packet's ackSeq - 1 (since we don't increment seq
// on empty packets and ackSeq indicates the next expected seq)
ChppTransportHeader &hdr = getHeader(pkt);
return generateEmptyPacket(/*acqSeq=*/hdr.seq + 1, /*seq=*/hdr.ackSeq - 1);
}
// Utilities for debugging -----------------------------------------------------
void dumpRaw(std::ostream &os, const void *ptr, size_t len) {
const char *buffer = static_cast<const char *>(ptr);
char line[32];
char lineChars[32];
size_t offset = 0;
size_t offsetChars = 0;
for (size_t i = 1; i <= len; i++) {
// This ignores potential errors returned by snprintf. This is a relatively
// simple case and the deliberate decision to ignore them has been made.
offset += static_cast<size_t>(
snprintf(&line[offset], sizeof(line) - offset, "%02x ", buffer[i - 1]));
offsetChars += static_cast<size_t>(
snprintf(&lineChars[offsetChars], sizeof(lineChars) - offsetChars, "%c",
(isprint(buffer[i - 1])) ? buffer[i - 1] : '.'));
if ((i % 8) == 0) {
os << " " << line << "\t" << lineChars << std::endl;
offset = 0;
offsetChars = 0;
} else if ((i % 4) == 0) {
offset += static_cast<size_t>(
snprintf(&line[offset], sizeof(line) - offset, " "));
}
}
if (offset > 0) {
char tabs[8];
char *pos = tabs;
while (offset < 28) {
*pos++ = '\t';
offset += 8;
}
*pos = '\0';
os << " " << line << tabs << lineChars << std::endl;
}
}
void dumpPreamble(std::ostream &os, uint16_t preamble) {
const char *p = reinterpret_cast<const char *>(&preamble);
os << std::endl
<< "Preamble: 0x" << std::hex << preamble << " \"" << p[0] << p[1] << "\"";
if (preamble == kPreamble) {
os << " (ok)";
} else {
os << " (invalid -- expected 0x" << std::hex << kPreamble << ")";
}
os << std::endl;
}
void dumpHeader(std::ostream &os, const ChppTransportHeader &hdr) {
os << "Header {" << std::endl
<< " flags: 0x" << std::hex << (unsigned)hdr.flags;
if (hdr.flags & CHPP_TRANSPORT_FLAG_UNFINISHED_DATAGRAM) {
os << " (unfinished)";
} else {
os << " (finished)";
}
os << std::endl
<< " packetCode: 0x" << std::hex << (unsigned)hdr.packetCode
<< " (attr: ";
uint8_t attr = CHPP_TRANSPORT_GET_ATTR(hdr.packetCode);
switch (attr) {
case CHPP_TRANSPORT_ATTR_NONE:
os << "none";
break;
case CHPP_TRANSPORT_ATTR_RESET:
os << "reset";
break;
case CHPP_TRANSPORT_ATTR_RESET_ACK:
os << "reset-ack";
break;
case CHPP_TRANSPORT_ATTR_LOOPBACK_REQUEST:
os << "loopback-req";
break;
case CHPP_TRANSPORT_ATTR_LOOPBACK_RESPONSE:
os << "loopback-rsp";
break;
default:
os << "invalid";
}
os << " | error: ";
uint8_t error = CHPP_TRANSPORT_GET_ERROR(hdr.packetCode);
switch (error) {
case CHPP_TRANSPORT_ERROR_NONE:
os << "none";
break;
case CHPP_TRANSPORT_ERROR_CHECKSUM:
os << "checksum";
break;
case CHPP_TRANSPORT_ERROR_OOM:
os << "oom";
break;
case CHPP_TRANSPORT_ERROR_BUSY:
os << "busy";
break;
case CHPP_TRANSPORT_ERROR_HEADER:
os << "header";
break;
case CHPP_TRANSPORT_ERROR_ORDER:
os << "order";
break;
case CHPP_TRANSPORT_ERROR_TIMEOUT:
os << "timeout";
break;
case CHPP_TRANSPORT_ERROR_MAX_RETRIES:
os << "max-retries";
break;
case CHPP_TRANSPORT_ERROR_APPLAYER:
os << "app-layer";
break;
default:
os << "invalid";
}
os << ")" << std::endl
<< " ackSeq: " << std::dec << (unsigned)hdr.ackSeq << std::endl
<< " seq: " << std::dec << (unsigned)hdr.seq << std::endl
<< " length: " << std::dec << hdr.length << std::endl
<< " reserved: " << std::dec << hdr.reserved << std::endl
<< "}" << std::endl;
}
void dumpConfig(std::ostream &os, const ChppTransportConfiguration &cfg) {
os << "Config {" << std::endl
<< " version: " << std::dec << (unsigned)cfg.version.major << "."
<< std::dec << (unsigned)cfg.version.minor << "." << std::dec
<< cfg.version.patch << std::endl
<< "}" << std::endl;
}
void dumpEmptyPacket(std::ostream &os, const ChppEmptyPacket &pkt) {
dumpPreamble(os, pkt.preamble);
dumpHeader(os, pkt.header);
dumpFooter(os, pkt);
}
void dumpResetPacket(std::ostream &os, const ChppResetPacket &pkt) {
dumpPreamble(os, pkt.preamble);
dumpHeader(os, pkt.header);
dumpConfig(os, pkt.config);
dumpFooter(os, pkt);
}
void dumpPacket(std::ostream &os, const ChppPacketPrefix &pkt) {
dumpPreamble(os, pkt.preamble);
dumpHeader(os, pkt.header);
os << "Payload {" << std::endl;
dumpRaw(os, pkt.payload, pkt.header.length);
os << "}" << std::endl;
const auto &footer = *reinterpret_cast<const ChppTransportFooter *>(
&pkt.payload[pkt.header.length]);
uint32_t crc = chppCrc32(0, reinterpret_cast<const uint8_t *>(&pkt.header),
sizeof(pkt.header) + pkt.header.length);
os << "CRC: 0x" << std::hex << footer.checksum;
if (footer.checksum != crc) {
os << " (invalid, expected " << crc << ")";
} else {
os << " (ok)";
}
os << std::endl;
}
std::ostream &operator<<(std::ostream &os, const ChppEmptyPacket &pkt) {
dumpEmptyPacket(os, pkt);
return os;
}
std::ostream &operator<<(std::ostream &os, const ChppResetPacket &pkt) {
dumpResetPacket(os, pkt);
return os;
}
std::ostream &operator<<(std::ostream &os, const ChppPacketPrefix &pkt) {
dumpPacket(os, pkt);
return os;
}
// Utilities for gtest packet checking -----------------------------------------
void checkPacketValidity(std::vector<uint8_t> &received) {
const ChppPacketPrefix &pkt = asChpp(received);
EXPECT_GE(received.size(), sizeof(ChppEmptyPacket));
EXPECT_EQ(pkt.preamble, kPreamble);
constexpr size_t kFixedLenPortion =
sizeof(pkt.preamble) + sizeof(pkt.header) + sizeof(ChppTransportFooter);
EXPECT_EQ(pkt.header.length, received.size() - kFixedLenPortion);
EXPECT_EQ(pkt.header.flags & CHPP_TRANSPORT_FLAG_RESERVED, 0);
EXPECT_EQ(pkt.header.reserved, 0);
uint8_t error = CHPP_TRANSPORT_GET_ERROR(pkt.header.packetCode);
EXPECT_TRUE(error <= CHPP_TRANSPORT_ERROR_MAX_RETRIES ||
error == CHPP_TRANSPORT_ERROR_APPLAYER);
uint8_t attrs = CHPP_TRANSPORT_GET_ATTR(pkt.header.packetCode);
EXPECT_TRUE(attrs <= CHPP_TRANSPORT_ATTR_LOOPBACK_RESPONSE);
uint32_t crc = chppCrc32(0, reinterpret_cast<const uint8_t *>(&pkt.header),
sizeof(pkt.header) + pkt.header.length);
const auto *footer = reinterpret_cast<const ChppTransportFooter *>(
&received[sizeof(pkt.preamble) + sizeof(pkt.header) + pkt.header.length]);
EXPECT_EQ(footer->checksum, crc);
}
bool comparePacketHeader(const ChppTransportHeader &rx,
const ChppTransportHeader &expected) {
EXPECT_EQ(rx.flags, expected.flags);
EXPECT_EQ(rx.packetCode, expected.packetCode);
EXPECT_EQ(rx.ackSeq, expected.ackSeq);
EXPECT_EQ(rx.seq, expected.seq);
EXPECT_EQ(rx.length, expected.length);
EXPECT_EQ(rx.reserved, 0u);
return (memcmp(&rx, &expected, sizeof(rx)) == 0);
}
bool comparePacket(const std::vector<uint8_t> &received,
const ChppEmptyPacket &expected) {
EXPECT_EQ(received.size(), sizeof(expected));
if (received.size() == sizeof(expected)) {
const auto *rx = reinterpret_cast<const ChppEmptyPacket *>(received.data());
EXPECT_EQ(rx->preamble, expected.preamble);
comparePacketHeader(rx->header, expected.header);
EXPECT_EQ(rx->footer.checksum, expected.footer.checksum);
}
return (received.size() == sizeof(expected) &&
memcmp(received.data(), &expected, sizeof(expected)) == 0);
}
bool comparePacket(const std::vector<uint8_t> &received,
const ChppResetPacket &expected) {
EXPECT_EQ(received.size(), sizeof(expected));
if (received.size() == sizeof(expected)) {
const auto *rx = reinterpret_cast<const ChppResetPacket *>(received.data());
EXPECT_EQ(rx->preamble, expected.preamble);
comparePacketHeader(rx->header, expected.header);
EXPECT_EQ(rx->config.version.major, expected.config.version.major);
EXPECT_EQ(rx->config.version.minor, expected.config.version.minor);
EXPECT_EQ(rx->config.version.patch, expected.config.version.patch);
EXPECT_EQ(rx->footer.checksum, expected.footer.checksum);
}
return (received.size() == sizeof(expected) &&
memcmp(received.data(), &expected, sizeof(expected)) == 0);
}
} // namespace chpp::test