In this memory leak, two problems were found.
Please comment if there is any problem as the modified code will be deployed.
1. Memory leak in Wiced_aws_create_endpoint function
By adding the following “★ Additional code ★”, the heap area of the Wiced_aws_create_endpoint function is released.
◆MQTT disconnect Additional code
==========
if (0 != g_aws_connection) {
//↓↓↓★Additional code★↓↓↓
p_aws = (wiced_aws_internal_handle_t*)g_aws_connection;
mqtt_object = p_aws->mqtt.base;
if(NULL != mqtt_object) {
p_mqtt_conn = (mqtt_connection_t*)mqtt_object;
}
//↑↑↑★Additional code★↑↑↑
/* AWS disconnect */
wiced_result = wiced_aws_disconnect(g_aws_connection);
/* semaphore deinit */
wiced_result = wiced_rtos_deinit_semaphore(&s_event_semaphore);
//↓↓↓★Additional code★↓↓↓
if(NULL != p_mqtt_conn) {
wiced_result = mqtt_core_deinit(p_mqtt_conn);
}
if(NULL != mqtt_object) {
free(mqtt_object);
}
//↑↑↑★Additional code★↑↑↑
}
wiced_result = wiced_aws_deinit();
==========
2. Memory leak in wiced_aws_connect function
aws_internal_mqtt_connect of the wiced_aws_connect function >> In the wiced_mqtt_connect function, when the connection fails with the mqtt_connect function, there is no release of the heap area secured by the mqtt_connection_init function, resulting in a memory leak.
The following "★ Update code ★" has been added to release the heap area of the mqtt_connection_init function.
◆wiced_mqtt_connect function
==========
wiced_result_t wiced_mqtt_connect( wiced_mqtt_object_t mqtt_obj, wiced_ip_address_t *address, wiced_interface_t interface, wiced_mqtt_callback_t callback, wiced_mqtt_security_t *security, wiced_mqtt_pkt_connect_t *conninfo )
{
・・・
result = mqtt_connection_init( address, conninfo->port_number, interface, callback, conn, security );
・・・
#if 0
//↓↓↓★Memory Leak★↓↓↓
// If there is an error in the mqtt_connect function, the heap area allocated by the mqtt_connection_init function will not be released.
return mqtt_connect( conn, &args, &session );
//↑↑↑★Memory Leak★↑↑↑
#endif
#if 1
//↓↓↓★Update code★↓↓↓
result = mqtt_connect( conn, &args, &session );
if ( result != WICED_SUCCESS )
{
mqtt_connection_deinit(conn);
WPRINT_LIB_INFO(("[MQTT LIB] : mqtt_connect error - mqtt_connection_deinit! \n"));
}
return result;
//↑↑↑★Update code★↑↑↑
#endif
}
==========
<Japanese>
今回のメモリリークは、大きく２点の問題が発見されました。
修正コードを展開しますので、問題がないかコメントをお願いします。
１．Wiced_aws_create_endpoint関数のメモリーリーク
以下の「★Additional code★」の追加により、Wiced_aws_create_endpoint関数のヒープ領域の解放をおこなっています。
◆MQTT disconnect Additional code
==========
if (0 != g_aws_connection) {
//↓↓↓★Additional code★↓↓↓
p_aws = (wiced_aws_internal_handle_t*)g_aws_connection;
mqtt_object = p_aws->mqtt.base;
if(NULL != mqtt_object) {
p_mqtt_conn = (mqtt_connection_t*)mqtt_object;
}
//↑↑↑★Additional code★↑↑↑
/* AWS disconnect */
wiced_result = wiced_aws_disconnect(g_aws_connection);
/* semaphore deinit */
wiced_result = wiced_rtos_deinit_semaphore(&s_event_semaphore);
//↓↓↓★Additional code★↓↓↓
if(NULL != p_mqtt_conn) {
wiced_result = mqtt_core_deinit(p_mqtt_conn);
}
if(NULL != mqtt_object) {
free(mqtt_object);
}
//↑↑↑★Additional code★↑↑↑
}
wiced_result = wiced_aws_deinit();
==========
２．wiced_aws_connect関数のメモリーリーク
wiced_aws_connect関数のaws_internal_mqtt_connect >> wiced_mqtt_connect関数で、mqtt_connect関数で接続失敗時に、mqtt_connection_init関数で確保したヒープ領域の解放がないため、メモリリークしている。
以下の「★Update code★」の追加により、mqtt_connection_init関数のヒープ領域の解放をおこなっています。
◆wiced_mqtt_connect関数
==========
wiced_result_t wiced_mqtt_connect( wiced_mqtt_object_t mqtt_obj, wiced_ip_address_t *address, wiced_interface_t interface, wiced_mqtt_callback_t callback, wiced_mqtt_security_t *security, wiced_mqtt_pkt_connect_t *conninfo )
{
・・・
result = mqtt_connection_init( address, conninfo->port_number, interface, callback, conn, security );
・・・
#if 0
//↓↓↓★Memory Leak★↓↓↓
// mqtt_connect関数にエラーがある場合、mqtt_connection_init関数で確保したヒープ領域が解放されません。
return mqtt_connect( conn, &args, &session );
//↑↑↑★Memory Leak★↑↑↑
#endif
#if 1
//↓↓↓★Update code★↓↓↓
result = mqtt_connect( conn, &args, &session );
if ( result != WICED_SUCCESS )
{
mqtt_connection_deinit(conn);
WPRINT_LIB_INFO(("[MQTT LIB] : mqtt_connect error - mqtt_connection_deinit! \n"));
}
return result;
//↑↑↑★Update code★↑↑↑
#endif
}
