Skip to content

Commit cd81773

Browse files
euripedesrochaeuripedesrocha
committed
Merge branch 'fix/format_log_messages' into 'master'
fix: LOG format strings See merge request espressif/esp-mqtt!187
2 parents 395aa14 + a3b04f2 commit cd81773

File tree

5 files changed

+27
-17
lines changed

5 files changed

+27
-17
lines changed

‎CMakeLists.txt‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,3 @@ idf_component_register(SRCS "${srcs}"
1212
PRIV_REQUIRES esp_timer http_parser esp_hw_support heap
1313
KCONFIG ${CMAKE_CURRENT_LIST_DIR}/Kconfig
1414
)
15-
target_compile_options(${COMPONENT_LIB} PRIVATE "-Wno-format")

‎lib/include/mqtt_client_priv.h‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,14 @@
3939
extern "C" {
4040
#endif
4141

42+
#if CONFIG_NEWLIB_NANO_FORMAT
43+
#define NEWLIB_NANO_COMPAT_FORMAT PRIu32
44+
#define NEWLIB_NANO_COMPAT_CAST(size_t_var) (uint32_t)size_t_var
45+
#else
46+
#define NEWLIB_NANO_COMPAT_FORMAT "zu"
47+
#define NEWLIB_NANO_COMPAT_CAST(size_t_var) size_t_var
48+
#endif
49+
4250
#ifdef MQTT_DISABLE_API_LOCKS
4351
# define MQTT_API_LOCK(c)
4452
# define MQTT_API_UNLOCK(c)

‎lib/mqtt5_msg.c‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -339,7 +339,7 @@ char *mqtt5_get_publish_property_payload(uint8_t *buffer, size_t buffer_length,
339339
continue;
340340
case MQTT5_PROPERTY_MESSAGE_EXPIRY_INTERVAL:
341341
MQTT5_CONVERT_ONE_BYTE_TO_FOUR(resp_property->message_expiry_interval, property[property_offset ++], property[property_offset ++], property[property_offset ++], property[property_offset ++])
342-
ESP_LOGD(TAG, "MQTT5_PROPERTY_MESSAGE_EXPIRY_INTERVAL %d", resp_property->message_expiry_interval);
342+
ESP_LOGD(TAG, "MQTT5_PROPERTY_MESSAGE_EXPIRY_INTERVAL %"PRIu32, resp_property->message_expiry_interval);
343343
continue;
344344
case MQTT5_PROPERTY_TOPIC_ALIAS:
345345
MQTT5_CONVERT_ONE_BYTE_TO_TWO(resp_property->topic_alias, property[property_offset ++], property[property_offset ++])
@@ -603,7 +603,7 @@ esp_err_t mqtt5_msg_parse_connack_property(uint8_t *buffer, size_t buffer_len, m
603603
switch (property_id) {
604604
case MQTT5_PROPERTY_SESSION_EXPIRY_INTERVAL:
605605
MQTT5_CONVERT_ONE_BYTE_TO_FOUR(connection_property->session_expiry_interval, property[property_offset ++], property[property_offset ++], property[property_offset ++], property[property_offset ++])
606-
ESP_LOGD(TAG, "MQTT5_PROPERTY_SESSION_EXPIRY_INTERVAL %d", connection_property->session_expiry_interval);
606+
ESP_LOGD(TAG, "MQTT5_PROPERTY_SESSION_EXPIRY_INTERVAL %"PRIu32, connection_property->session_expiry_interval);
607607
continue;
608608
case MQTT5_PROPERTY_RECEIVE_MAXIMUM:
609609
MQTT5_CONVERT_ONE_BYTE_TO_TWO(resp_property->receive_maximum, property[property_offset ++], property[property_offset ++])
@@ -619,7 +619,7 @@ esp_err_t mqtt5_msg_parse_connack_property(uint8_t *buffer, size_t buffer_len, m
619619
continue;
620620
case MQTT5_PROPERTY_MAXIMUM_PACKET_SIZE:
621621
MQTT5_CONVERT_ONE_BYTE_TO_FOUR(resp_property->maximum_packet_size, property[property_offset ++], property[property_offset ++], property[property_offset ++], property[property_offset ++])
622-
ESP_LOGD(TAG, "MQTT5_PROPERTY_MAXIMUM_PACKET_SIZE %d", resp_property->maximum_packet_size);
622+
ESP_LOGD(TAG, "MQTT5_PROPERTY_MAXIMUM_PACKET_SIZE %"PRIu32, resp_property->maximum_packet_size);
623623
continue;
624624
case MQTT5_PROPERTY_ASSIGNED_CLIENT_IDENTIFIER:
625625
MQTT5_CONVERT_ONE_BYTE_TO_TWO(len, property[property_offset ++], property[property_offset ++])

‎lib/mqtt_outbox.c‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ outbox_item_handle_t outbox_enqueue(outbox_handle_t outbox, outbox_message_handl
6060
}
6161
STAILQ_INSERT_TAIL(outbox->list, item, next);
6262
outbox->size += item->len;
63-
ESP_LOGD(TAG, "ENQUEUE msgid=%d, msg_type=%d, len=%d, size=%d", message->msg_id, message->msg_type, message->len + message->remaining_len, outbox_get_size(outbox));
63+
ESP_LOGD(TAG, "ENQUEUE msgid=%d, msg_type=%d, len=%d, size=%"PRIu64, message->msg_id, message->msg_type, message->len + message->remaining_len, outbox_get_size(outbox));
6464
return item;
6565
}
6666

@@ -125,7 +125,7 @@ esp_err_t outbox_delete(outbox_handle_t outbox, int msg_id, int msg_type)
125125
outbox->size -= item->len;
126126
free(item->buffer);
127127
free(item);
128-
ESP_LOGD(TAG, "DELETED msgid=%d, msg_type=%d, remain size=%d", msg_id, msg_type, outbox_get_size(outbox));
128+
ESP_LOGD(TAG, "DELETED msgid=%d, msg_type=%d, remain size=%"PRIu64, msg_id, msg_type, outbox_get_size(outbox));
129129
return ESP_OK;
130130
}
131131

‎mqtt_client.c‎

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1037,7 +1037,7 @@ static esp_err_t deliver_publish(esp_mqtt_client_handle_t client)
10371037
ESP_LOGE(TAG, "%s: mqtt_get_publish_topic() failed", __func__);
10381038
return ESP_FAIL;
10391039
}
1040-
ESP_LOGD(TAG, "%s: msg_topic_len=%"PRIu32, __func__, msg_topic_len);
1040+
ESP_LOGD(TAG, "%s: msg_topic_len=%"NEWLIB_NANO_COMPAT_FORMAT, __func__, NEWLIB_NANO_COMPAT_CAST(msg_topic_len));
10411041

10421042
// get payload
10431043
msg_data = mqtt_get_publish_data(msg_buf, &msg_data_len);
@@ -1059,8 +1059,9 @@ static esp_err_t deliver_publish(esp_mqtt_client_handle_t client)
10591059
client->event.dup = mqtt_get_dup(msg_buf);
10601060
client->event.total_data_len = msg_data_len + msg_total_len - msg_read_len;
10611061
post_data_event:
1062-
ESP_LOGD(TAG, "Get data len= %"PRIu32", topic len=%"PRIu32", total_data: %d offset: %"PRIu32, msg_data_len, msg_topic_len,
1063-
client->event.total_data_len, msg_data_offset);
1062+
ESP_LOGD(TAG, "Get data len= %"NEWLIB_NANO_COMPAT_FORMAT", topic len=%"NEWLIB_NANO_COMPAT_FORMAT", total_data: %d offset: %"NEWLIB_NANO_COMPAT_FORMAT,
1063+
NEWLIB_NANO_COMPAT_CAST(msg_data_len), NEWLIB_NANO_COMPAT_CAST(msg_topic_len),
1064+
client->event.total_data_len, NEWLIB_NANO_COMPAT_CAST(msg_data_offset));
10641065
client->event.event_id = MQTT_EVENT_DATA;
10651066
client->event.data = msg_data_len > 0 ? msg_data : NULL;
10661067
client->event.data_len = msg_data_len;
@@ -1218,7 +1219,7 @@ static int mqtt_message_receive(esp_mqtt_client_handle_t client, int read_poll_t
12181219
} while ((client->mqtt_state.in_buffer_read_len < 6) && (*(buf - 1) & 0x80));
12191220
}
12201221
total_len = mqtt_get_total_length(client->mqtt_state.in_buffer, client->mqtt_state.in_buffer_read_len, &fixed_header_len);
1221-
ESP_LOGD(TAG, "%s: total message length: %d (already read: %"PRIu32")", __func__, total_len, client->mqtt_state.in_buffer_read_len);
1222+
ESP_LOGD(TAG, "%s: total message length: %d (already read: %"NEWLIB_NANO_COMPAT_FORMAT")", __func__, total_len, NEWLIB_NANO_COMPAT_CAST(client->mqtt_state.in_buffer_read_len));
12221223
client->mqtt_state.message_length = total_len;
12231224
if (client->mqtt_state.in_buffer_length < total_len) {
12241225
if (mqtt_get_type(client->mqtt_state.in_buffer) == MQTT_MSG_TYPE_PUBLISH) {
@@ -1236,8 +1237,8 @@ static int mqtt_message_receive(esp_mqtt_client_handle_t client, int read_poll_t
12361237
client->mqtt_state.in_buffer_read_len += read_len;
12371238
buf += read_len;
12381239
if (client->mqtt_state.in_buffer_read_len < fixed_header_len + 2) {
1239-
ESP_LOGD(TAG, "%s: transport_read(): message reading left in progress :: total message length: %d (already read: %"PRIu32")",
1240-
__func__, total_len, client->mqtt_state.in_buffer_read_len);
1240+
ESP_LOGD(TAG, "%s: transport_read(): message reading left in progress :: total message length: %d (already read: %"NEWLIB_NANO_COMPAT_FORMAT")",
1241+
__func__, total_len, NEWLIB_NANO_COMPAT_CAST(client->mqtt_state.in_buffer_read_len));
12411242
return 0;
12421243
}
12431244
}
@@ -1266,12 +1267,13 @@ static int mqtt_message_receive(esp_mqtt_client_handle_t client, int read_poll_t
12661267
}
12671268
client->mqtt_state.in_buffer_read_len += read_len;
12681269
if (client->mqtt_state.in_buffer_read_len < total_len) {
1269-
ESP_LOGD(TAG, "%s: transport_read(): message reading left in progress :: total message length: %d (already read: %"PRIu32")",
1270-
__func__, total_len, client->mqtt_state.in_buffer_read_len);
1270+
ESP_LOGD(TAG, "%s: transport_read(): message reading left in progress :: total message length: %d (already read: %"NEWLIB_NANO_COMPAT_FORMAT")",
1271+
__func__, total_len, NEWLIB_NANO_COMPAT_CAST(client->mqtt_state.in_buffer_read_len));
12711272
return 0;
12721273
}
12731274
}
1274-
ESP_LOGD(TAG, "%s: transport_read():%"PRIu32" %"PRIu32, __func__, client->mqtt_state.in_buffer_read_len, client->mqtt_state.message_length);
1275+
ESP_LOGD(TAG, "%s: transport_read():%"NEWLIB_NANO_COMPAT_FORMAT" %"NEWLIB_NANO_COMPAT_FORMAT, __func__,
1276+
NEWLIB_NANO_COMPAT_CAST(client->mqtt_state.in_buffer_read_len), NEWLIB_NANO_COMPAT_CAST(client->mqtt_state.message_length));
12751277
return 1;
12761278
err:
12771279
esp_mqtt_client_dispatch_transport_error(client);
@@ -1313,7 +1315,8 @@ static esp_err_t mqtt_process_receive(esp_mqtt_client_handle_t client)
13131315
#ifdef MQTT_PROTOCOL_5
13141316
esp_mqtt5_parse_suback(client);
13151317
#endif
1316-
ESP_LOGD(TAG, "deliver_suback, message_length_read=%"PRIu32", message_length=%"PRIu32, client->mqtt_state.in_buffer_read_len, client->mqtt_state.message_length);
1318+
ESP_LOGD(TAG, "deliver_suback, message_length_read=%"NEWLIB_NANO_COMPAT_FORMAT", message_length=%"NEWLIB_NANO_COMPAT_FORMAT,
1319+
NEWLIB_NANO_COMPAT_CAST(client->mqtt_state.in_buffer_read_len), NEWLIB_NANO_COMPAT_CAST(client->mqtt_state.message_length));
13171320
if (deliver_suback(client) != ESP_OK) {
13181321
ESP_LOGE(TAG, "Failed to deliver suback message id=%d", msg_id);
13191322
return ESP_FAIL;
@@ -1331,7 +1334,7 @@ static esp_err_t mqtt_process_receive(esp_mqtt_client_handle_t client)
13311334
}
13321335
break;
13331336
case MQTT_MSG_TYPE_PUBLISH:
1334-
ESP_LOGD(TAG, "deliver_publish, message_length_read=%"PRIu32", message_length=%"PRIu32, client->mqtt_state.in_buffer_read_len, client->mqtt_state.message_length);
1337+
ESP_LOGD(TAG, "deliver_publish, message_length_read=%"NEWLIB_NANO_COMPAT_FORMAT", message_length=%"NEWLIB_NANO_COMPAT_FORMAT, NEWLIB_NANO_COMPAT_CAST(client->mqtt_state.in_buffer_read_len), NEWLIB_NANO_COMPAT_CAST(client->mqtt_state.message_length));
13351338
if (deliver_publish(client) != ESP_OK) {
13361339
ESP_LOGE(TAG, "Failed to deliver publish message id=%d", msg_id);
13371340
return ESP_FAIL;

0 commit comments

Comments
 (0)