Changes between Version 2 and Version 3 of CLI


Ignore:
Timestamp:
06/16/23 08:09:03 (3 years ago)
Author:
Alex Wilton
Comment:

Added initial documentation for the -check command line options.

Legend:

Unmodified
Added
Removed
Modified

  • CLI

    v2 v3  
    44= CIVL Command Line Interface
    55
    6 Coming soon.
     6== `-check<X>` CLI Options
     7
     8A large subset of the errors that CIVL checks for may be toggled on or off using the command line. In some cases (currently just checking deadlocks) there is more customization. All errors types which may be configured have a corresponding command line option of the form `-check<X>` where `<X>` is a shortened name of the error class. Below is the full list of such options with a brief description of the error class the option controls. In all cases except where noted, the option is a boolean value which defaults to `true` if not specified on the command line.
     9
     10* `-checkAssertion` : Check for `$assert` violations.
     11* `-checkCommErr` : Check for misuse of `$comm` and related structures/functions.
     12* `-checkConstWrite` : Check for writes to constant variables.
     13* `-checkDeadlock` : Check deadlocks. This option is not boolean and instead takes the following values:
     14  * `absolute`(default) - Checks for "absolute deadlocks" which occur when not every process has terminated but not process has an enabled statement.
     15  * `potential` - Checks for "potential deadlocks" which occur when not every process has terminated but the only enabled statements are sends (i.e. `$comm_enqueue`s) with no corresponding receives.
     16  * `none` - Do not consider deadlocks to be errors.
     17* `-checkDivisionByZero` : Checks for divisions by zero.
     18* `-checkInputWrite` : Check for writes to `$input` variables.
     19* `-checkInvalidCast` : Check for invalid casts.
     20* `-checkMallocErr` : Check for malloc errors.
     21* `-checkMemManageErr` : Check for memory management errors.
     22* `-checkMemoryLeak` : Check for memory leaks.
     23* `-checkMpiErr` : Check for MPI usage errors.
     24* `-checkOutOfBounds` : Check for out of bound errors.
     25* `-checkOutputRead` : Check for reads from `$output` variables.
     26* `-checkPointerErr` : Check for pointer errors.
     27* `-checkProcLeak` : Check for process leaks.
     28* `-checkSeqErr` : Check for misuse of `$seq` and related functions.
     29* `-checkTermination` : Check for non-termination.
     30* `-checkUndefVal` : Check use of undefined values.
     31* `-checkUnionErr` : Check for reading wrong field of a union.
    732
    833----