appliedfm / coq-certicoq-block

coq-certicoq-block

A Verified Software Unit for working with CertiCoq data blocks.

Implemented in C, modeled in Coq, and proven correct using the Verified Software Toolchain.

Compatible with CompCert.

Verification status

Specifications are provided for the following targets:

• x86_64-linux
• x86_32-linux

Proofs are checked by our CI infrastructure.

Packages

• coq-vsu-certicoq-block-src - C source code
• coq-vsu-certicoq-block-vst - VST model, spec, & proof (x86_64-linux)
• coq-vsu-certicoq-block-vst-32 - VST model, spec, & proof (x86_32-linux)

Installing

Installation is performed by opam with help by coq-vsu.

$ opam pin -n -y .
$ opam install coq-vsu-certicoq-block-vst coq-vsu-certicoq-block-vst-32

Using the C library

The C library is installed to the path given by vsu -I. For example:

$ tree `vsu -I`
/home/tcarstens/.opam/coq-8.14/lib/coq-vsu/lib/include
└── coq-vsu-certicoq-block
    ├── block.h
    └── src
        └── block.c

2 directories, 2 files
$

Using the Coq library

We currently publish two Coq libraries:

• coq-vsu-certicoq-block-vst - VST model, spec, & proof (x86_64-linux)
• coq-vsu-certicoq-block-vst-32 - VST model, spec, & proof (x86_32-linux)

The coq-vsu-certicoq-block-vst and coq-vsu-certicoq-block-vst-32 are both target-specific. As such, they are sometimes installed into locations outside of Coq's search path. Fortunately, these libraries can be found by calling vsu --show-coq-variant-path=PACKAGE. For example:

$ echo `vsu --show-coq-variant-path=coq-vsu-certicoq-block-vst-32`
/home/tcarstens/.opam/coq-8.14/lib/coq/../coq-variant/CertiCoq/32/Block
$

The vsu tool can also be used to supply Coq with the correct arguments for importing the target-specific libraries. For example:

$ tcarstens@pop-os:~/formal_methods/coq-certicoq-block$ coqtop \
    `vsu -Q coq-vsu-certicoq-block-vst-32` \
    `vsu -Q coq-compcert-32` \
    `vsu -Q coq-vst-32`
Welcome to Coq 8.14.0

Coq < From VST Require Import floyd.proofauto.

Coq < From CertiCoq Require Import Block.vst.spec.spec.

Coq < Check int_or_ptr__is_int_spec.
int_or_ptr__is_int_spec
     : ident * funspec

Coq < 

Building without opam

The general pattern looks like this:

$ make [verydeepclean|deepclean|clean]
$ make BITSIZE={opam|64|32} [all|_CoqProject|clightgen|theories]

BITSIZE determines which compcert target to use. If unspecified, the default value is opam:

• opam and 64 both use x86_64-linux
• 32 uses x86_32-linux

Example: x86_64-linux

$ make verydeepclean ; make

Example: x86_32-linux

$ make verydeepclean ; make BITSIZE=32