Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bedrocksystems/brick
Formalization of C++ for verification purposes.
https://github.com/bedrocksystems/brick
coq coq-formalization coq-library cplusplus cplusplus-11 cplusplus-14 cplusplus-17
Last synced: 3 months ago
JSON representation
Formalization of C++ for verification purposes.
- Host: GitHub
- URL: https://github.com/bedrocksystems/brick
- Owner: bedrocksystems
- License: other
- Created: 2020-05-04T18:16:44.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-10T21:26:24.000Z (4 months ago)
- Last Synced: 2024-10-10T21:41:07.108Z (4 months ago)
- Topics: coq, coq-formalization, coq-library, cplusplus, cplusplus-11, cplusplus-14, cplusplus-17
- Language: Coq
- Homepage: https://bedrocksystems.github.io/BRiCk
- Size: 82.8 MB
- Stars: 68
- Watchers: 6
- Forks: 10
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE-BedRock
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# BRiCk
A program logic for verifying concurrent C++ in Rocq.
## Running
### As a standalone tool
```sh
cpp2v -v -names XXX_names.v -o XXX_cpp.v XXX.cpp -- ...clang options...
```
## Build & Dependencies
The following scripts should work, but you can customize them based on your
needs.
They must be run inside a clone of this repository.
Our instructions are for Linux (Ubuntu) and OSX.
- LLVM 17 or greater (we've tested against 17 and 18)
- cmake
- [opam 2](https://opam.ocaml.org/)
### Native dependencies: Linux (Ubuntu)
```sh
# install opam and cmake
sudo apt install cmake opam
# install llvm 18 (see directions here: https://apt.llvm.org/)
wget https://apt.llvm.org/llvm.sh
chmod +x llvm.sh
sudo ./llvm.sh 18 all
```
### Native dependencies: OSX
For OSX we recommend clang 18:
```sh
brew install llvm@18 cmake opam
export PATH=/usr/local/opt/llvm@18/bin:${PATH}
```
### Setup
The script below uses 4 cores, customize as needed.
```sh
# install opam dependencies
eval $(opam env)
# The first time, run:
opam repo add coq-released https://coq.inria.fr/opam/released
opam repo add iris-dev https://gitlab.mpi-sws.org/iris/opam.git
# install cpp2v Coq library and Coq dependencies
opam update
opam pin -n coq-cpp2v .
opam pin -n coq-cpp2v-bin .
opam install coq coq-cpp2v coq-cpp2v-bin
```
### Building
Building is primarily done via [dune](https://github.com/ocaml/dune) and can be done using
```sh
$ dune build
```
## Examples
See the examples in the `tests` directory to get an idea of coverage that the logic supports.
More examples will be added as the feature set evolves.
You can run the tests with:
```sh
$ dune test
```
You can run `cpp2v` on your own files by invoking
```sh
$ dune exec cpp2v -- ...cpp2v options... -- ...clang options...
```
## Repository Layout
- `src` and `include` -- the implementation of the `cpp2v` tool.
- `llvm-include` -- extensions of LLVM source code (see `llvm-include/LICENSE.txt` for the license of these files)
- `coq-upoly` -- universe polymorphic monad libraries
- `theories` -- the core Coq development.
- `prelude` -- BlueRock's prelude extending [stdpp](https://gitlab.mpi-sws.org/iris/stdpp)
- `lang/cpp` -- the C++ syntax and semantics
- `syntax` -- the definition of the C++ AST (abstract syntax tree)
- `semantics` -- core semantic definitions that are independent of separation logic
- `logic` -- the separation logic weakest pre-condition semantics
- `parser` -- the environment used to interpret the generated code.
## Coq IDEs
The following command can be used to create a `_CoqProject` file for use by Coq IDEs.
```sh
$ ln -s _CoqProject.template _CoqProject
```