mirror of
https://github.com/torlando-tech/pyxis.git
synced 2026-08-08 03:39:53 +00:00
Repins microReticulum + microLXMF onto the upstream-0.4.1 graft and adapts pyxis to the new src/microReticulum/ layout and 0.4.x APIs. The far-diverged 0.3.0 fork's Resource/Transport/Identity work is subsumed by upstream's reimplementation; only the still-needed fixes ride on the pinned branches (PKCS7/HMAC/X25519 crypto -- proven byte-identical to python RNS 1.3.1 -- Packet link-proof callback, Identity short-sig guard, and the bz2 layer + decompress-on-receive in Resource::assemble()). Consumer-side changes: - platformio.ini: pin microReticulum @2f21fee (pyxis-fixes-on-0.4.1) and microLXMF @33760d0 (chore/microreticulum-0.4.1-layout); bump microStore ceea8f5 -> c5fb69d (0.4.x requires the new BasicFileStore::init API); -std=gnu++11 -> gnu++17 (upstream requires C++17). - Namespace all microReticulum includes (angle + quote) to <microReticulum/...> for the relocated layout; shim-local Utilities/Stream.h|Print.h preserved. - Interface::send_outgoing now returns bool: update TCP/BLE/SX1262/Auto overrides with correct success/failure returns. - SDArchiveFileSystem::init(bool reformatOnFail=true) to match new microStore. - Static Transport::get_path_table() -> path_table(); instance getter unchanged. - Remove duplicate shim Cryptography/BZ2 (microReticulum provides it now; keep lib/libbz2 as the ESP32 bzlib provider). - patch_littlefs_paths.py: normalize microStore's LittleFS adapter paths to a leading "/" -- ESP32 Arduino LittleFS rejects "./"-prefixed paths, which silently broke the path store (no peer paths learned, all messaging blocked). Validated on T-Deck Plus: builds (RAM 27.5% / Flash 77.7%), boots stable (no WDT/panic), and a full on-device LXMF e2e (DIRECT + OPPORTUNISTIC + bz2-compressed-Resource receive) passes 5/5. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UWZuYkHBRqNb6BZHV8sTG5
515 lines
17 KiB
C++
515 lines
17 KiB
C++
#include "TCPClientInterface.h"
|
||
#include "HDLC.h"
|
||
|
||
#include <microReticulum/Transport.h>
|
||
#include <microReticulum/Log.h>
|
||
|
||
#include <memory>
|
||
|
||
#ifdef ARDUINO
|
||
// ESP32 lwIP socket headers
|
||
#include <lwip/sockets.h>
|
||
#include <lwip/netdb.h>
|
||
#else
|
||
#include <sys/socket.h>
|
||
#include <netinet/in.h>
|
||
#include <netinet/tcp.h>
|
||
#include <arpa/inet.h>
|
||
#include <netdb.h>
|
||
#include <unistd.h>
|
||
#include <fcntl.h>
|
||
#include <errno.h>
|
||
#endif
|
||
|
||
using namespace RNS;
|
||
|
||
TCPClientInterface::TCPClientInterface(const char* name /*= "TCPClientInterface"*/)
|
||
: RNS::InterfaceImpl(name) {
|
||
|
||
_IN = true;
|
||
_OUT = true;
|
||
_bitrate = BITRATE_GUESS;
|
||
_HW_MTU = HW_MTU;
|
||
}
|
||
|
||
/*virtual*/ TCPClientInterface::~TCPClientInterface() {
|
||
stop();
|
||
}
|
||
|
||
/*virtual*/ bool TCPClientInterface::start() {
|
||
_online = false;
|
||
|
||
TRACE("TCPClientInterface: target host: " + _target_host);
|
||
TRACE("TCPClientInterface: target port: " + std::to_string(_target_port));
|
||
|
||
if (_target_host.empty()) {
|
||
ERROR("TCPClientInterface: No target host configured");
|
||
return false;
|
||
}
|
||
|
||
// WiFi connection is handled externally (in main.cpp)
|
||
// Attempt initial connection
|
||
if (!connect()) {
|
||
INFO("TCPClientInterface: Initial connection failed, will retry in background");
|
||
// Don't return false - we'll reconnect in loop()
|
||
}
|
||
|
||
return true;
|
||
}
|
||
|
||
bool TCPClientInterface::connect() {
|
||
TRACE("TCPClientInterface: Connecting to " + _target_host + ":" + std::to_string(_target_port));
|
||
|
||
#ifdef ARDUINO
|
||
// Set connection timeout
|
||
_client.setTimeout(CONNECT_TIMEOUT_MS);
|
||
|
||
if (!_client.connect(_target_host.c_str(), _target_port)) {
|
||
DEBUG("TCPClientInterface: Connection failed");
|
||
return false;
|
||
}
|
||
|
||
// Configure socket options
|
||
configure_socket();
|
||
|
||
INFO("TCPClientInterface: Connected to " + _target_host + ":" + std::to_string(_target_port));
|
||
_online = true;
|
||
_reconnected = true; // Signal that we (re)connected - main loop should announce
|
||
_last_data_received = millis(); // Reset stale timer
|
||
_frame_buffer.clear();
|
||
return true;
|
||
|
||
#else
|
||
// Resolve target host
|
||
struct in_addr target_addr;
|
||
if (inet_aton(_target_host.c_str(), &target_addr) == 0) {
|
||
struct hostent* host_ent = gethostbyname(_target_host.c_str());
|
||
if (host_ent == nullptr || host_ent->h_addr_list[0] == nullptr) {
|
||
ERROR("TCPClientInterface: Unable to resolve host " + _target_host);
|
||
return false;
|
||
}
|
||
_target_address = *((in_addr_t*)(host_ent->h_addr_list[0]));
|
||
} else {
|
||
_target_address = target_addr.s_addr;
|
||
}
|
||
|
||
// Create TCP socket
|
||
_socket = socket(PF_INET, SOCK_STREAM, 0);
|
||
if (_socket < 0) {
|
||
ERROR("TCPClientInterface: Unable to create socket, error " + std::to_string(errno));
|
||
return false;
|
||
}
|
||
|
||
// Set non-blocking for connect timeout
|
||
int flags = fcntl(_socket, F_GETFL, 0);
|
||
fcntl(_socket, F_SETFL, flags | O_NONBLOCK);
|
||
|
||
// Connect to server
|
||
sockaddr_in server_addr;
|
||
server_addr.sin_family = AF_INET;
|
||
server_addr.sin_addr.s_addr = _target_address;
|
||
server_addr.sin_port = htons(_target_port);
|
||
|
||
int result = ::connect(_socket, (struct sockaddr*)&server_addr, sizeof(server_addr));
|
||
if (result < 0 && errno != EINPROGRESS) {
|
||
close(_socket);
|
||
_socket = -1;
|
||
ERROR("TCPClientInterface: Connect failed, error " + std::to_string(errno));
|
||
return false;
|
||
}
|
||
|
||
// Wait for connection with timeout
|
||
fd_set write_fds;
|
||
FD_ZERO(&write_fds);
|
||
FD_SET(_socket, &write_fds);
|
||
struct timeval timeout;
|
||
timeout.tv_sec = CONNECT_TIMEOUT_MS / 1000;
|
||
timeout.tv_usec = (CONNECT_TIMEOUT_MS % 1000) * 1000;
|
||
|
||
result = select(_socket + 1, nullptr, &write_fds, nullptr, &timeout);
|
||
if (result <= 0) {
|
||
close(_socket);
|
||
_socket = -1;
|
||
DEBUG("TCPClientInterface: Connection timeout");
|
||
return false;
|
||
}
|
||
|
||
// Check if connection succeeded
|
||
int sock_error = 0;
|
||
socklen_t len = sizeof(sock_error);
|
||
getsockopt(_socket, SOL_SOCKET, SO_ERROR, &sock_error, &len);
|
||
if (sock_error != 0) {
|
||
close(_socket);
|
||
_socket = -1;
|
||
DEBUG("TCPClientInterface: Connection failed, error " + std::to_string(sock_error));
|
||
return false;
|
||
}
|
||
|
||
// Restore blocking mode for normal operation
|
||
fcntl(_socket, F_SETFL, flags);
|
||
|
||
// Configure socket options
|
||
configure_socket();
|
||
|
||
INFO("TCPClientInterface: Connected to " + _target_host + ":" + std::to_string(_target_port));
|
||
_online = true;
|
||
_frame_buffer.clear();
|
||
return true;
|
||
#endif
|
||
}
|
||
|
||
void TCPClientInterface::configure_socket() {
|
||
#ifdef ARDUINO
|
||
// Get underlying socket fd for setsockopt
|
||
int fd = _client.fd();
|
||
if (fd < 0) {
|
||
DEBUG("TCPClientInterface: Could not get socket fd for configuration");
|
||
return;
|
||
}
|
||
|
||
// TCP_NODELAY - disable Nagle's algorithm
|
||
int flag = 1;
|
||
setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &flag, sizeof(flag));
|
||
|
||
// Enable TCP keepalive
|
||
setsockopt(fd, SOL_SOCKET, SO_KEEPALIVE, &flag, sizeof(flag));
|
||
|
||
// Keepalive parameters (may not all be available on ESP32 lwIP)
|
||
#ifdef TCP_KEEPIDLE
|
||
int keepidle = TCP_KEEPIDLE_SEC;
|
||
setsockopt(fd, IPPROTO_TCP, TCP_KEEPIDLE, &keepidle, sizeof(keepidle));
|
||
#endif
|
||
#ifdef TCP_KEEPINTVL
|
||
int keepintvl = TCP_KEEPINTVL_SEC;
|
||
setsockopt(fd, IPPROTO_TCP, TCP_KEEPINTVL, &keepintvl, sizeof(keepintvl));
|
||
#endif
|
||
#ifdef TCP_KEEPCNT
|
||
int keepcnt = TCP_KEEPCNT_PROBES;
|
||
setsockopt(fd, IPPROTO_TCP, TCP_KEEPCNT, &keepcnt, sizeof(keepcnt));
|
||
#endif
|
||
|
||
TRACE("TCPClientInterface: Socket configured with TCP_NODELAY and keepalive");
|
||
|
||
#else
|
||
// TCP_NODELAY
|
||
int flag = 1;
|
||
setsockopt(_socket, IPPROTO_TCP, TCP_NODELAY, &flag, sizeof(flag));
|
||
|
||
// Enable TCP keepalive
|
||
setsockopt(_socket, SOL_SOCKET, SO_KEEPALIVE, &flag, sizeof(flag));
|
||
|
||
// Keepalive parameters
|
||
int keepidle = TCP_KEEPIDLE_SEC;
|
||
int keepintvl = TCP_KEEPINTVL_SEC;
|
||
int keepcnt = TCP_KEEPCNT_PROBES;
|
||
setsockopt(_socket, IPPROTO_TCP, TCP_KEEPIDLE, &keepidle, sizeof(keepidle));
|
||
setsockopt(_socket, IPPROTO_TCP, TCP_KEEPINTVL, &keepintvl, sizeof(keepintvl));
|
||
setsockopt(_socket, IPPROTO_TCP, TCP_KEEPCNT, &keepcnt, sizeof(keepcnt));
|
||
|
||
// TCP_USER_TIMEOUT (Linux 2.6.37+)
|
||
#ifdef TCP_USER_TIMEOUT
|
||
int user_timeout = 24000; // 24 seconds, matches Python RNS
|
||
setsockopt(_socket, IPPROTO_TCP, TCP_USER_TIMEOUT, &user_timeout, sizeof(user_timeout));
|
||
#endif
|
||
|
||
TRACE("TCPClientInterface: Socket configured with TCP_NODELAY, keepalive, and timeouts");
|
||
#endif
|
||
}
|
||
|
||
void TCPClientInterface::disconnect() {
|
||
DEBUG("TCPClientInterface: Disconnecting");
|
||
|
||
#ifdef ARDUINO
|
||
_client.stop();
|
||
#else
|
||
if (_socket >= 0) {
|
||
close(_socket);
|
||
_socket = -1;
|
||
}
|
||
#endif
|
||
|
||
_online = false;
|
||
_frame_buffer.clear();
|
||
}
|
||
|
||
void TCPClientInterface::handle_disconnect() {
|
||
if (_online) {
|
||
INFO("TCPClientInterface: Connection lost, will attempt reconnection");
|
||
disconnect();
|
||
// Reset connect attempt timer to enforce wait before reconnection
|
||
_last_connect_attempt = millis();
|
||
}
|
||
}
|
||
|
||
/*virtual*/ void TCPClientInterface::stop() {
|
||
disconnect();
|
||
}
|
||
|
||
/*virtual*/ void TCPClientInterface::loop() {
|
||
// Periodic status logging
|
||
static uint32_t last_status_log = 0;
|
||
static uint32_t loop_count = 0;
|
||
static uint32_t total_rx = 0;
|
||
loop_count++;
|
||
uint32_t now = millis();
|
||
// [TCP] connection-status heartbeat — protocol-debug only. Was at
|
||
// INFO level firing every 5s; combined with the per-frame [TCP] /
|
||
// [HDLC] / [ustore] prints below, this saturated USB CDC during
|
||
// active LXST calls and starved T:CALL_QOS responses (#75).
|
||
if (now - last_status_log >= 5000) {
|
||
last_status_log = now;
|
||
if (RNS::loglevel() >= RNS::LOG_DEBUG) {
|
||
int avail = _client.available();
|
||
Serial.printf("[TCP] connected=%d online=%d avail=%d loops=%u rx=%u buf=%d\n",
|
||
_client.connected(), _online, avail, loop_count, total_rx, (int)_frame_buffer.size());
|
||
}
|
||
loop_count = 0;
|
||
}
|
||
|
||
// Handle reconnection if not connected
|
||
if (!_online) {
|
||
if (_initiator) {
|
||
#ifdef ARDUINO
|
||
uint32_t now = millis();
|
||
#else
|
||
uint32_t now = static_cast<uint32_t>(Utilities::OS::time() * 1000);
|
||
#endif
|
||
if (now - _last_connect_attempt >= RECONNECT_WAIT_MS) {
|
||
_last_connect_attempt = now;
|
||
// Skip reconnection if memory is too low - prevents fragmentation
|
||
uint32_t max_block = ESP.getMaxAllocHeap();
|
||
if (max_block < 20000) {
|
||
Serial.printf("[TCP] Skipping reconnect - low memory (max_block=%u)\n", max_block);
|
||
} else {
|
||
DEBUG("TCPClientInterface: Attempting reconnection...");
|
||
connect();
|
||
}
|
||
}
|
||
}
|
||
return;
|
||
}
|
||
|
||
// Check connection status
|
||
// Note: ESP32 WiFiClient.connected() has known bugs where it returns false incorrectly
|
||
// See: https://github.com/espressif/arduino-esp32/issues/1714
|
||
// Workaround: only disconnect if connected() is false AND no data available
|
||
#ifdef ARDUINO
|
||
if (!_client.connected() && _client.available() == 0) {
|
||
Serial.printf("[TCP] Connection closed (connected=false, available=0)\n");
|
||
handle_disconnect();
|
||
return;
|
||
}
|
||
|
||
// Stale connection detection disabled - was causing frequent reconnects
|
||
// TODO: investigate why this triggers even when receiving data
|
||
// if (_last_data_received > 0 && (now - _last_data_received) > STALE_CONNECTION_MS) {
|
||
// WARNING("TCPClientInterface: Connection appears stale, forcing reconnection");
|
||
// handle_disconnect();
|
||
// return;
|
||
// }
|
||
|
||
// Read available data
|
||
int avail = _client.available();
|
||
if (avail > 0) {
|
||
bool dbg = RNS::loglevel() >= RNS::LOG_DEBUG;
|
||
if (dbg) Serial.printf("[TCP] Reading %d bytes\n", avail);
|
||
total_rx += avail;
|
||
_last_data_received = now; // Update stale timer on any data receipt
|
||
size_t start_pos = _frame_buffer.size();
|
||
while (_client.available() > 0) {
|
||
uint8_t byte = _client.read();
|
||
_frame_buffer.append(byte);
|
||
}
|
||
if (dbg) {
|
||
Serial.printf("[TCP] First bytes: ");
|
||
size_t dump_len = (_frame_buffer.size() - start_pos);
|
||
if (dump_len > 20) dump_len = 20;
|
||
for (size_t i = 0; i < dump_len; ++i) {
|
||
Serial.printf("%02x ", _frame_buffer.data()[start_pos + i]);
|
||
}
|
||
Serial.printf("\n");
|
||
}
|
||
}
|
||
#else
|
||
// Non-blocking read
|
||
uint8_t buf[4096];
|
||
ssize_t len = recv(_socket, buf, sizeof(buf), MSG_DONTWAIT);
|
||
if (len > 0) {
|
||
DEBUG("TCPClientInterface: Received " + std::to_string(len) + " bytes");
|
||
_frame_buffer.append(buf, len);
|
||
} else if (len == 0) {
|
||
// Connection closed by peer
|
||
DEBUG("TCPClientInterface: recv returned 0 - connection closed");
|
||
handle_disconnect();
|
||
return;
|
||
} else {
|
||
int err = errno;
|
||
if (err != EAGAIN && err != EWOULDBLOCK) {
|
||
// Socket error
|
||
ERROR("TCPClientInterface: recv error " + std::to_string(err));
|
||
handle_disconnect();
|
||
return;
|
||
}
|
||
// EAGAIN/EWOULDBLOCK - normal for non-blocking, just no data yet
|
||
}
|
||
#endif
|
||
|
||
// Process any complete frames
|
||
extract_and_process_frames();
|
||
}
|
||
|
||
void TCPClientInterface::extract_and_process_frames() {
|
||
// Find and process complete HDLC frames: [FLAG][data][FLAG]
|
||
static uint32_t frame_count = 0;
|
||
|
||
while (true) {
|
||
if (_frame_buffer.size() == 0) break;
|
||
|
||
// Find first FLAG byte
|
||
int start = -1;
|
||
for (size_t i = 0; i < _frame_buffer.size(); ++i) {
|
||
if (_frame_buffer.data()[i] == HDLC::FLAG) {
|
||
start = static_cast<int>(i);
|
||
break;
|
||
}
|
||
}
|
||
|
||
if (start < 0) {
|
||
// No FLAG found, discard buffer (garbage data before any frame)
|
||
Serial.printf("[HDLC] No FLAG in %d bytes, clearing\n", (int)_frame_buffer.size());
|
||
_frame_buffer.clear();
|
||
break;
|
||
}
|
||
|
||
// Discard data before first FLAG
|
||
if (start > 0) {
|
||
Serial.printf("[HDLC] Discarding %d bytes before FLAG\n", start);
|
||
_frame_buffer = _frame_buffer.mid(start);
|
||
}
|
||
|
||
// Find end FLAG (skip the start FLAG at position 0)
|
||
int end = -1;
|
||
for (size_t i = 1; i < _frame_buffer.size(); ++i) {
|
||
if (_frame_buffer.data()[i] == HDLC::FLAG) {
|
||
end = static_cast<int>(i);
|
||
break;
|
||
}
|
||
}
|
||
|
||
if (end < 0) {
|
||
// Incomplete frame, wait for more data
|
||
break;
|
||
}
|
||
|
||
// Extract frame content between FLAGS (excluding the FLAGS)
|
||
Bytes frame_content = _frame_buffer.mid(1, end - 1);
|
||
frame_count++;
|
||
if (RNS::loglevel() >= RNS::LOG_DEBUG) {
|
||
Serial.printf("[HDLC] Frame #%u: %d escaped bytes\n", frame_count, (int)frame_content.size());
|
||
}
|
||
|
||
// Remove processed frame from buffer (keep data after end FLAG)
|
||
_frame_buffer = _frame_buffer.mid(end);
|
||
|
||
// Skip empty frames (consecutive FLAGs)
|
||
if (frame_content.size() == 0) {
|
||
if (RNS::loglevel() >= RNS::LOG_DEBUG) Serial.printf("[HDLC] Empty frame, skipping\n");
|
||
continue;
|
||
}
|
||
|
||
// Unescape frame
|
||
Bytes unescaped = HDLC::unescape(frame_content);
|
||
if (unescaped.size() == 0) {
|
||
if (RNS::loglevel() >= RNS::LOG_DEBUG) Serial.printf("[HDLC] Unescape failed!\n");
|
||
DEBUG("TCPClientInterface: HDLC unescape error, discarding frame");
|
||
continue;
|
||
}
|
||
|
||
// Validate minimum frame size (matches Python RNS HEADER_MINSIZE check)
|
||
if (unescaped.size() < Type::Reticulum::HEADER_MINSIZE) {
|
||
TRACE("TCPClientInterface: Frame too small (" + std::to_string(unescaped.size()) + " bytes), discarding");
|
||
continue;
|
||
}
|
||
|
||
// Pass to transport layer
|
||
if (RNS::loglevel() >= RNS::LOG_DEBUG) {
|
||
Serial.printf("[TCP] Processing frame: %d bytes\n", (int)unescaped.size());
|
||
}
|
||
DEBUG(toString() + ": Received frame, " + std::to_string(unescaped.size()) + " bytes");
|
||
InterfaceImpl::handle_incoming(unescaped);
|
||
}
|
||
}
|
||
|
||
/*virtual*/ bool TCPClientInterface::send_outgoing(const Bytes& data) {
|
||
DEBUG(toString() + ".send_outgoing: data: " + std::to_string(data.size()) + " bytes");
|
||
|
||
if (!_online) {
|
||
DEBUG("TCPClientInterface: Not connected, cannot send");
|
||
return false;
|
||
}
|
||
|
||
try {
|
||
// Frame with HDLC
|
||
Bytes framed = HDLC::frame(data);
|
||
|
||
// Wire-format dumps are protocol-debug only — re-enable by
|
||
// raising RNS log level to DEBUG. At INFO they fired ~10×/s
|
||
// during voice calls (pre + post HDLC, per packet) and
|
||
// saturated USB CDC, starving T:CALL_QOS responses.
|
||
if (RNS::loglevel() >= RNS::LOG_DEBUG) {
|
||
std::string hex_preview;
|
||
size_t preview_len = (data.size() < 50) ? data.size() : 50;
|
||
for (size_t i = 0; i < preview_len; ++i) {
|
||
char buf[4];
|
||
snprintf(buf, sizeof(buf), "%02x", data.data()[i]);
|
||
hex_preview += buf;
|
||
}
|
||
if (data.size() > 50) hex_preview += "...";
|
||
DEBUG("WIRE TX raw (" + std::to_string(data.size()) + " bytes): " + hex_preview);
|
||
|
||
std::string framed_hex;
|
||
size_t flen = (framed.size() < 30) ? framed.size() : 30;
|
||
for (size_t i = 0; i < flen; ++i) {
|
||
char buf[4];
|
||
snprintf(buf, sizeof(buf), "%02x", framed.data()[i]);
|
||
framed_hex += buf;
|
||
}
|
||
if (framed.size() > 30) framed_hex += "...";
|
||
DEBUG("WIRE TX framed (" + std::to_string(framed.size()) + " bytes): " + framed_hex);
|
||
}
|
||
|
||
#ifdef ARDUINO
|
||
size_t written = _client.write(framed.data(), framed.size());
|
||
if (written != framed.size()) {
|
||
ERROR("TCPClientInterface: Write incomplete, " + std::to_string(written) +
|
||
" of " + std::to_string(framed.size()) + " bytes");
|
||
handle_disconnect();
|
||
return false;
|
||
}
|
||
_client.flush();
|
||
#else
|
||
ssize_t written = send(_socket, framed.data(), framed.size(), MSG_NOSIGNAL);
|
||
if (written < 0) {
|
||
ERROR("TCPClientInterface: send error " + std::to_string(errno));
|
||
handle_disconnect();
|
||
return false;
|
||
}
|
||
if (static_cast<size_t>(written) != framed.size()) {
|
||
ERROR("TCPClientInterface: Write incomplete, " + std::to_string(written) +
|
||
" of " + std::to_string(framed.size()) + " bytes");
|
||
handle_disconnect();
|
||
return false;
|
||
}
|
||
#endif
|
||
|
||
// Perform post-send housekeeping
|
||
InterfaceImpl::handle_outgoing(data);
|
||
return true;
|
||
|
||
} catch (std::exception& e) {
|
||
ERROR("TCPClientInterface: Exception during send: " + std::string(e.what()));
|
||
handle_disconnect();
|
||
}
|
||
return false;
|
||
}
|