From 067e4b1d6527b952a557bdb50ff40ca8e7e11286 Mon Sep 17 00:00:00 2001 From: Mathieu Carbou Date: Wed, 30 Sep 2026 11:37:31 +0200 Subject: [PATCH] fix(hoymiles): protect inverter list with a shared_mutex, harden radio queue against concurrent removal HoymilesClass::_inverters was mutated (addInverter/removeInverterBySerial, invoked from Web API handlers on the async_tcp task) while other tasks iterated the very same vector via getInverterByPos(), getInverterBySerial(), getInverterByFragment() and getNumInverters(), all without locking. A push_back() reallocation or an erase() during such an iteration could leave tasks dereferencing freed vector storage (use-after-free). removeInverterBySerial() also only locked after its unsynchronized search loop had already inspected the vector. The inverter list has a classic reader/writer profile: writes are rare (user adding/removing an inverter) while reads happen constantly (poll loop, MQTT publishing, WebSockets, Prometheus endpoint), from multiple tasks. Switch the single std::mutex to a std::shared_mutex: - addInverter()/removeInverterBySerial() take the unique lock; removeInverterBySerial() now holds it for the whole operation. - getInverterByPos()/BySerial()/ByFragment()/getNumInverters() take a shared lock, so concurrent readers no longer serialize. - Hoymiles.loop() drops its whole-body exclusive lock. It was over-broad anyway, and with a non-recursive shared_mutex it would self-deadlock as the radio layers call back into the public accessors from inside handleReceivedPackage(). All its uses go through the locked accessors; the daily-task section iterates over a locked snapshot copy. Relatedly, dropping loop()'s whole-body lock means the radio's command queue can now be emptied concurrently while a transaction is in flight (an inverter being deleted purges its pending commands). The radio code called _commandQueue.front() unconditionally, which is undefined behavior on an empty deque. Harden this by replacing ThreadSafeQueue::front() with tryFront(), which checks emptiness and fetches the element atomically and returns an empty optional when the queue was emptied. All call sites in HoymilesRadio handle that case by aborting the transaction instead of dereferencing an empty queue. Also add missing null checks after getInverterByPos() in MqttHandleInverter::loop(), MqttHandleHass::publishConfig(), WebApiPower::onPowerStatus(), WebApiLimit::onLimitStatus() and WebApiPrometheus::onPrometheusMetricsGet(), which could dereference a dangling inverter when it was removed concurrently. --- lib/Hoymiles/src/Hoymiles.cpp | 18 +++++++-- lib/Hoymiles/src/Hoymiles.h | 6 ++- lib/Hoymiles/src/HoymilesRadio.cpp | 49 ++++++++++++++++++----- lib/ThreadSafeQueue/src/ThreadSafeQueue.h | 9 ++++- src/MqttHandleHass.cpp | 3 ++ src/MqttHandleInverter.cpp | 3 ++ src/WebApi_limit.cpp | 3 ++ src/WebApi_power.cpp | 3 ++ src/WebApi_prometheus.cpp | 3 ++ 9 files changed, 81 insertions(+), 16 deletions(-) diff --git a/lib/Hoymiles/src/Hoymiles.cpp b/lib/Hoymiles/src/Hoymiles.cpp index 541dc3d3f5..1b42a2d433 100644 --- a/lib/Hoymiles/src/Hoymiles.cpp +++ b/lib/Hoymiles/src/Hoymiles.cpp @@ -43,7 +43,6 @@ void HoymilesClass::initCMT(const int8_t pin_sdio, const int8_t pin_clk, const i void HoymilesClass::loop() { - std::lock_guard lock(_mutex); _radioNrf->loop(); _radioCmt->loop(); @@ -147,7 +146,15 @@ void HoymilesClass::loop() } else { if (currentWeekDay != lastWeekDay) { - for (auto& inv : _inverters) { + // Iterate over a snapshot: the inverter list may be modified + // concurrently (e.g. by a Web API request) while the daily + // tasks are being executed. + std::vector> inverters; + { + std::shared_lock lock(_mutex); + inverters = _inverters; + } + for (auto& inv : inverters) { inv->performDailyTask(); } @@ -188,6 +195,7 @@ std::shared_ptr HoymilesClass::addInverter(const char* name, c if (i) { i->setName(name); i->init(); + std::lock_guard lock(_mutex); _inverters.push_back(std::move(i)); return _inverters.back(); } @@ -197,6 +205,7 @@ std::shared_ptr HoymilesClass::addInverter(const char* name, c std::shared_ptr HoymilesClass::getInverterByPos(const uint8_t pos) { + std::shared_lock lock(_mutex); if (pos >= _inverters.size()) { return nullptr; } else { @@ -206,6 +215,7 @@ std::shared_ptr HoymilesClass::getInverterByPos(const uint8_t std::shared_ptr HoymilesClass::getInverterBySerial(const uint64_t serial) { + std::shared_lock lock(_mutex); for (auto& inv : _inverters) { if (inv->serial() == serial) { return inv; @@ -220,6 +230,7 @@ std::shared_ptr HoymilesClass::getInverterByFragment(const fra return nullptr; } + std::shared_lock lock(_mutex); for (auto& inv : _inverters) { serial_u p; p.u64 = inv->serial(); @@ -237,9 +248,9 @@ std::shared_ptr HoymilesClass::getInverterByFragment(const fra void HoymilesClass::removeInverterBySerial(const uint64_t serial) { + std::lock_guard lock(_mutex); for (uint8_t i = 0; i < _inverters.size(); i++) { if (_inverters[i]->serial() == serial) { - std::lock_guard lock(_mutex); _inverters[i]->getRadio()->removeCommands(_inverters[i].get()); _inverters.erase(_inverters.begin() + i); return; @@ -249,6 +260,7 @@ void HoymilesClass::removeInverterBySerial(const uint64_t serial) size_t HoymilesClass::getNumInverters() const { + std::shared_lock lock(_mutex); return _inverters.size(); } diff --git a/lib/Hoymiles/src/Hoymiles.h b/lib/Hoymiles/src/Hoymiles.h index ee8fe05ba7..6c8185bf4b 100644 --- a/lib/Hoymiles/src/Hoymiles.h +++ b/lib/Hoymiles/src/Hoymiles.h @@ -8,6 +8,7 @@ #include #include #include +#include #include #define HOY_SYSTEM_CONFIG_PARA_POLL_INTERVAL (2 * 60 * 1000) // 2 minutes @@ -40,7 +41,10 @@ class HoymilesClass { std::unique_ptr _radioNrf; std::unique_ptr _radioCmt; - std::mutex _mutex; + // Protects _inverters. Writers (adding/removing inverters, e.g. from + // the Web API task) lock exclusively, readers lock shared. Mutable so + // const accessors can lock as well. + mutable std::shared_mutex _mutex; uint32_t _pollInterval = 0; uint32_t _lastPoll = 0; diff --git a/lib/Hoymiles/src/HoymilesRadio.cpp b/lib/Hoymiles/src/HoymilesRadio.cpp index 537d10ced9..8507a7d1af 100644 --- a/lib/Hoymiles/src/HoymilesRadio.cpp +++ b/lib/Hoymiles/src/HoymilesRadio.cpp @@ -44,9 +44,15 @@ bool HoymilesRadio::checkFragmentCrc(const fragment_t& fragment) const void HoymilesRadio::sendRetransmitPacket(const uint8_t fragment_id) { - CommandAbstract* cmd = _commandQueue.front().get(); + auto front = _commandQueue.tryFront(); + if (!front.has_value()) { + // The command was removed from the queue while its transaction was + // in flight (e.g. its inverter got deleted). Abort the transaction. + _busyFlag = false; + return; + } - CommandAbstract* requestCmd = cmd->getRequestFrameCommand(fragment_id); + CommandAbstract* requestCmd = front.value().get()->getRequestFrameCommand(fragment_id); if (requestCmd != nullptr) { sendEsbPacket(*requestCmd); @@ -55,8 +61,14 @@ void HoymilesRadio::sendRetransmitPacket(const uint8_t fragment_id) void HoymilesRadio::sendLastPacketAgain() { - CommandAbstract* cmd = _commandQueue.front().get(); - sendEsbPacket(*cmd); + auto front = _commandQueue.tryFront(); + if (!front.has_value()) { + // The command was removed from the queue while its transaction was + // in flight (e.g. its inverter got deleted). Abort the transaction. + _busyFlag = false; + return; + } + sendEsbPacket(*front.value().get()); } void HoymilesRadio::handleReceivedPackage() @@ -70,10 +82,13 @@ void HoymilesRadio::handleReceivedPackage() // The timeout below remains as fallback for incomplete responses. bool earlyExit = false; if (_busyFlag && !_rxTimeout.occured() && isRxBufferEmpty()) { - std::shared_ptr inv = Hoymiles.getInverterBySerial(_commandQueue.front().get()->getTargetAddress()); - if (nullptr != inv && inv->isTransactionComplete()) { - earlyExit = true; - ESP_LOGI(TAG, "RX Early Exit"); + auto front = _commandQueue.tryFront(); + if (front.has_value()) { + std::shared_ptr inv = Hoymiles.getInverterBySerial(front.value().get()->getTargetAddress()); + if (nullptr != inv && inv->isTransactionComplete()) { + earlyExit = true; + ESP_LOGI(TAG, "RX Early Exit"); + } } } @@ -81,10 +96,18 @@ void HoymilesRadio::handleReceivedPackage() if (!earlyExit) { ESP_LOGI(TAG, "RX Period End"); } - std::shared_ptr inv = Hoymiles.getInverterBySerial(_commandQueue.front().get()->getTargetAddress()); + auto front = _commandQueue.tryFront(); + if (!front.has_value()) { + // The command was removed from the queue while its transaction + // was in flight (e.g. its inverter got deleted). Abort the + // transaction instead of dereferencing an empty queue. + _busyFlag = false; + return; + } + std::shared_ptr inv = Hoymiles.getInverterBySerial(front.value().get()->getTargetAddress()); if (nullptr != inv) { - CommandAbstract* cmd = _commandQueue.front().get(); + CommandAbstract* cmd = front.value().get(); uint8_t verifyResult = inv->verifyAllFragments(*cmd); if (verifyResult == FRAGMENT_ALL_MISSING_RESEND) { ESP_LOGW(TAG, "Nothing received, resend whole request"); @@ -149,7 +172,11 @@ void HoymilesRadio::handleReceivedPackage() } else if (!_busyFlag) { // Currently in idle mode --> send packet if one is in the queue if (!isQueueEmpty()) { - CommandAbstract* cmd = _commandQueue.front().get(); + auto front = _commandQueue.tryFront(); + if (!front.has_value()) { + return; + } + CommandAbstract* cmd = front.value().get(); auto inv = Hoymiles.getInverterBySerial(cmd->getTargetAddress()); if (nullptr != inv) { diff --git a/lib/ThreadSafeQueue/src/ThreadSafeQueue.h b/lib/ThreadSafeQueue/src/ThreadSafeQueue.h index b586724793..49d1854911 100644 --- a/lib/ThreadSafeQueue/src/ThreadSafeQueue.h +++ b/lib/ThreadSafeQueue/src/ThreadSafeQueue.h @@ -43,9 +43,16 @@ class ThreadSafeQueue { _queue.push_back(item); } - T front() + // Returns the front element, or an empty optional if the queue is + // empty. Checking emptiness and fetching the element is atomic with + // respect to other queue operations, so callers cannot race with a + // concurrent pop()/erase() between the emptiness check and the fetch. + std::optional tryFront() { std::lock_guard lock(_mutex); + if (_queue.empty()) { + return {}; + } return _queue.front(); } diff --git a/src/MqttHandleHass.cpp b/src/MqttHandleHass.cpp index b0fea5f172..de1298ad7f 100644 --- a/src/MqttHandleHass.cpp +++ b/src/MqttHandleHass.cpp @@ -94,6 +94,9 @@ void MqttHandleHassClass::publishConfig() // Loop all inverters for (uint8_t i = 0; i < Hoymiles.getNumInverters(); i++) { auto inv = Hoymiles.getInverterByPos(i); + if (inv == nullptr) { + continue; + } yield(); publishInverterButton(inv, "Turn Inverter Off", "cmd/power", "0", "mdi:power-plug-off", DEVICE_CLS_NONE, STATE_CLS_NONE, CATEGORY_CONFIG); diff --git a/src/MqttHandleInverter.cpp b/src/MqttHandleInverter.cpp index 2c71af5062..be04093aee 100644 --- a/src/MqttHandleInverter.cpp +++ b/src/MqttHandleInverter.cpp @@ -39,6 +39,9 @@ void MqttHandleInverterClass::loop() // Loop all inverters for (uint8_t i = 0; i < Hoymiles.getNumInverters(); i++) { auto inv = Hoymiles.getInverterByPos(i); + if (inv == nullptr) { + continue; + } const String subtopic = inv->serialString(); diff --git a/src/WebApi_limit.cpp b/src/WebApi_limit.cpp index f8778e8fdf..9037176602 100644 --- a/src/WebApi_limit.cpp +++ b/src/WebApi_limit.cpp @@ -29,6 +29,9 @@ void WebApiLimitClass::onLimitStatus(AsyncWebServerRequest* request) for (uint8_t i = 0; i < Hoymiles.getNumInverters(); i++) { auto inv = Hoymiles.getInverterByPos(i); + if (inv == nullptr) { + continue; + } String serial = inv->serialString(); diff --git a/src/WebApi_power.cpp b/src/WebApi_power.cpp index 4bc1f19cc2..143bfe7b7c 100644 --- a/src/WebApi_power.cpp +++ b/src/WebApi_power.cpp @@ -27,6 +27,9 @@ void WebApiPowerClass::onPowerStatus(AsyncWebServerRequest* request) for (uint8_t i = 0; i < Hoymiles.getNumInverters(); i++) { auto inv = Hoymiles.getInverterByPos(i); + if (inv == nullptr) { + continue; + } LastCommandSuccess status = inv->PowerCommand()->getLastPowerCommandSuccess(); root[inv->serialString()]["power_set_status"] = WebApi.formatCommandStatus(status); diff --git a/src/WebApi_prometheus.cpp b/src/WebApi_prometheus.cpp index fdca63685a..be7143ebc3 100644 --- a/src/WebApi_prometheus.cpp +++ b/src/WebApi_prometheus.cpp @@ -70,6 +70,9 @@ void WebApiPrometheusClass::onPrometheusMetricsGet(AsyncWebServerRequest* reques for (uint8_t i = 0; i < Hoymiles.getNumInverters(); i++) { auto inv = Hoymiles.getInverterByPos(i); + if (inv == nullptr) { + continue; + } String serial = inv->serialString(); const char* name = inv->name();