Skip to content
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

Update Cellular_CommonInit error handling #163

Merged
merged 3 commits into from
Jan 31, 2024
Merged

Update Cellular_CommonInit error handling #163

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
0801794
Update Cellular_CommonInit error handling
chinglee-iot Jan 30, 2024
d12f5d2
Update size table
chinglee-iot Jan 30, 2024
6d7d5b9
Update CBMC for Cellular_CommonInit
chinglee-iot Jan 31, 2024
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
4 changes: 2 additions & 2 deletions docs/doxygen/include/size_table.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
<tr>
<td>cellular_common_api.c</td>
<td><center>0.7K</center></td>
<td><center>0.6K</center></td>
<td><center>0.7K</center></td>
</tr>
<tr>
<td>cellular_common.c</td>
Expand All @@ -45,6 +45,6 @@
<tr>
<td><b>Total estimates</b></td>
<td><b><center>15.1K</center></b></td>
<td><b><center>13.6K</center></b></td>
<td><b><center>13.7K</center></b></td>
</tr>
</table>
61 changes: 47 additions & 14 deletions source/cellular_common_api.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,25 +146,58 @@ CellularError_t Cellular_CommonInit( CellularHandle_t * pCellularHandle,
CellularError_t cellularStatus = CELLULAR_SUCCESS;
CellularContext_t * pContext = NULL;

/* Init the common library. */
cellularStatus = _Cellular_LibInit( pCellularHandle, pCommInterface, pTokenTable );

/* Init the module. */
if( cellularStatus == CELLULAR_SUCCESS )
if( pCellularHandle == NULL )
{
pContext = *pCellularHandle;
cellularStatus = Cellular_ModuleInit( pContext, &pContext->pModuleContext );
LogError( ( "Cellular_CommonInit pCellularHandle is NULL." ) );
cellularStatus = CELLULAR_INVALID_HANDLE;
}

/* Setup UE, URC and query register status. */
if( cellularStatus == CELLULAR_SUCCESS )
else if( pCommInterface == NULL )
{
cellularStatus = Cellular_ModuleEnableUE( pContext );
LogError( ( "Cellular_CommonInit pCommInterface is NULL." ) );
cellularStatus = CELLULAR_BAD_PARAMETER;
}

if( cellularStatus == CELLULAR_SUCCESS )
else if( pTokenTable == NULL )
{
LogError( ( "Cellular_CommonInit pTokenTable is NULL." ) );
cellularStatus = CELLULAR_BAD_PARAMETER;
}
else
{
cellularStatus = Cellular_ModuleEnableUrc( pContext );
/* Init the common library. */
cellularStatus = _Cellular_LibInit( pCellularHandle, pCommInterface, pTokenTable );

if( cellularStatus == CELLULAR_SUCCESS )
{
pContext = ( CellularContext_t * ) ( *pCellularHandle );

cellularStatus = Cellular_ModuleInit( pContext, &pContext->pModuleContext );

if( cellularStatus == CELLULAR_SUCCESS )
{
cellularStatus = Cellular_ModuleEnableUE( pContext );

if( cellularStatus == CELLULAR_SUCCESS )
{
cellularStatus = Cellular_ModuleEnableUrc( pContext );
}

if( cellularStatus != CELLULAR_SUCCESS )
{
/* Clean up the resource allocated by cellular module here if
* Cellular_ModuleEnableUE or Cellular_ModuleEnableUrc returns
* error. */
( void ) Cellular_ModuleCleanUp( pContext );
}
}

if( cellularStatus != CELLULAR_SUCCESS )
{
/* Clean up the resource in cellular common library if any of the
* module port function returns error. Error returned by _Cellular_LibInit
* is already handled in the implementation. */
( void ) _Cellular_LibCleanup( pContext );
}
}
}

return cellularStatus;
Expand Down
4 changes: 3 additions & 1 deletion test/cbmc/proofs/Cellular_CommonInit/Cellular_CommonInit_harness.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,5 +96,7 @@ void harness()
* Initialize the member of Cellular_CommonInit.
****************************************************************/

Cellular_CommonInit( nondet_bool() ? NULL : &pHandle, &CellularCommInterface, &tokenTable );
Cellular_CommonInit( nondet_bool() ? NULL : &pHandle,
nondet_bool() ? NULL : &CellularCommInterface,
nondet_bool() ? NULL : &tokenTable );
}
4 changes: 3 additions & 1 deletion test/cbmc/proofs/Cellular_CommonInit/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ HARNESS_ENTRY=harness
HARNESS_FILE=Cellular_CommonInit_harness
PROOF_UID = Cellular_CommonInit

DEFINES +=
DEFINES += -DCBMC_TEST_CELLULAR_MODULE_RETURN_ERROR=1
INCLUDES +=

PROOF_SOURCES += $(PROOFDIR)/$(HARNESS_FILE).c
Expand All @@ -35,4 +35,6 @@ PROOF_SOURCES += $(SRCDIR)/test/cbmc/sources/cellular_modules.c
PROJECT_SOURCES += $(SRCDIR)/source/cellular_common_api.c
PROJECT_SOURCES += $(SRCDIR)/source/cellular_common.c

UNWINDSET += __CPROVER_file_local_cellular_common_c_libClose.0:20

include ../Makefile.common
73 changes: 48 additions & 25 deletions test/cbmc/sources/cellular_modules.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,41 +33,64 @@
/* Include paths for public enums, structures, and macros. */
#include "cellular_common_portable.h"

CellularError_t Cellular_ModuleInit( const CellularContext_t * pContext,
void ** ppModuleContext )
{
CellularError_t ret = nondet_int();
#if ( CBMC_TEST_CELLULAR_MODULE_RETURN_ERROR == 1 )

__CPROVER_assume( ret >= CELLULAR_SUCCESS && ret <= CELLULAR_UNKNOWN );
return ret;
}
CellularError_t Cellular_ModuleInit( const CellularContext_t * pContext,
void ** ppModuleContext )
{
CellularError_t ret = nondet_int();

__CPROVER_assume( ret >= CELLULAR_SUCCESS && ret <= CELLULAR_UNKNOWN );
return ret;
}

CellularError_t Cellular_ModuleCleanUp( const CellularContext_t * pContext )
{
CellularError_t ret = nondet_int();
CellularError_t Cellular_ModuleCleanUp( const CellularContext_t * pContext )
{
CellularError_t ret = nondet_int();

__CPROVER_assume( ret >= CELLULAR_SUCCESS && ret <= CELLULAR_UNKNOWN );
return ret;
}
__CPROVER_assume( ret >= CELLULAR_SUCCESS && ret <= CELLULAR_UNKNOWN );
return ret;
}

CellularError_t Cellular_ModuleEnableUE( CellularContext_t * pContext )
{
CellularError_t ret = nondet_int();

CellularError_t Cellular_ModuleEnableUE( CellularContext_t * pContext )
{
CellularError_t ret = nondet_int();
__CPROVER_assume( ret >= CELLULAR_SUCCESS && ret <= CELLULAR_UNKNOWN );
return ret;
}

__CPROVER_assume( ret >= CELLULAR_SUCCESS && ret <= CELLULAR_UNKNOWN );
return ret;
}
CellularError_t Cellular_ModuleEnableUrc( CellularContext_t * pContext )
{
CellularError_t ret = nondet_int();

__CPROVER_assume( ret >= CELLULAR_SUCCESS && ret <= CELLULAR_UNKNOWN );
return ret;
}

CellularError_t Cellular_ModuleEnableUrc( CellularContext_t * pContext )
{
CellularError_t ret = nondet_int();
#else /* #if ( CBMC_TEST_CELLULAR_MODULE_NO_ERROR == 1 ) */

__CPROVER_assume( ret >= CELLULAR_SUCCESS && ret <= CELLULAR_UNKNOWN );
return ret;
}
CellularError_t Cellular_ModuleInit( const CellularContext_t * pContext,
void ** ppModuleContext )
{
return CELLULAR_SUCCESS;
}

CellularError_t Cellular_ModuleCleanUp( const CellularContext_t * pContext )
{
return CELLULAR_SUCCESS;
}

CellularError_t Cellular_ModuleEnableUE( CellularContext_t * pContext )
{
return CELLULAR_SUCCESS;
}

CellularError_t Cellular_ModuleEnableUrc( CellularContext_t * pContext )
{
return CELLULAR_SUCCESS;
}

#endif /* #if ( CBMC_TEST_CELLULAR_MODULE_NO_ERROR == 1 ) */

/* ========================================================================== */
Loading
Loading