Contracts & Harnesses for `add`, `addr`, and `align_offset` #105

QinyuanWu · 2024-10-05T22:18:15Z

Towards #53

Changes

Three function contracts & four harnesses:

added contract and harness for non_null::add
added contract and harness for non_null::addr
added contract and harnesses for non_null::align_offset, including both positive and negative harness that triggers panic. The ensures clause for align_offset is referenced from align_offset in library/core/src/ptr/mod.rs.

Revalidation

To revalidate the verification results, run kani verify-std -Z unstable-options "path/to/library" -Z function-contracts -Z mem-predicates --harness ptr::non_null::verify. This will run all six harnesses in the module. All default checks should pass:

SUMMARY:
 ** 0 of 1556 failed

VERIFICATION:- SUCCESSFUL
Verification Time: 0.28004378s

Complete - 6 successfully verified harnesses, 0 failures, 6 total.

❗ Warning

Running the above command with the default installed cargo kani will result in compilation error due to the latest merged from PR#91. Detailed errors are commented under that PR. This issue is waiting to be resolved.

TODO:

Use Layout to create dynamically sized arrays in place of fixed size array in harnesses. This approach currently has errors and is documented in discussion.
Verify multiple data types: these will be added in future PR.
Add requires clause in contract to constrain count to be within object memory size: there is a current issue with using ub_checks::can_write to get the object size. A workaround is implemented in the harness.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses.

zhassan-aws

First round of comments.

library/core/src/ptr/non_null.rs

…-rust-std into dev-olivia

QinyuanWu · 2024-10-28T16:28:01Z

Update: resolved previous comments and successfully used same_allocation to the NonNull add contract and removed the workaround assume clause in the harness. All verification checks pass:

...
SUMMARY:
 ** 0 of 141 failed

VERIFICATION:- SUCCESSFUL
Verification Time: 0.17524096s

Complete - 6 successfully verified harnesses, 0 failures, 6 total.

library/core/src/ptr/non_null.rs

…-rust-std into dev-olivia

zhassan-aws · 2024-11-08T00:40:42Z

You probably need to update the Kani version you're using. There's now a script that automates this process (https://github.com/model-checking/verify-rust-std/blob/main/scripts/run-kani.sh). If you run it, it should pull the correct Kani version.

QinyuanWu · 2024-11-08T03:10:06Z

You probably need to update the Kani version you're using. There's now a script that automates this process (https://github.com/model-checking/verify-rust-std/blob/main/scripts/run-kani.sh). If you run it, it should pull the correct Kani version.
@zhassan-aws When I run the script I got the following error:

Using TOML file: tool_config/kani-version.toml
Using repository URL: https://github.com/model-checking/kani.git
Error: TOML file not found: tool_config/kani-version.toml

I'm using kani built from source and also pulled the most recent changes from the kani repo and the error persisted.

zhassan-aws · 2024-11-08T06:25:29Z

Did you run it from the root directory of the verify-rust-std repo? If not, can you try that?

QinyuanWu · 2024-11-08T17:12:07Z

Did you run it from the root directory of the verify-rust-std repo? If not, can you try that?

@zhassan-aws The first time I ran I got

Error: Could not symlink include/cprover/api.h
Target /opt/homebrew/include/cprover/api.h
is a symlink belonging to [email protected]. You can unlink it:
  brew unlink [email protected]

So I entered the unlink command and re-ran the script but got:

ERROR: Could not find kani-driver binary.
Looked for: '/Users/owo/Desktop/verify-rust-std/kani_build/target/kani/bin/kani-driver'
Was Kani successfully built first?

My kani is built in ~/Desktop/kani.

carolynzech · 2024-11-08T17:17:17Z

ERROR: Could not find kani-driver binary.
Looked for: '/Users/owo/Desktop/verify-rust-std/kani_build/target/kani/bin/kani-driver'
Was Kani successfully built first?

My kani is built in ~/Desktop/kani.

@QinyuanWu Try deleting the kani_build directory and re-running (see these instructions).

QinyuanWu · 2024-11-08T20:00:45Z

ERROR: Could not find kani-driver binary.
Looked for: '/Users/owo/Desktop/verify-rust-std/kani_build/target/kani/bin/kani-driver'
Was Kani successfully built first?
My kani is built in ~/Desktop/kani.
@QinyuanWu Try deleting the kani_build directory and re-running (see these instructions).

@carolynzech Debugged live with @zhassan-aws and resolved by manually re-building kani from the source. The run-kani script is having issue due to outdated cbmc-viewer installation that's still in the setup script of the kani repo and should be removed. Thanks!

QinyuanWu · 2024-11-08T20:06:09Z

Addressed previous PR comments and re-ran kani with successful verification:

SUMMARY:
 ** 0 of 141 failed

VERIFICATION:- SUCCESSFUL
Verification Time: 0.17998616s

Complete - 6 successfully verified harnesses, 0 failures, 6 total.

zhassan-aws

Looks good!

It seems that the stdarch directory was accidentally updated. Can you revert the changes to it?

QinyuanWu · 2024-11-12T07:08:42Z

Looks good!

It seems that the stdarch directory was accidentally updated. Can you revert the changes to it?

@zhassan-aws Done! Waiting for review from another team member.

celinval

Thank you. I added a few suggestions but not blockers

library/core/src/ptr/non_null.rs

QinyuanWu · 2024-11-13T06:36:59Z

@zhassan-aws I just started to experience kani compiler error without any modification to the previous code:

Kani Rust Verifier 0.56.0 (standalone)
error: attributes starting with `rustc` are reserved for use by the `rustc` compiler
    --> /Users/owo/Desktop/verify-rust-std/library/core/src/intrinsics.rs:2723:7
     |
2723 |     #[rustc_safe_intrinsic]
     |       ^^^^^^^^^^^^^^^^^^^^

error: attributes starting with `rustc` are reserved for use by the `rustc` compiler
    --> /Users/owo/Desktop/verify-rust-std/library/core/src/intrinsics.rs:2614:7
     |
2614 |     #[rustc_safe_intrinsic]
     |       ^^^^^^^^^^^^^^^^^^^^

Not sure if this is the same issue with PR #127

zhassan-aws · 2024-11-13T21:15:46Z

@zhassan-aws I just started to experience kani compiler error without any modification to the previous code:

Kani Rust Verifier 0.56.0 (standalone)
error: attributes starting with `rustc` are reserved for use by the `rustc` compiler
    --> /Users/owo/Desktop/verify-rust-std/library/core/src/intrinsics.rs:2723:7
     |
2723 |     #[rustc_safe_intrinsic]
     |       ^^^^^^^^^^^^^^^^^^^^

error: attributes starting with `rustc` are reserved for use by the `rustc` compiler
    --> /Users/owo/Desktop/verify-rust-std/library/core/src/intrinsics.rs:2614:7
     |
2614 |     #[rustc_safe_intrinsic]
     |       ^^^^^^^^^^^^^^^^^^^^

Not sure if this is the same issue with PR #127

Can you try running using ./scripts/run_kani.sh? We removed CBMC viewer from the installation steps, so it should hopefully work now.

QinyuanWu · 2024-11-13T23:26:10Z

@zhassan-aws I just started to experience kani compiler error without any modification to the previous code:
Kani Rust Verifier 0.56.0 (standalone)
error: attributes starting with `rustc` are reserved for use by the `rustc` compiler
    --> /Users/owo/Desktop/verify-rust-std/library/core/src/intrinsics.rs:2723:7
     |
2723 |     #[rustc_safe_intrinsic]
     |       ^^^^^^^^^^^^^^^^^^^^

error: attributes starting with `rustc` are reserved for use by the `rustc` compiler
    --> /Users/owo/Desktop/verify-rust-std/library/core/src/intrinsics.rs:2614:7
     |
2614 |     #[rustc_safe_intrinsic]
     |       ^^^^^^^^^^^^^^^^^^^^
Not sure if this is the same issue with PR #127
Can you try running using ./scripts/run_kani.sh? We removed CBMC viewer from the installation steps, so it should hopefully work now.

I resolved these errors by building kani from the features/verify-rust-std branch, but the errors in #127 still persists.
For the script, I pulled the latest changes from main and it seems like cbmc-viewer is still being installed/upgraded:

==> Upgrading aws/tap/cbmc-viewer
  3.9 -> 3.10 
Error: Your Command Line Tools are too outdated.
Update them from Software Update in System Settings.

@zhassan-aws @celinval Waiting approval to start the merge workflow.

library/core/src/ptr/non_null.rs

carolynzech

trigger approval workflow

QinyuanWu and others added 11 commits October 2, 2024 16:34

contract and harness for add

9c8905e

add contract and harness to addr

5ea1ddc

use can_write

ca6813f

add harness for align_offset

2c0dcbe

minor fix

df2e658

minor fix

6c341e8

minor fix

319a002

add contract and negative proof for align_offset

64568b7

add comments for addr

2c3a17f

add requires clause for align_offset and tidy up harnesses

288abda

Merge branch 'model-checking:main' into dev-olivia

404af0a

QinyuanWu requested a review from a team as a code owner October 5, 2024 22:18

zhassan-aws reviewed Oct 8, 2024

View reviewed changes

danielhumanmod reviewed Oct 16, 2024

View reviewed changes

library/core/src/ptr/non_null.rs Outdated Show resolved Hide resolved

danielhumanmod reviewed Oct 16, 2024

View reviewed changes

library/core/src/ptr/non_null.rs Show resolved Hide resolved

QinyuanWu and others added 3 commits October 21, 2024 17:04

incorporate pr suggestions

c7406c1

Merge branch 'model-checking:main' into dev-olivia

420eb05

Merge branch 'dev-olivia' of https://github.com/danielhumanmod/verify…

3ec9b12

…-rust-std into dev-olivia

zhassan-aws mentioned this pull request Oct 21, 2024

Contracts and Harnesses for <*mut T>::add, sub and offset #113

Merged

QinyuanWu and others added 3 commits October 25, 2024 15:29

using same_allocation for add

4e7e3a5

Merge branch 'model-checking:main' into dev-olivia

f065d6b

misc: remove todo

6cfad82

QinyuanWu requested review from zhassan-aws and danielhumanmod October 28, 2024 16:28

Merge branch 'model-checking:main' into dev-olivia

88afe64

zhassan-aws reviewed Nov 7, 2024

View reviewed changes

QinyuanWu added 3 commits November 7, 2024 15:39

address PR comments

22ac1a9

Merge branch 'dev-olivia' of https://github.com/danielhumanmod/verify…

293a297

…-rust-std into dev-olivia

merge with upstream/main

028ab6a

address PR comment

355c672

QinyuanWu requested review from zhassan-aws and celinval November 8, 2024 20:06

zhassan-aws reviewed Nov 9, 2024

View reviewed changes

revert stdarch changes

b383978

zhassan-aws approved these changes Nov 12, 2024

View reviewed changes

celinval self-assigned this Nov 13, 2024

celinval approved these changes Nov 13, 2024

View reviewed changes

library/core/src/ptr/non_null.rs Show resolved Hide resolved

library/core/src/ptr/non_null.rs Outdated Show resolved Hide resolved

library/core/src/ptr/non_null.rs Outdated Show resolved Hide resolved

library/core/src/ptr/non_null.rs Outdated Show resolved Hide resolved

carolynzech assigned zhassan-aws Nov 13, 2024

QinyuanWu and others added 3 commits November 13, 2024 14:42

Merge branch 'model-checking:main' into dev-olivia

e428231

simplify expressions

7e2eee3

use PointerGenerator for add

dc9e9e0

QinyuanWu mentioned this pull request Nov 13, 2024

Contracts and harnesses for dangling, from_raw_parts, slice_from_raw_parts, to_raw_parts in NonNull #127

Merged

carolynzech reviewed Nov 14, 2024

View reviewed changes

library/core/src/ptr/non_null.rs Outdated Show resolved Hide resolved

carolynzech added 2 commits November 14, 2024 09:45

Remove unused import

25317fd

Merge branch 'main' into dev-olivia

d26185e

carolynzech approved these changes Nov 14, 2024

View reviewed changes

carolynzech enabled auto-merge (squash) November 14, 2024 14:47

carolynzech merged commit d29f29e into model-checking:main Nov 14, 2024
9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Contracts & Harnesses for `add`, `addr`, and `align_offset` #105

Contracts & Harnesses for `add`, `addr`, and `align_offset` #105

QinyuanWu commented Oct 5, 2024 •

edited

Loading

zhassan-aws left a comment

QinyuanWu commented Oct 28, 2024 •

edited

Loading

zhassan-aws commented Nov 8, 2024

QinyuanWu commented Nov 8, 2024 •

edited

Loading

zhassan-aws commented Nov 8, 2024

QinyuanWu commented Nov 8, 2024

carolynzech commented Nov 8, 2024 •

edited

Loading

QinyuanWu commented Nov 8, 2024

QinyuanWu commented Nov 8, 2024

zhassan-aws left a comment

QinyuanWu commented Nov 12, 2024

celinval left a comment

QinyuanWu commented Nov 13, 2024 •

edited

Loading

zhassan-aws commented Nov 13, 2024

QinyuanWu commented Nov 13, 2024 •

edited

Loading

carolynzech left a comment

Contracts & Harnesses for add, addr, and align_offset #105

Contracts & Harnesses for add, addr, and align_offset #105

Conversation

QinyuanWu commented Oct 5, 2024 • edited Loading

Changes

Revalidation

❗ Warning

TODO:

zhassan-aws left a comment

Choose a reason for hiding this comment

QinyuanWu commented Oct 28, 2024 • edited Loading

zhassan-aws commented Nov 8, 2024

QinyuanWu commented Nov 8, 2024 • edited Loading

zhassan-aws commented Nov 8, 2024

QinyuanWu commented Nov 8, 2024

carolynzech commented Nov 8, 2024 • edited Loading

QinyuanWu commented Nov 8, 2024

QinyuanWu commented Nov 8, 2024

zhassan-aws left a comment

Choose a reason for hiding this comment

QinyuanWu commented Nov 12, 2024

celinval left a comment

Choose a reason for hiding this comment

QinyuanWu commented Nov 13, 2024 • edited Loading

zhassan-aws commented Nov 13, 2024

QinyuanWu commented Nov 13, 2024 • edited Loading

carolynzech left a comment

Choose a reason for hiding this comment

Contracts & Harnesses for `add`, `addr`, and `align_offset` #105

Contracts & Harnesses for `add`, `addr`, and `align_offset` #105

QinyuanWu commented Oct 5, 2024 •

edited

Loading

QinyuanWu commented Oct 28, 2024 •

edited

Loading

QinyuanWu commented Nov 8, 2024 •

edited

Loading

carolynzech commented Nov 8, 2024 •

edited

Loading

QinyuanWu commented Nov 13, 2024 •

edited

Loading

QinyuanWu commented Nov 13, 2024 •

edited

Loading