theater/picomap
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Eliminate std::function: fn-pointer callbacks, per-test test_state structs, udp.cpp with link-time udp::client::handler, udp::address

Browse Source
This commit is contained in:
Ian Gulliver
2026-04-19 00:32:13 -07:00
parent 40f7fb5941
commit 32044a5cbd
11 changed files with 378 additions and 285 deletions
Download Patch File Download Diff File Expand all files Collapse all files

468
firmware/lib/test_handlers.cpp
View File

@@ -1,6 +1,5 @@
#include "test_handlers.h"
#include <cstring>
#include <memory>
#include <unordered_map>
#include "pico/stdlib.h"
#include "pico/time.h"
@@ -11,18 +10,134 @@
#include "parse_buffer.h"
#include "prepend_buffer.h"
static constexpr uint16_t PICOMAP_PORT = __builtin_bswap16(28781);
// Echo IDs are just tags used to match our ping replies; constants suffice
// since tests are one-at-a-time.
static constexpr uint16_t PING_ECHO_ID = 0x1234;
static constexpr uint16_t PING_RATE_ECHO_ID = 0x5678;
struct peer_info {
eth::mac_addr mac;
ipv4::ip4_addr ip;
};
using peer_callback = std::function<void(const peer_info&)>;
using fail_callback = std::function<void()>;
// Shared sub-struct types. Used as fields inside per-test-command structs
// when two tests happen to carry the same shape of data.
static void discover_peer(peer_callback on_found, fail_callback on_timeout) {
auto& ns = net_get_state();
// State for the discover_peer primitive.
struct discovery_data {
void (*on_found)(const peer_info&) = nullptr;
void (*on_timeout)() = nullptr;
};
// Rolling state for a rate-testing ping run.
struct ping_rate_data {
peer_info peer;
uint16_t target;
uint16_t pipeline;
uint16_t payload_len;
uint16_t sent;
uint16_t received;
uint32_t start_us;
};
// One struct per test command. Empty structs (where a test command has no
// extra state beyond the common fields) are kept for symmetry/documentation.
struct discovery_igmp_test {};
struct discovery_info_test {
discovery_data discovery;
};
struct ping_subnet_test {};
struct ping_global_test {};
struct packet_rate_test {
discovery_data discovery;
ping_rate_data rate;
};
struct byte_rate_test {
discovery_data discovery;
ping_rate_data rate;
};
// All test state lives in this single instance. The protocol is one-test-at-
// a-time: handle_test rejects a new request while in_flight is set. Only the
// fields for the running test are populated; the rest are wasted bytes traded
// for clarity.
struct test_state {
// Common to every async test.
bool in_flight = false;
responder resp;
timer_handle timer = nullptr;
frame_cb_handle frame_cb = nullptr;
// Views into the running test's shared sub-state so the shared primitive
// callbacks (discover_peer, ping_rate) know where to find it.
discovery_data* active_discovery = nullptr;
ping_rate_data* active_rate = nullptr;
// Per-test-command storage.
discovery_igmp_test discovery_igmp;
discovery_info_test discovery_info;
ping_subnet_test ping_subnet;
ping_global_test ping_global;
packet_rate_test packet_rate;
byte_rate_test byte_rate;
};
static test_state ts;
static void test_end(const ResponseTest& result) {
if (ts.timer) { dispatch_cancel_timer(ts.timer); ts.timer = nullptr; }
if (ts.frame_cb) { net_remove_frame_callback(ts.frame_cb); ts.frame_cb = nullptr; }
ts.active_discovery = nullptr;
ts.active_rate = nullptr;
ts.resp.respond(result);
ts.in_flight = false;
}
// ----- discover_peer (shared building block) -----
// Note on frame/timer handle lifetimes: when a callback fires, the dispatcher
// (net or timer_queue) has already taken ownership of the node. Callbacks that
// self-consume (frame returning true, or any timer fire) must null the
// matching `ts.` handle before calling test_end, so test_end doesn't try to
// cancel a stale handle.
static bool discover_reply_cb(std::span<const uint8_t> frame) {
parse_buffer pb(frame);
auto* eth_hdr = pb.consume<eth::header>();
if (!eth_hdr || eth_hdr->ethertype != eth::ETH_IPV4) return false;
auto* ip = pb.consume<ipv4::header>();
if (!ip || ip->protocol != 17) return false;
size_t options_len = ip->header_len() - sizeof(ipv4::header);
if (options_len > 0 && !pb.skip(options_len)) return false;
auto* uhdr = pb.consume<udp::header>();
if (!uhdr || uhdr->src_port != PICOMAP_PORT_BE) return false;
if (ip->src == net_get_state().ip) return false;
dispatch_cancel_timer(ts.timer);
ts.timer = nullptr;
ts.frame_cb = nullptr; // self-consumed via `return true` below
auto cont = ts.active_discovery ? ts.active_discovery->on_found : nullptr;
ts.active_discovery = nullptr;
peer_info peer{eth_hdr->src, ip->src};
if (cont) cont(peer);
return true;
}
static void discover_timeout_cb() {
net_remove_frame_callback(ts.frame_cb);
ts.frame_cb = nullptr;
ts.timer = nullptr;
auto cont = ts.active_discovery ? ts.active_discovery->on_timeout : nullptr;
ts.active_discovery = nullptr;
if (cont) cont();
}
static void discover_peer(discovery_data& d,
void (*found)(const peer_info&), void (*timeout)()) {
d.on_found = found;
d.on_timeout = timeout;
ts.active_discovery = &d;
const auto& ns = net_get_state();
eth::mac_addr mcast_mac = igmp::mac_for_ip(igmp::PICOMAP_DISCOVERY_GROUP);
prepend_buffer<4096> buf;
@@ -31,223 +146,193 @@ static void discover_peer(peer_callback on_found, fail_callback on_timeout) {
RequestInfo req_msg;
auto encoded = encode_response_into(out, 0xFFFF, req_msg);
if (!encoded) {
on_timeout();
ts.active_discovery = nullptr;
timeout();
return;
}
buf.append(*encoded);
udp::prepend(buf, mcast_mac, ns.mac, ns.ip, igmp::PICOMAP_DISCOVERY_GROUP,
PICOMAP_PORT, PICOMAP_PORT, *encoded, 1);
PICOMAP_PORT_BE, PICOMAP_PORT_BE, *encoded, 1);
ipv4::ip4_addr our_ip = ns.ip;
auto timer = std::make_shared<timer_handle>(nullptr);
auto cb = std::make_shared<frame_cb_handle>(nullptr);
*cb = net_add_frame_callback([our_ip, timer, on_found = std::move(on_found)](std::span<const uint8_t> frame) -> bool {
parse_buffer pb(frame);
auto* eth_hdr = pb.consume<eth::header>();
if (!eth_hdr || eth_hdr->ethertype != eth::ETH_IPV4) return false;
auto* ip = pb.consume<ipv4::header>();
if (!ip || ip->protocol != 17) return false;
size_t options_len = ip->header_len() - sizeof(ipv4::header);
if (options_len > 0 && !pb.skip(options_len)) return false;
auto* uhdr = pb.consume<udp::header>();
if (!uhdr || uhdr->src_port != PICOMAP_PORT) return false;
if (ip->src == our_ip) return false;
dispatch_cancel_timer(*timer);
on_found({eth_hdr->src, ip->src});
return true;
});
*timer = dispatch_schedule_ms(5000, [cb, on_timeout = std::move(on_timeout)]() {
net_remove_frame_callback(*cb);
on_timeout();
});
ts.frame_cb = net_add_frame_callback(discover_reply_cb);
ts.timer = dispatch_schedule_ms(5000, discover_timeout_cb);
net_send_raw(buf.span());
}
static void test_discovery_igmp(const responder& resp) {
auto& ns = net_get_state();
// ----- discovery_igmp -----
static bool igmp_report_cb(std::span<const uint8_t> frame) {
ipv4::ip4_addr group;
if (!igmp::parse_report(frame, group)) return false;
if (group != igmp::PICOMAP_DISCOVERY_GROUP) return false;
ts.frame_cb = nullptr; // self-consumed via `return true`
test_end({true, {"got IGMP report for " + ipv4::to_string(group)}});
return true;
}
static void igmp_timeout_cb() {
ts.timer = nullptr; // already fired
test_end({false, {"no IGMP report within 5s"}});
}
static void test_discovery_igmp() {
const auto& ns = net_get_state();
prepend_buffer<4096> buf;
igmp::prepend_query(buf, ns.mac, ns.ip, igmp::PICOMAP_DISCOVERY_GROUP);
auto timer = std::make_shared<timer_handle>(nullptr);
auto cb = std::make_shared<frame_cb_handle>(nullptr);
*cb = net_add_frame_callback([resp, timer](std::span<const uint8_t> frame) -> bool {
ipv4::ip4_addr group;
if (!igmp::parse_report(frame, group)) return false;
if (group != igmp::PICOMAP_DISCOVERY_GROUP) return false;
dispatch_cancel_timer(*timer);
resp.respond(ResponseTest{true, {"got IGMP report for " + ipv4::to_string(group)}});
return true;
});
*timer = dispatch_schedule_ms(5000, [cb, resp]() {
net_remove_frame_callback(*cb);
resp.respond(ResponseTest{false, {"no IGMP report within 5s"}});
});
ts.frame_cb = net_add_frame_callback(igmp_report_cb);
ts.timer = dispatch_schedule_ms(5000, igmp_timeout_cb);
net_send_raw(buf.span());
}
static void test_discovery_info(const responder& resp) {
discover_peer(
[resp](const peer_info& peer) {
resp.respond(ResponseTest{true, {"got info response from " + ipv4::to_string(peer.ip)}});
},
[resp]() {
resp.respond(ResponseTest{false, {"no info response within 5s"}});
});
// ----- discovery_info -----
static void info_found(const peer_info& peer) {
test_end({true, {"got info response from " + ipv4::to_string(peer.ip)}});
}
static void test_ping(const responder& resp, ipv4::ip4_addr dst_ip) {
auto& ns = net_get_state();
uint16_t ping_id = 0x1234;
static void info_timeout() {
test_end({false, {"no info response within 5s"}});
}
static void test_discovery_info() {
discover_peer(ts.discovery_info.discovery, info_found, info_timeout);
}
// ----- ping_subnet / ping_global -----
static bool ping_reply_cb(std::span<const uint8_t> frame) {
ipv4::ip4_addr src_ip;
if (!icmp::parse_echo_reply(frame, src_ip, PING_ECHO_ID)) return false;
ts.frame_cb = nullptr; // self-consumed via `return true`
if (src_ip == net_get_state().ip)
test_end({false, {"got reply from self: " + ipv4::to_string(src_ip)}});
else
test_end({true, {"reply from " + ipv4::to_string(src_ip)}});
return true;
}
static void ping_timeout_cb() {
ts.timer = nullptr; // already fired
test_end({false, {"no reply from non-self host within 5s"}});
}
static void start_ping(ipv4::ip4_addr dst_ip) {
const auto& ns = net_get_state();
prepend_buffer<4096> buf;
icmp::prepend_echo_request(buf, ns.mac, ns.ip,
eth::MAC_BROADCAST, dst_ip, ping_id, 1);
ipv4::ip4_addr our_ip = ns.ip;
auto timer = std::make_shared<timer_handle>(nullptr);
auto cb = std::make_shared<frame_cb_handle>(nullptr);
*cb = net_add_frame_callback([resp, ping_id, our_ip, timer](std::span<const uint8_t> frame) -> bool {
ipv4::ip4_addr src_ip;
if (!icmp::parse_echo_reply(frame, src_ip, ping_id)) return false;
dispatch_cancel_timer(*timer);
if (src_ip == our_ip) {
resp.respond(ResponseTest{false, {"got reply from self: " + ipv4::to_string(src_ip)}});
return true;
}
resp.respond(ResponseTest{true, {"reply from " + ipv4::to_string(src_ip)}});
return true;
});
*timer = dispatch_schedule_ms(5000, [cb, resp]() {
net_remove_frame_callback(*cb);
resp.respond(ResponseTest{false, {"no reply from non-self host within 5s"}});
});
eth::MAC_BROADCAST, dst_ip, PING_ECHO_ID, 1);
ts.frame_cb = net_add_frame_callback(ping_reply_cb);
ts.timer = dispatch_schedule_ms(5000, ping_timeout_cb);
net_send_raw(buf.span());
}
static void test_ping_subnet(const responder& resp) {
test_ping(resp, {169, 254, 255, 255});
static void test_ping_subnet() { start_ping({169, 254, 255, 255}); }
static void test_ping_global() { start_ping({255, 255, 255, 255}); }
// ----- packet_rate / byte_rate -----
static size_t ping_rate_frame_size() {
return sizeof(eth::header) + sizeof(ipv4::header) + sizeof(icmp::echo)
+ ts.active_rate->payload_len;
}
static void test_ping_global(const responder& resp) {
test_ping(resp, {255, 255, 255, 255});
}
struct ping_rate_state {
responder resp;
timer_handle timer = nullptr;
frame_cb_handle cb_handle = nullptr;
uint16_t ping_id;
uint16_t sent = 0;
uint16_t received = 0;
uint16_t target;
uint16_t pipeline;
uint16_t payload_len;
uint32_t start_us;
peer_info peer;
ipv4::ip4_addr our_ip;
eth::mac_addr our_mac;
size_t frame_size() const {
return sizeof(eth::header) + sizeof(ipv4::header) + sizeof(icmp::echo) + payload_len;
}
};
static void ping_rate_send_one(std::shared_ptr<ping_rate_state> st) {
static void ping_rate_send_one() {
const auto& ns = net_get_state();
auto& r = *ts.active_rate;
prepend_buffer<4096> buf;
if (st->payload_len > 0)
memset(buf.append(st->payload_len), 0xAA, st->payload_len);
icmp::prepend_echo_request(buf, st->our_mac, st->our_ip,
st->peer.mac, st->peer.ip, st->ping_id,
st->sent + 1, st->payload_len);
if (r.payload_len > 0)
memset(buf.append(r.payload_len), 0xAA, r.payload_len);
icmp::prepend_echo_request(buf, ns.mac, ns.ip,
r.peer.mac, r.peer.ip, PING_RATE_ECHO_ID,
r.sent + 1, r.payload_len);
net_send_raw(buf.span());
st->sent++;
r.sent++;
}
static void start_ping_rate(const responder& resp, uint16_t target,
uint16_t payload_len, uint16_t pipeline) {
auto& ns = net_get_state();
static bool ping_rate_reply_cb(std::span<const uint8_t> frame) {
ipv4::ip4_addr src_ip;
if (!icmp::parse_echo_reply(frame, src_ip, PING_RATE_ECHO_ID)) return false;
if (src_ip == net_get_state().ip) return false;
discover_peer(
[resp, ns, target, payload_len, pipeline](const peer_info& peer) {
auto st = std::make_shared<ping_rate_state>();
st->resp = resp;
st->ping_id = 0x5678;
st->target = target;
st->pipeline = pipeline;
st->payload_len = payload_len;
st->our_mac = ns.mac;
st->our_ip = ns.ip;
st->peer = peer;
st->start_us = time_us_32();
auto& r = *ts.active_rate;
r.received++;
if (r.received >= r.target) {
uint32_t elapsed_us = time_us_32() - r.start_us;
uint32_t elapsed_ms = elapsed_us / 1000;
uint32_t pps = static_cast<uint32_t>(
static_cast<uint64_t>(r.received) * 1000000 / elapsed_us);
uint64_t total_bytes = static_cast<uint64_t>(r.received) * 2 * ping_rate_frame_size();
uint32_t kbps = static_cast<uint32_t>(total_bytes * 1000 / elapsed_us);
char msg[128];
snprintf(msg, sizeof(msg),
"%u rt in %lu ms, %lu pps, %lu bytes, %lu KB/s",
r.received, static_cast<unsigned long>(elapsed_ms),
static_cast<unsigned long>(pps),
static_cast<unsigned long>(total_bytes),
static_cast<unsigned long>(kbps));
ts.frame_cb = nullptr; // self-consumed via `return true`
test_end({true, {msg}});
return true;
}
st->cb_handle = net_add_frame_callback([st](std::span<const uint8_t> frame) -> bool {
ipv4::ip4_addr src_ip;
if (!icmp::parse_echo_reply(frame, src_ip, st->ping_id)) return false;
if (src_ip == st->our_ip) return false;
st->received++;
if (st->received >= st->target) {
dispatch_cancel_timer(st->timer);
uint32_t elapsed_us = time_us_32() - st->start_us;
uint32_t elapsed_ms = elapsed_us / 1000;
uint32_t pps = static_cast<uint32_t>(
static_cast<uint64_t>(st->received) * 1000000 / elapsed_us);
uint64_t total_bytes = static_cast<uint64_t>(st->received) * 2 * st->frame_size();
uint32_t kbps = static_cast<uint32_t>(total_bytes * 1000 / elapsed_us);
char msg[128];
snprintf(msg, sizeof(msg),
"%u rt in %lu ms, %lu pps, %lu bytes, %lu KB/s",
st->received, static_cast<unsigned long>(elapsed_ms),
static_cast<unsigned long>(pps),
static_cast<unsigned long>(total_bytes),
static_cast<unsigned long>(kbps));
st->resp.respond(ResponseTest{true, {msg}});
return true;
}
if (st->sent < st->target)
ping_rate_send_one(st);
return false;
});
st->timer = dispatch_schedule_ms(10000, [st]() {
net_remove_frame_callback(st->cb_handle);
uint32_t elapsed_us = time_us_32() - st->start_us;
char msg[64];
snprintf(msg, sizeof(msg), "timeout after %u/%u rt in %lu ms",
st->received, st->sent,
static_cast<unsigned long>(elapsed_us / 1000));
st->resp.respond(ResponseTest{false, {msg}});
});
for (uint16_t i = 0; i < st->pipeline && st->sent < st->target; i++)
ping_rate_send_one(st);
},
[resp]() {
resp.respond(ResponseTest{false, {"no peer found"}});
});
if (r.sent < r.target)
ping_rate_send_one();
return false;
}
static void test_packet_rate(const responder& resp) {
start_ping_rate(resp, 8192, 0, 8);
static void ping_rate_timeout_cb() {
ts.timer = nullptr; // already fired
auto& r = *ts.active_rate;
uint32_t elapsed_us = time_us_32() - r.start_us;
char msg[64];
snprintf(msg, sizeof(msg), "timeout after %u/%u rt in %lu ms",
r.received, r.sent,
static_cast<unsigned long>(elapsed_us / 1000));
test_end({false, {msg}});
}
static void test_byte_rate(const responder& resp) {
start_ping_rate(resp, 2048, 1400, 8);
static void ping_rate_found(const peer_info& peer) {
auto& r = *ts.active_rate;
r.peer = peer;
r.sent = 0;
r.received = 0;
r.start_us = time_us_32();
ts.frame_cb = net_add_frame_callback(ping_rate_reply_cb);
ts.timer = dispatch_schedule_ms(10000, ping_rate_timeout_cb);
for (uint16_t i = 0; i < r.pipeline && r.sent < r.target; i++)
ping_rate_send_one();
}
using sync_test_fn = ResponseTest (*)(const responder&);
using async_test_fn = void (*)(const responder&);
static void ping_rate_no_peer() {
test_end({false, {"no peer found"}});
}
static void start_ping_rate(discovery_data& d, ping_rate_data& r,
uint16_t target, uint16_t payload_len, uint16_t pipeline) {
r.target = target;
r.payload_len = payload_len;
r.pipeline = pipeline;
ts.active_rate = &r;
discover_peer(d, ping_rate_found, ping_rate_no_peer);
}
static void test_packet_rate() {
start_ping_rate(ts.packet_rate.discovery, ts.packet_rate.rate, 8192, 0, 8);
}
static void test_byte_rate() {
start_ping_rate(ts.byte_rate.discovery, ts.byte_rate.rate, 2048, 1400, 8);
}
// ----- registry -----
using sync_test_fn = ResponseTest (*)();
using async_test_fn = void (*)();
struct test_entry {
sync_test_fn sync;
@@ -257,10 +342,10 @@ struct test_entry {
static const std::unordered_map<std::string_view, test_entry> tests = {
{"discovery_igmp", {nullptr, test_discovery_igmp}},
{"discovery_info", {nullptr, test_discovery_info}},
{"ping_subnet", {nullptr, test_ping_subnet}},
{"ping_global", {nullptr, test_ping_global}},
{"packet_rate", {nullptr, test_packet_rate}},
{"byte_rate", {nullptr, test_byte_rate}},
{"ping_subnet", {nullptr, test_ping_subnet}},
{"ping_global", {nullptr, test_ping_global}},
{"packet_rate", {nullptr, test_packet_rate}},
{"byte_rate", {nullptr, test_byte_rate}},
};
std::optional<ResponseListTests> handle_list_tests(const responder&, const RequestListTests&) {
@@ -271,11 +356,16 @@ std::optional<ResponseListTests> handle_list_tests(const responder&, const Reque
}
std::optional<ResponseTest> handle_test(const responder& resp, const RequestTest& req) {
if (ts.in_flight)
return ResponseTest{false, {"test already running"}};
auto it = tests.find(req.name);
if (it == tests.end())
return ResponseTest{false, {"unknown test: " + req.name}};
if (it->second.sync)
return it->second.sync(resp);
it->second.async(resp);
return it->second.sync();
ts.in_flight = true;
ts.resp = resp;
it->second.async();
return std::nullopt;
}