fix: Prevent overwriting properties from multiple tasks

This commit is contained in:
Euripedes Rocha Filho
2026-09-22 12:35:17 +02:00
committed by Euripedes Rocha
parent a26d2adc90
commit e21ebb3e8d
4 changed files with 79 additions and 25 deletions
+18 -6
View File
@@ -220,8 +220,11 @@ esp_err_t esp_mqtt5_client_set_connect_property(esp_mqtt5_client_handle_t client
/**
* @brief Set MQTT5 client publish property configuration
*
* This API will not store the publish property, it is one-time configuration.
* Before call `esp_mqtt_client_publish` to publish data, call this API to set publish property if have
* This API stages a borrowed property pointer for one successful publish or enqueue serialization by the
* calling task. The property and all referenced data must remain valid until then. A call from the same task
* replaces its staged pointer. Publish or enqueue calls from another task proceed without this property and do
* not consume it. The owner task must not terminate before consuming the property; otherwise the slot remains
* reserved until client destruction. Reuse of a terminated task's handle cannot currently be detected.
*
* @param client mqtt client handle, must not be NULL
* @param property publish property, must not be NULL
@@ -229,6 +232,7 @@ esp_err_t esp_mqtt5_client_set_connect_property(esp_mqtt5_client_handle_t client
* @return
* - ESP_OK on success
* - ESP_ERR_INVALID_ARG if client or property is NULL
* - ESP_ERR_INVALID_STATE if another task owns the staged publish property
* - ESP_FAIL on fail
*/
esp_err_t esp_mqtt5_client_set_publish_property(esp_mqtt5_client_handle_t client,
@@ -237,8 +241,11 @@ esp_err_t esp_mqtt5_client_set_publish_property(esp_mqtt5_client_handle_t client
/**
* @brief Set MQTT5 client subscribe property configuration
*
* This API will not store the subscribe property, it is one-time configuration.
* Before call `esp_mqtt_client_subscribe` to subscribe topic, call this API to set subscribe property if have
* This API stages a borrowed property pointer for one successful subscribe serialization by the calling task.
* The property and all referenced data must remain valid until then. A call from the same task replaces its
* staged pointer. Subscribe calls from another task proceed without this property and do not consume it. The
* owner task must not terminate before consuming the property; otherwise the slot remains reserved until client
* destruction. Reuse of a terminated task's handle cannot currently be detected.
*
* @param client mqtt client handle, must not be NULL
* @param property subscribe property, must not be NULL
@@ -246,6 +253,7 @@ esp_err_t esp_mqtt5_client_set_publish_property(esp_mqtt5_client_handle_t client
* @return
* - ESP_OK on success
* - ESP_ERR_INVALID_ARG if client or property is NULL
* - ESP_ERR_INVALID_STATE if another task owns the staged subscribe property
* - ESP_FAIL on fail
*/
esp_err_t esp_mqtt5_client_set_subscribe_property(esp_mqtt5_client_handle_t client,
@@ -254,8 +262,11 @@ esp_err_t esp_mqtt5_client_set_subscribe_property(esp_mqtt5_client_handle_t clie
/**
* @brief Set MQTT5 client unsubscribe property configuration
*
* This API will not store the unsubscribe property, it is one-time configuration.
* Before call `esp_mqtt_client_unsubscribe` to unsubscribe topic, call this API to set unsubscribe property if have
* This API stages a borrowed property pointer for one successful unsubscribe serialization by the calling task.
* The property and all referenced data must remain valid until then. A call from the same task replaces its
* staged pointer. Unsubscribe calls from another task proceed without this property and do not consume it. The
* owner task must not terminate before consuming the property; otherwise the slot remains reserved until client
* destruction. Reuse of a terminated task's handle cannot currently be detected.
*
* @param client mqtt client handle, must not be NULL
* @param property unsubscribe property, must not be NULL
@@ -263,6 +274,7 @@ esp_err_t esp_mqtt5_client_set_subscribe_property(esp_mqtt5_client_handle_t clie
* @return
* - ESP_OK on success
* - ESP_ERR_INVALID_ARG if client or property is NULL
* - ESP_ERR_INVALID_STATE if another task owns the staged unsubscribe property
* - ESP_FAIL on fail
*/
esp_err_t esp_mqtt5_client_set_unsubscribe_property(esp_mqtt5_client_handle_t client,
+14 -4
View File
@@ -1,5 +1,5 @@
/*
* SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD
* SPDX-FileCopyrightText: 2022-2026 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: Apache-2.0
*/
@@ -9,6 +9,8 @@
#include "mqtt5_client.h"
#include "mqtt5_msg.h"
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#ifdef __cplusplus
extern "C" {
@@ -24,14 +26,19 @@ STAILQ_HEAD(mqtt5_topic_alias_list_t, mqtt5_topic_alias);
typedef struct mqtt5_topic_alias_list_t *mqtt5_topic_alias_handle_t;
typedef struct mqtt5_topic_alias *mqtt5_topic_alias_item_t;
typedef struct {
const void *property;
TaskHandle_t owner;
} mqtt5_staged_property_t;
typedef struct {
esp_mqtt5_connection_property_storage_t connect_property_info;
esp_mqtt5_connection_will_property_storage_t will_property_info;
esp_mqtt5_connection_server_resp_property_t server_resp_property_info;
esp_mqtt5_disconnect_property_config_t disconnect_property_info;
const esp_mqtt5_publish_property_config_t *publish_property_info;
const esp_mqtt5_subscribe_property_config_t *subscribe_property_info;
const esp_mqtt5_unsubscribe_property_config_t *unsubscribe_property_info;
mqtt5_staged_property_t publish_property;
mqtt5_staged_property_t subscribe_property;
mqtt5_staged_property_t unsubscribe_property;
mqtt5_topic_alias_handle_t peer_topic_alias;
} mqtt5_config_storage_t;
@@ -47,6 +54,9 @@ void esp_mqtt5_client_destory(esp_mqtt5_client_handle_t client);
esp_err_t esp_mqtt5_client_check_inflight_maximum(esp_mqtt5_client_handle_t client);
esp_err_t esp_mqtt5_client_publish_check(esp_mqtt5_client_handle_t client, int qos, int retain);
esp_err_t esp_mqtt5_client_subscribe_check(esp_mqtt5_client_handle_t client, int qos);
esp_err_t esp_mqtt5_staged_property_set(mqtt5_staged_property_t *slot, const void *property);
const void *esp_mqtt5_staged_property_get(const mqtt5_staged_property_t *slot);
void esp_mqtt5_staged_property_clear(mqtt5_staged_property_t *slot);
esp_err_t esp_mqtt5_create_default_config(esp_mqtt5_client_handle_t client);
esp_err_t esp_mqtt5_get_publish_data(esp_mqtt5_client_handle_t client, uint8_t *msg_buf, size_t msg_read_len,
char **msg_topic, size_t *msg_topic_len, char **msg_data, size_t *msg_data_len);
+32 -6
View File
@@ -22,6 +22,32 @@ static void esp_mqtt5_client_delete_topic_alias(mqtt5_topic_alias_handle_t topic
static esp_err_t esp_mqtt5_user_property_copy(mqtt5_user_property_handle_t user_property_new,
const mqtt5_user_property_handle_t user_property_old);
esp_err_t esp_mqtt5_staged_property_set(mqtt5_staged_property_t *slot, const void *property)
{
TaskHandle_t current_task = xTaskGetCurrentTaskHandle();
if (slot->property && slot->owner != current_task) {
return ESP_ERR_INVALID_STATE;
}
slot->property = property;
slot->owner = current_task;
return ESP_OK;
}
const void *esp_mqtt5_staged_property_get(const mqtt5_staged_property_t *slot)
{
return slot->owner == xTaskGetCurrentTaskHandle() ? slot->property : NULL;
}
void esp_mqtt5_staged_property_clear(mqtt5_staged_property_t *slot)
{
if (slot->owner == xTaskGetCurrentTaskHandle()) {
slot->property = NULL;
slot->owner = NULL;
}
}
void esp_mqtt5_increment_packet_counter(esp_mqtt5_client_handle_t client)
{
client->send_publish_packet_count ++;
@@ -530,9 +556,9 @@ esp_err_t esp_mqtt5_client_set_publish_property(esp_mqtt5_client_handle_t client
return ESP_FAIL;
}
client->mqtt5_config->publish_property_info = property;
esp_err_t ret = esp_mqtt5_staged_property_set(&client->mqtt5_config->publish_property, property);
MQTT_API_UNLOCK(client);
return ESP_OK;
return ret;
}
esp_err_t esp_mqtt5_client_set_subscribe_property(esp_mqtt5_client_handle_t client,
@@ -583,9 +609,9 @@ esp_err_t esp_mqtt5_client_set_subscribe_property(esp_mqtt5_client_handle_t clie
}
}
client->mqtt5_config->subscribe_property_info = property;
esp_err_t ret = esp_mqtt5_staged_property_set(&client->mqtt5_config->subscribe_property, property);
MQTT_API_UNLOCK(client);
return ESP_OK;
return ret;
}
esp_err_t esp_mqtt5_client_set_unsubscribe_property(esp_mqtt5_client_handle_t client,
@@ -624,9 +650,9 @@ esp_err_t esp_mqtt5_client_set_unsubscribe_property(esp_mqtt5_client_handle_t cl
}
}
client->mqtt5_config->unsubscribe_property_info = property;
esp_err_t ret = esp_mqtt5_staged_property_set(&client->mqtt5_config->unsubscribe_property, property);
MQTT_API_UNLOCK(client);
return ESP_OK;
return ret;
}
esp_err_t esp_mqtt5_client_set_disconnect_property(esp_mqtt5_client_handle_t client,
+15 -9
View File
@@ -2405,12 +2405,14 @@ int esp_mqtt_client_subscribe_multiple(esp_mqtt_client_handle_t client,
return -1;
}
const esp_mqtt5_subscribe_property_config_t *property =
esp_mqtt5_staged_property_get(&client->mqtt5_config->subscribe_property);
mqtt5_msg_subscribe(&client->mqtt_state.connection,
topic_list, size,
&client->mqtt_state.pending_msg_id, client->mqtt5_config->subscribe_property_info);
&client->mqtt_state.pending_msg_id, property);
if (client->mqtt_state.connection.outbound_message.length) {
client->mqtt5_config->subscribe_property_info = NULL;
if (property && client->mqtt_state.connection.outbound_message.length) {
esp_mqtt5_staged_property_clear(&client->mqtt5_config->subscribe_property);
}
#endif
@@ -2471,12 +2473,14 @@ int esp_mqtt_client_unsubscribe(esp_mqtt_client_handle_t client, const char *top
if (client->mqtt_state.connection.information.protocol_ver == MQTT_PROTOCOL_V_5) {
#ifdef MQTT_PROTOCOL_5
const esp_mqtt5_unsubscribe_property_config_t *property =
esp_mqtt5_staged_property_get(&client->mqtt5_config->unsubscribe_property);
mqtt5_msg_unsubscribe(&client->mqtt_state.connection,
topic,
&client->mqtt_state.pending_msg_id, client->mqtt5_config->unsubscribe_property_info);
&client->mqtt_state.pending_msg_id, property);
if (client->mqtt_state.connection.outbound_message.length) {
client->mqtt5_config->unsubscribe_property_info = NULL;
if (property && client->mqtt_state.connection.outbound_message.length) {
esp_mqtt5_staged_property_clear(&client->mqtt5_config->unsubscribe_property);
}
#endif
@@ -2521,14 +2525,16 @@ static int make_publish(esp_mqtt_client_handle_t client, const char *topic, cons
if (client->mqtt_state.connection.information.protocol_ver == MQTT_PROTOCOL_V_5) {
#ifdef MQTT_PROTOCOL_5
const esp_mqtt5_publish_property_config_t *property =
esp_mqtt5_staged_property_get(&client->mqtt5_config->publish_property);
mqtt5_msg_publish(&client->mqtt_state.connection,
topic, data, len,
qos, retain,
&pending_msg_id, client->mqtt5_config->publish_property_info,
&pending_msg_id, property,
client->mqtt5_config->server_resp_property_info.response_info);
if (client->mqtt_state.connection.outbound_message.length) {
client->mqtt5_config->publish_property_info = NULL;
if (property && client->mqtt_state.connection.outbound_message.length) {
esp_mqtt5_staged_property_clear(&client->mqtt5_config->publish_property);
}
#endif