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.

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 CBMC starter kit #99

Merged
merged 4 commits into from
Jul 15, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 0 additions & 6 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
[submodule "test/unit-test/CMock"]
path = test/unit-test/CMock
url = https://github.com/ThrowTheSwitch/CMock
[submodule "test/cbmc/aws-templates-for-cbmc-proofs"]
path = test/cbmc/aws-templates-for-cbmc-proofs
url = https://github.com/awslabs/aws-templates-for-cbmc-proofs.git
[submodule "test/cbmc/litani"]
path = test/cbmc/litani
url = https://github.com/awslabs/aws-build-accumulator
[submodule "modules/ThirdParty/Community-Supported-Ports"]
path = modules/ThirdParty/Community-Supported-Ports
url = https://github.com/FreeRTOS/FreeRTOS-Cellular-Interface-Community-Supported-Ports
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,14 @@ git submodule update --checkout --init --recursive test/unit-test/CMock

1. Run `cd build && ctest` to execute all tests and view the test run summary.

## CBMC

To learn more about CBMC and proofs specifically, review the training material [here](https://model-checking.github.io/cbmc-training).

The `test/cbmc/proofs` directory contains CBMC proofs.

In order to run these proofs you will need to install CBMC and other tools by following the instructions [here](https://model-checking.github.io/cbmc-training/installation.html).

## Reference examples

Please refer to the demos of the Cellular Interface library [here](https://github.com/FreeRTOS/FreeRTOS/tree/main/FreeRTOS-Plus/Demo/FreeRTOS_Cellular_Interface_Windows_Simulator) using FreeRTOS on the Windows simulator platform. These can be used as reference examples for the library API.
Expand Down
1 change: 0 additions & 1 deletion test/cbmc/aws-templates-for-cbmc-proofs
Submodule aws-templates-for-cbmc-proofs deleted from fdbf54
1 change: 0 additions & 1 deletion test/cbmc/include/README.md

This file was deleted.

6 changes: 6 additions & 0 deletions test/cbmc/include/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
CBMC proof include files
========================

This directory contains include files written for CBMC proof. It is
common to write some code to model aspects of the system under test,
and the header files for this code go here.
1 change: 0 additions & 1 deletion test/cbmc/litani
Submodule litani deleted from 8b4a4f
2 changes: 1 addition & 1 deletion test/cbmc/proofs/Makefile-project-defines
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
COMPILE_FLAGS += -fPIC
COMPILE_FLAGS += -std=gnu90

LITANI = $(SRCDIR)/test/cbmc/litani/litani
LITANI ?= litani
PROJECT_NAME = "FreeRTOS cellular"

# Flags to pass to goto-cc for linking (typically those passed to gcc)
Expand Down
2 changes: 1 addition & 1 deletion test/cbmc/proofs/Makefile-project-targets
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# The first line sets the emacs major mode to Makefile

# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
# SPDX-License-Identifier: Apache-2.0
# SPDX-License-Identifier: MIT-0

################################################################
# Use this file to give project-specific targets, including targets
Expand Down
2 changes: 1 addition & 1 deletion test/cbmc/proofs/Makefile-project-testing
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# The first line sets the emacs major mode to Makefile

# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
# SPDX-License-Identifier: Apache-2.0
# SPDX-License-Identifier: MIT-0

################################################################
# Use this file to define project-specific targets and definitions for
Expand Down
1 change: 0 additions & 1 deletion test/cbmc/proofs/Makefile.common

This file was deleted.

Loading