Skip to content

[PR from CLI tool] Fix pointer logging warnings in MQTT library #1109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 12, 2020
Merged

[PR from CLI tool] Fix pointer logging warnings in MQTT library #1109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fac27db
Fix build warnings from logging pointers in MQTT library
Aug 11, 2020
8a0f517
Merge branch 'development' into hygiene/fix-pointer-logging-warnings
Aug 11, 2020
9559d52
Merge branch 'development' into hygiene/fix-pointer-logging-warnings
Aug 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 27 additions & 18 deletions libraries/standard/mqtt/src/mqtt.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1055,8 +1055,8 @@ static MQTTStatus_t validateSubscribeUnsubscribeParams( const MQTTContext_t * pC
{
LogError( ( "Argument cannot be NULL: pContext=%p, "
"pSubscriptionList=%p.",
pContext,
pSubscriptionList ) );
( void * ) pContext,
( void * ) pSubscriptionList ) );
status = MQTTBadParameter;
}
else if( subscriptionCount == 0UL )
Expand Down Expand Up @@ -1334,8 +1334,8 @@ static MQTTStatus_t validatePublishParams( const MQTTContext_t * pContext,
{
LogError( ( "Argument cannot be NULL: pContext=%p, "
"pPublishInfo=%p.",
pContext,
pPublishInfo ) );
( void * ) pContext,
( void * ) pPublishInfo ) );
status = MQTTBadParameter;
}
else if( ( pPublishInfo->qos != MQTTQoS0 ) && ( packetId == 0U ) )
Expand Down Expand Up @@ -1377,20 +1377,29 @@ MQTTStatus_t MQTT_Init( MQTTContext_t * pContext,
LogError( ( "Argument cannot be NULL: pContext=%p, "
"pTransportInterface=%p, "
"pNetworkBuffer=%p",
pContext,
pTransportInterface,
pNetworkBuffer ) );
( void * ) pContext,
( void * ) pTransportInterface,
( void * ) pNetworkBuffer ) );
status = MQTTBadParameter;
}
else if( ( getTimeFunction == NULL ) || ( userCallback == NULL ) ||
( pTransportInterface->recv == NULL ) || ( pTransportInterface->send == NULL ) )
else if( getTimeFunction == NULL )
{
LogError( ( "Function pointers cannot be NULL: getTimeFunction=%p, userCallback=%p, "
"transportRecv=%p, transportRecvSend=%p",
getTimeFunction,
userCallback,
pTransportInterface->recv,
pTransportInterface->send ) );
LogError( ( "Invalid parameter: getTimeFunction is NULL" ) );
Copy link
Contributor

@muneebahmed10 muneebahmed10 Aug 11, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the purpose in separating these parameters? It seems more repetitive this way, and it doesn't match the condition earlier in this function, at line 1374

Copy link
Author

@aggarw13 aggarw13 Aug 11, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The earlier implementation was printing the function pointers under a single if condition so that the reader could detect which of the function pointers is null. However, casting function pointers to void * for printing is not supported by ISO C.
GCC gives the following warning when casting function pointers to void *

/home/ubuntu/Repos/aws-iot-device-sdk-embedded-C/libraries/standard/mqtt/src/mqtt.c:1387:21: warning: format ‘%p’ expects argument of type ‘void *’, but argument 2 has type ‘MQTTGetCurrentTimeFunc_t {aka unsigned int (*)(void)}’ [-Wformat=]
         LogError( ( "Invalid parameter: getTimeFunction is NULL: %p", getTimeFunction ) );
                     ^
/home/ubuntu/Repos/aws-iot-device-sdk-embedded-C/demos/logging-stack/logging_stack.h:49:40: note: in definition of macro ‘SdkLog’
     #define SdkLog( string )    printf string
                                        ^~~~~~
/home/ubuntu/Repos/aws-iot-device-sdk-embedded-C/libraries/standard/mqtt/src/mqtt.c:1387:9: note: in expansion of macro ‘LogError’
         LogError( ( "Invalid parameter: getTimeFunction is NULL: %p", getTimeFunction ) );

status = MQTTBadParameter;
}
else if( userCallback == NULL )
{
LogError( ( "Invalid parameter: userCallback is NULL" ) );
status = MQTTBadParameter;
}
else if( pTransportInterface->recv == NULL )
{
LogError( ( "Invalid parameter: pTransportInterface->recv is NULL" ) );
status = MQTTBadParameter;
}
else if( pTransportInterface->send == NULL )
{
LogError( ( "Invalid parameter: pTransportInterface->send is NULL" ) );
status = MQTTBadParameter;
}
else
Expand Down Expand Up @@ -1429,9 +1438,9 @@ MQTTStatus_t MQTT_Connect( MQTTContext_t * pContext,
{
LogError( ( "Argument cannot be NULL: pContext=%p, "
"pConnectInfo=%p, pSessionPresent=%p.",
pContext,
pConnectInfo,
pSessionPresent ) );
( void * ) pContext,
( void * ) pConnectInfo,
( void * ) pSessionPresent ) );
status = MQTTBadParameter;
}

Expand Down
48 changes: 24 additions & 24 deletions libraries/standard/mqtt/src/mqtt_lightweight.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1042,8 +1042,8 @@ static MQTTStatus_t validateSubscriptionSerializeParams( const MQTTSubscribeInfo
{
LogError( ( "Argument cannot be NULL: pFixedBuffer=%p, "
"pSubscriptionList=%p.",
pFixedBuffer,
pSubscriptionList ) );
( void * ) pFixedBuffer,
( void * ) pSubscriptionList ) );
status = MQTTBadParameter;
}
/* A buffer must be configured for serialization. */
Expand Down Expand Up @@ -1362,9 +1362,9 @@ MQTTStatus_t MQTT_GetConnectPacketSize( const MQTTConnectInfo_t * pConnectInfo,
{
LogError( ( "Argument cannot be NULL: pConnectInfo=%p, "
"pRemainingLength=%p, pPacketSize=%p.",
pConnectInfo,
pRemainingLength,
pPacketSize ) );
( void * ) pConnectInfo,
( void * ) pRemainingLength,
( void * ) pPacketSize ) );
status = MQTTBadParameter;
}
else if( ( pConnectInfo->clientIdentifierLength == 0U ) || ( pConnectInfo->pClientIdentifier == NULL ) )
Expand Down Expand Up @@ -1458,8 +1458,8 @@ MQTTStatus_t MQTT_SerializeConnect( const MQTTConnectInfo_t * pConnectInfo,
{
LogError( ( "Argument cannot be NULL: pConnectInfo=%p, "
"pFixedBuffer=%p.",
pConnectInfo,
pFixedBuffer ) );
( void * ) pConnectInfo,
( void * ) pFixedBuffer ) );
status = MQTTBadParameter;
}
/* A buffer must be configured for serialization. */
Expand Down Expand Up @@ -1516,9 +1516,9 @@ MQTTStatus_t MQTT_GetSubscribePacketSize( const MQTTSubscribeInfo_t * pSubscript
{
LogError( ( "Argument cannot be NULL: pSubscriptionList=%p, "
"pRemainingLength=%p, pPacketSize=%p.",
pSubscriptionList,
pRemainingLength,
pPacketSize ) );
( void * ) pSubscriptionList,
( void * ) pRemainingLength,
( void * ) pPacketSize ) );
status = MQTTBadParameter;
}
else if( subscriptionCount == 0U )
Expand Down Expand Up @@ -1615,9 +1615,9 @@ MQTTStatus_t MQTT_GetUnsubscribePacketSize( const MQTTSubscribeInfo_t * pSubscri
{
LogError( ( "Argument cannot be NULL: pSubscriptionList=%p, "
"pRemainingLength=%p, pPacketSize=%p.",
pSubscriptionList,
pRemainingLength,
pPacketSize ) );
( void * ) pSubscriptionList,
( void * ) pRemainingLength,
( void * ) pPacketSize ) );
status = MQTTBadParameter;
}
else if( subscriptionCount == 0U )
Expand Down Expand Up @@ -1708,9 +1708,9 @@ MQTTStatus_t MQTT_GetPublishPacketSize( const MQTTPublishInfo_t * pPublishInfo,
{
LogError( ( "Argument cannot be NULL: pPublishInfo=%p, "
"pRemainingLength=%p, pPacketSize=%p.",
pPublishInfo,
pRemainingLength,
pPacketSize ) );
( void * ) pPublishInfo,
( void * ) pRemainingLength,
( void * ) pPacketSize ) );
status = MQTTBadParameter;
}
else if( ( pPublishInfo->pTopicName == NULL ) || ( pPublishInfo->topicNameLength == 0U ) )
Expand Down Expand Up @@ -1756,8 +1756,8 @@ MQTTStatus_t MQTT_SerializePublish( const MQTTPublishInfo_t * pPublishInfo,
{
LogError( ( "Argument cannot be NULL: pFixedBuffer=%p, "
"pPublishInfo=%p.",
pFixedBuffer,
pPublishInfo ) );
( void * ) pFixedBuffer,
( void * ) pPublishInfo ) );
status = MQTTBadParameter;
}
/* A buffer must be configured for serialization. */
Expand Down Expand Up @@ -1841,9 +1841,9 @@ MQTTStatus_t MQTT_SerializePublishHeader( const MQTTPublishInfo_t * pPublishInfo
{
LogError( ( "Argument cannot be NULL: pFixedBuffer=%p, "
"pPublishInfo=%p, pHeaderSize=%p.",
pFixedBuffer,
pPublishInfo,
pHeaderSize ) );
( void * ) pFixedBuffer,
( void * ) pPublishInfo,
( void * ) pHeaderSize ) );
status = MQTTBadParameter;
}
/* A buffer must be configured for serialization. */
Expand Down Expand Up @@ -2088,9 +2088,9 @@ MQTTStatus_t MQTT_DeserializePublish( const MQTTPacketInfo_t * pIncomingPacket,
{
LogError( ( "Argument cannot be NULL: pIncomingPacket=%p, "
"pPacketId=%p, pPublishInfo=%p",
pIncomingPacket,
pPacketId,
pPublishInfo ) );
( void * ) pIncomingPacket,
( void * ) pPacketId,
( void * ) pPublishInfo ) );
status = MQTTBadParameter;
}
else if( ( pIncomingPacket->type & 0xF0U ) != MQTT_PACKET_TYPE_PUBLISH )
Expand Down
20 changes: 10 additions & 10 deletions libraries/standard/mqtt/src/mqtt_state.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -852,8 +852,8 @@ MQTTStatus_t MQTT_UpdateStatePublish( MQTTContext_t * pMqttContext,
if( ( pMqttContext == NULL ) || ( pNewState == NULL ) )
{
LogError( ( "Argument cannot be NULL: pMqttContext=%p, pNewState=%p",
pMqttContext,
pNewState ) );
( void * ) pMqttContext,
( void * ) pNewState ) );

mqttStatus = MQTTBadParameter;
}
Expand Down Expand Up @@ -928,8 +928,8 @@ MQTTStatus_t MQTT_UpdateStateAck( MQTTContext_t * pMqttContext,
if( ( pMqttContext == NULL ) || ( pNewState == NULL ) )
{
LogError( ( "Argument cannot be NULL: pMqttContext=%p, pNewState=%p.",
pMqttContext,
pNewState ) );
( void * ) pMqttContext,
( void * ) pNewState ) );
}
else
{
Expand Down Expand Up @@ -982,11 +982,11 @@ uint16_t MQTT_PubrelToResend( const MQTTContext_t * pMqttContext,
/* Validate arguments. */
if( ( pMqttContext == NULL ) || ( pCursor == NULL ) || ( pState == NULL ) )
{
LogError( ( "Arguments cannot be NULL pMqttContext =%p, pCursor=%p"
LogError( ( "Arguments cannot be NULL pMqttContext=%p, pCursor=%p"
" pState=%p.",
pMqttContext,
pCursor,
pState ) );
( void * ) pMqttContext,
( void * ) pCursor,
( void * ) pState ) );
}
else
{
Expand Down Expand Up @@ -1018,8 +1018,8 @@ uint16_t MQTT_PublishToResend( const MQTTContext_t * pMqttContext,
if( ( pMqttContext == NULL ) || ( pCursor == NULL ) )
{
LogError( ( "Arguments cannot be NULL pMqttContext =%p, pCursor=%p",
pMqttContext,
pCursor ) );
( void * ) pMqttContext,
( void * ) pCursor ) );
}
else
{
Expand Down