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 documentations #567

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ SMACK is both a *modular software verification toolchain* and a
*self-contained software verifier*. It can be used to verify the assertions
in its input programs. In its default mode, assertions are verified up to a
given bound on loop iterations and recursion depth; it contains experimental
support for unbounded verification as well. SMACK handles complicated feature
support for unbounded verification as well (REMOVE THIS). SMACK handles complicated feature
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why would you want to remove this?

of the C language, including dynamic memory allocation, pointer arithmetic, and
bitwise operations.

Expand Down
8 changes: 7 additions & 1 deletion docs/running.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

SMACK software verifier is run using the `smack` tool in the bin directory.
For a given input C/C++ program, the tool checks for violations of user-provided
assertions. SMACK has a number of command line options that can be used
assertions (MENTION GENERATED ASSERTIONS IN MEMORY SAFETY/OVERFLOW CHECKING). SMACK has a number of command line options that can be used
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, good idea.

to fine-tune the toolchain. Type `smack -h` for a full list of supported command
line options.

Expand Down Expand Up @@ -99,6 +99,8 @@ directory. SMACK defines a number of functions (one for each basic type)
for introducing nondeterministic (i.e., unconstrained) values, such as
`__VERIFIER_nondet_int` used in this example.

MENTION ASSERT/ASSUME
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea.


Simply run the SMACK verifier on your input C file:
```Shell
smack simple.c
Expand All @@ -114,5 +116,9 @@ verifier leverages to generate more informative error traces. Then, the generate
file is translated into Boogie code, which is in turn passed to the chosen back-end
verifier.

EXAMPLE ON MEMORY SAFETY
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea.

EXAMPLE ON INTEGER OVERFLOW CHECKING
EXAMPLE ON USING WHOLE-PROGRAM-LLVM

For mode advanced usage scenarios, please refer to our [usage notes](usage-notes.md).