Keep bridged OTA retries resumable across profile handoffs
Let the mesh timed OTA retry guard own byte-identical requests instead of the permanent bridge FIFO. Bind bridge ingress to its primary profile generation and preserve UART reflection/liveness protections. Verified a LoRa to ESP-NOW to LoRa update with outage recovery and install.
This commit is contained in:
1 parent
bc1b414af0
commit
690ffe5601
11 files changed
+228
-24
No files matched your search
@@ -4,6 +4,7 @@
|
||||
#include <vector>
|
||||
|
||||
#define MAX_TRANS_UNIT 255
|
||||
#define PAYLOAD_TYPE_OTA 0x0c
|
||||
#define BRIDGE_DEBUG_PRINTLN(...) ((void)0)
|
||||
struct NodePrefs { uint32_t bridge_baud = 115200; };
|
||||
|
||||
@@ -11,6 +12,7 @@ namespace mesh {
|
||||
struct Packet {
|
||||
std::vector<uint8_t> payload{1, 2, 3};
|
||||
bool allowed = true;
|
||||
uint8_t getPayloadType() const { return payload.empty() ? 0 : (payload[0] >> 2) & 0x0f; }
|
||||
int getRawLength() const { return static_cast<int>(payload.size()); }
|
||||
uint16_t writeTo(uint8_t* out) const {
|
||||
for (size_t i = 0; i < payload.size(); ++i) out[i] = payload[i];
|
||||
|
||||
Vendored
+4
-1
@@ -9,6 +9,7 @@
|
||||
#include <helpers/bridges/ESPNowBridgeFormat.h>
|
||||
#include <helpers/bridges/RS232PowerSettings.h>
|
||||
struct FakeRng { void random(uint8_t* out, size_t size) { memset(out, 0x42, size); } };
|
||||
struct FakeRadio { const void* profiles() const { return nullptr; } };
|
||||
#define BRIDGE_MAX_BAUD 115200
|
||||
#define PUB_KEY_SIZE 32
|
||||
#define MESH_DEBUG_PRINTLN(...) ((void)0)
|
||||
@@ -64,6 +65,7 @@ public:
|
||||
void setPacketFilter(bool (*check)(void*, const mesh::Packet*), void* context) {
|
||||
filter = check; filter_context = context; ++filters;
|
||||
}
|
||||
void setIngressProfiles(const void*) {}
|
||||
};
|
||||
class RS232Bridge : public AbstractBridge {
|
||||
NodePrefs* prefs;
|
||||
@@ -217,7 +219,8 @@ public:
|
||||
FakeCLI _cli;
|
||||
FakeAlerter _alerter;
|
||||
mesh::LocalIdentity self_id;
|
||||
void* _mgr = nullptr; void* _radio = nullptr; void* _ms = nullptr;
|
||||
FakeRadio radio; FakeRadio* _radio = &radio;
|
||||
void* _mgr = nullptr; void* _ms = nullptr;
|
||||
void* getRTCClock() { return nullptr; }
|
||||
FakeRng rng;
|
||||
FakeRng* getRNG() { return &rng; }
|
||||
|
||||
@@ -0,0 +1,116 @@
|
||||
"""Execute real bridge admission and dispatcher/OTA lease guards without RF."""
|
||||
from pathlib import Path
|
||||
import os
|
||||
import subprocess
|
||||
import tempfile
|
||||
import unittest
|
||||
|
||||
from test_radio_receive_contract import method
|
||||
from test_transport_filter_wiring import HARNESS, PACKET
|
||||
|
||||
ROOT = Path(__file__).resolve().parents[1]
|
||||
|
||||
|
||||
class BridgeIngressTests(unittest.TestCase):
|
||||
def test_primary_affinity_stale_queue_and_no_secondary_lease_appropriation(self):
|
||||
base = (ROOT / "src/helpers/bridges/BridgeBase.cpp").read_text()
|
||||
dispatcher = (ROOT / "src/Dispatcher.cpp").read_text()
|
||||
mesh = (ROOT / "src/Mesh.cpp").read_text()
|
||||
receive = method(dispatcher, "void Dispatcher::processRecvPacket(")
|
||||
guard = receive[receive.index(" const auto* profiles ="):receive.index(" const uint8_t previous_profile")]
|
||||
ota_start = mesh.index(" case PAYLOAD_TYPE_OTA: {")
|
||||
ota_guard = mesh[mesh.index(" if (!isAnyTempRadioActive()", ota_start):
|
||||
mesh.index(" observeOtaRequestPressure(pkt);", ota_start)]
|
||||
ota_guard = ota_guard.replace(" break;", " return false;")
|
||||
code = HARNESS[:HARNESS.index("@METHODS@")]
|
||||
code += method(base, "void BridgeBase::handleReceivedPacket(")
|
||||
code += r'''
|
||||
using mesh::RadioCrossMode;
|
||||
using mesh::RadioProfileProtocol;
|
||||
struct Radio {
|
||||
mesh::RadioProfiles* state;
|
||||
const mesh::RadioProfiles* profiles() const {return state;}
|
||||
};
|
||||
struct Dispatcher {
|
||||
Radio* _radio; unsigned accepted=0,released=0;
|
||||
void releasePacket(mesh::Packet*) {++released;}
|
||||
void receive(mesh::Packet* pkt) {
|
||||
@DISPATCH_GUARD@
|
||||
++accepted;
|
||||
}
|
||||
bool isAnyTempRadioActive() const {
|
||||
return _radio->state && (_radio->state->primary_temporary || _radio->state->secondary_temporary);
|
||||
}
|
||||
bool otaEligible(mesh::Packet* pkt) {
|
||||
@OTA_GUARD@
|
||||
return true;
|
||||
}
|
||||
};
|
||||
int main() {
|
||||
mesh::RadioProfiles profiles;
|
||||
profiles.generation[0]=12;profiles.generation[1]=93;
|
||||
profiles.primary_temporary=false;profiles.secondary_temporary=true;
|
||||
profiles.cross=mesh::RadioCrossMode::Off;
|
||||
BridgeBase bridge;bridge.setIngressProfiles(&profiles);
|
||||
mesh::Packet packet;
|
||||
packet.header=(PAYLOAD_TYPE_OTA<<2)|1;
|
||||
packet.radio_profile=packet.radio_origin=1;
|
||||
packet.radio_generation=packet.radio_origin_generation=93;
|
||||
packet.radio_bound=true;packet.radio_local=true;packet.tx_radio=mesh::RADIO_TX_BOTH;
|
||||
packet.radio_reply=packet.radio_reply_force=true;
|
||||
bridge.handleReceivedPacket(&packet);
|
||||
assert(bridge.manager.queued==1&&bridge.manager.freed==0);
|
||||
assert(packet.radio_profile==0&&packet.radio_origin==0);
|
||||
assert(packet.radio_generation==12&&packet.radio_origin_generation==12);
|
||||
assert(!packet.radio_bound&&!packet.radio_local&&packet.tx_radio==mesh::RADIO_TX_AUTO);
|
||||
assert(!packet.radio_reply&&!packet.radio_reply_force);
|
||||
Radio radio{&profiles};Dispatcher dispatch{&radio};
|
||||
dispatch.receive(&packet);assert(dispatch.accepted==1&&dispatch.released==0);
|
||||
// A secondary-only update window is not permission to steal that lease.
|
||||
assert(!dispatch.otaEligible(&packet));
|
||||
profiles.primary_temporary=true;assert(dispatch.otaEligible(&packet));
|
||||
// Frames already admitted with bridge.delay retain the old primary lease.
|
||||
profiles.generation[0]=13;
|
||||
dispatch.receive(&packet);assert(dispatch.accepted==1&&dispatch.released==1);
|
||||
assert(packet.radio_generation==12&&packet.radio_origin_generation==12);
|
||||
mesh::Packet fresh;fresh.header=packet.header;bridge.handleReceivedPacket(&fresh);
|
||||
assert(fresh.radio_generation==13&&fresh.radio_profile==0);
|
||||
dispatch.receive(&fresh);assert(dispatch.accepted==2&&dispatch.released==1);
|
||||
// An explicit cross policy remains the sole opt-in to the other temp tuple.
|
||||
profiles.primary_temporary=false;profiles.cross=mesh::RadioCrossMode::On;
|
||||
assert(dispatch.otaEligible(&fresh));profiles.cross=mesh::RadioCrossMode::Off;
|
||||
// A foreign primary tuple cannot reinterpret bridge MeshCore bytes.
|
||||
profiles.primary.protocol=mesh::RadioProfileProtocol::Meshtext;
|
||||
const auto queued=bridge.manager.queued;
|
||||
bridge.handleReceivedPacket(&fresh);
|
||||
assert(bridge.manager.queued==queued&&bridge.manager.freed==1);
|
||||
// Legacy single-profile radios have no generation table; preserve that path.
|
||||
bridge.setIngressProfiles(nullptr);radio.state=nullptr;
|
||||
bridge.handleReceivedPacket(&fresh);assert(fresh.radio_generation==0&&!fresh.radio_local);
|
||||
dispatch.receive(&fresh);assert(dispatch.accepted==3&&dispatch.released==1);
|
||||
}
|
||||
'''
|
||||
code = code.replace("@DISPATCH_GUARD@", guard).replace("@OTA_GUARD@", ota_guard)
|
||||
with tempfile.TemporaryDirectory(prefix="meshcore-bridge-ingress-") as directory:
|
||||
work = Path(directory)
|
||||
(work / "Mesh.h").write_text(PACKET)
|
||||
source, binary = work / "main.cpp", work / "test"
|
||||
source.write_text(code)
|
||||
built = subprocess.run([
|
||||
os.environ.get("CXX", "g++"), "-std=c++17", "-O1", "-Wall", "-Wextra", "-Werror",
|
||||
"-fsanitize=address,undefined", "-fno-sanitize-recover=all", "-fno-pie", "-no-pie",
|
||||
"-I", str(work), "-I", str(ROOT / "src"), str(source), "-o", str(binary),
|
||||
], capture_output=True, text=True, timeout=60)
|
||||
self.assertEqual(built.returncode, 0, built.stdout + built.stderr)
|
||||
checked = subprocess.run([str(binary)], capture_output=True, text=True, timeout=15)
|
||||
self.assertEqual(checked.returncode, 0, checked.stdout + checked.stderr)
|
||||
|
||||
def test_every_role_bridge_configuration_binds_the_primary_profiles(self):
|
||||
header = (ROOT / "examples/simple_repeater/MyMesh.h").read_text()
|
||||
configure = method(header, "void configureBridgeFilter(")
|
||||
self.assertIn("active_bridge->setIngressProfiles(_radio->profiles());", configure)
|
||||
self.assertLess(configure.index("setIngressProfiles"), configure.index("#if MESH_ENABLE_FLOOD_RULE_ENGINE"))
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
@@ -17,6 +17,7 @@ MOCKS = r'''
|
||||
#include <cstdio>
|
||||
#include <helpers/bridges/RS232Heartbeat.h>
|
||||
#define MAX_TRANS_UNIT 255
|
||||
#define PAYLOAD_TYPE_OTA 0x0c
|
||||
using portMUX_TYPE=int;
|
||||
#define portMUX_INITIALIZER_UNLOCKED 0
|
||||
struct esp_now_recv_info_t {const uint8_t* src_addr;};
|
||||
@@ -41,6 +42,7 @@ struct Packet {
|
||||
}
|
||||
int getRawLength()const{return length;}
|
||||
uint16_t writeTo(uint8_t* out)const{memcpy(out,data,length);return length;}
|
||||
uint8_t getPayloadType()const{return (data[0]>>2)&0x0f;}
|
||||
bool violatesRoutePolicy()const{return false;}
|
||||
};
|
||||
struct PacketManager {
|
||||
@@ -78,6 +80,7 @@ public:
|
||||
virtual void begin()=0;virtual void end()=0;virtual void loop()=0;
|
||||
virtual void sendPacket(mesh::Packet*)=0;virtual void onPacketReceived(mesh::Packet*)=0;
|
||||
bool allowsPacket(const mesh::Packet*)const{return allowed;}
|
||||
bool preparePacketIngress(mesh::Packet*)const{return true;}
|
||||
static uint16_t fletcher16(const uint8_t*,size_t);
|
||||
bool validateChecksum(const uint8_t*,size_t,uint16_t);
|
||||
void handleReceivedPacket(mesh::Packet*);
|
||||
@@ -161,6 +164,42 @@ class BridgeRecoveryTests(unittest.TestCase):
|
||||
result = subprocess.run([str(exe)], capture_output=True, text=True)
|
||||
self.assertEqual(result.returncode, 0, result.stderr)
|
||||
|
||||
def test_ota_identical_retries_cross_espnow_and_uart_without_permanent_dedup(self):
|
||||
self.run_fixture(r'''
|
||||
int main(){
|
||||
Backend backend;backend.wifi=true;mesh::wireless::control().begin(backend);
|
||||
sdk_initialized=sdk_started=true;sdk_mode=WIFI_STA;
|
||||
NodePrefs prefs;mesh::PacketManager mgr;mesh::RTCClock rtc;
|
||||
ESPNowBridge espnow(&prefs,&mgr,&rtc);espnow.begin();
|
||||
const uint8_t mac[6]={1,2,3,4,5,6};
|
||||
auto ota=packet(0x31); // flood-framed PAYLOAD_TYPE_OTA, byte-identical retry
|
||||
espnow._seen_packets.markSeen(&ota); // even a preexisting FIFO row cannot pin it
|
||||
espnow.sendPacket(&ota);espnow.loop();complete(espnow);
|
||||
assert(sent.size()==1&&espnow._tx_count==0);
|
||||
espnow.sendPacket(&ota);espnow.loop();complete(espnow);
|
||||
assert(sent.size()==2&&sent[0]==sent[1]);
|
||||
espnow.queueReceivedFrame(mac,ota.data,ota.length);espnow.loop();
|
||||
espnow.queueReceivedFrame(mac,ota.data,ota.length);espnow.loop();
|
||||
assert((mgr.received==std::vector<uint8_t>{0x31,0x31}));
|
||||
// Ordinary message duplicates still stop in both bridge directions.
|
||||
auto chat=packet(0x15);espnow.sendPacket(&chat);espnow.loop();complete(espnow);
|
||||
const auto count=sent.size();espnow.sendPacket(&chat);espnow.loop();
|
||||
assert(sent.size()==count);
|
||||
espnow.queueReceivedFrame(mac,chat.data,chat.length);espnow.loop();
|
||||
assert(mgr.received.size()==2);espnow.end();
|
||||
HardwareSerial serial;RS232Bridge uart(&prefs,serial,1,2,&mgr,&rtc);uart.begin();
|
||||
uart._seen_packets.markSeen(&ota);uart.sendPacket(&ota);uart.sendPacket(&ota);
|
||||
auto doubled=uart_frame(ota);const auto tail=doubled;
|
||||
doubled.insert(doubled.end(),tail.begin(),tail.end());assert(serial.output==doubled);
|
||||
append(serial,uart_frame(ota));append(serial,uart_frame(ota));uart.loop();
|
||||
assert((mgr.received==std::vector<uint8_t>{0x31,0x31,0x31,0x31}));
|
||||
assert(!uart._legacy_rx); // reflected OTA is not proof of an external peer
|
||||
uart.sendPacket(&chat);const auto length=serial.output.size();uart.sendPacket(&chat);
|
||||
assert(serial.output.size()==length);append(serial,uart_frame(chat));uart.loop();
|
||||
assert(mgr.received.size()==4&&mgr.allocs==mgr.frees);
|
||||
}
|
||||
''')
|
||||
|
||||
def test_uart_pool_pressure_order_parser_bounds_and_restart(self):
|
||||
self.run_fixture(r'''
|
||||
int main(){
|
||||
|
||||
@@ -13,9 +13,14 @@ PACKET = r'''
|
||||
#include <cstdint>
|
||||
#include <cstddef>
|
||||
#include <cstring>
|
||||
#include <RadioProfiles.h>
|
||||
#include <RadioTxPolicy.h>
|
||||
namespace mesh {
|
||||
struct Packet {
|
||||
uint8_t payload[64] = {}, payload_len = 32, type = 5, header = (5 << 2);
|
||||
uint8_t radio_profile=0,radio_origin=0,tx_radio=RADIO_TX_AUTO;
|
||||
uint32_t radio_generation=0,radio_origin_generation=0;
|
||||
bool radio_bound=false,radio_local=true,radio_reply=false,radio_reply_force=false;
|
||||
uint8_t getPayloadType() const { return (header >> 2) & 0x0f; }
|
||||
bool violatesRoutePolicy() const {
|
||||
const uint8_t route = header & 0x03;
|
||||
@@ -38,6 +43,7 @@ HARNESS = r'''
|
||||
#define BRIDGE_DEBUG_PRINTLN(...) ((void)0)
|
||||
#define PUB_KEY_SIZE 32
|
||||
#define PAYLOAD_TYPE_ADVERT 4
|
||||
#define PAYLOAD_TYPE_OTA 0x0c
|
||||
#define MAX_SERIAL_PACKET_SIZE 300
|
||||
#define MAX_TRANS_UNIT 256
|
||||
#define SERIAL_OVERHEAD 6
|
||||
|
||||
Reference in new issue
Block a user