• Top
    • Documentation
    • Books
    • Recursion-and-induction
    • Boolean-reasoning
    • Projects
    • Debugging
    • Std
    • Proof-automation
    • Macro-libraries
    • ACL2
    • Interfacing-tools
    • Hardware-verification
    • Software-verification
      • Kestrel-books
        • Crypto-hdwallet
        • Error-checking
        • Apt
        • Abnf
        • Fty-extensions
        • Isar
        • Kestrel-utilities
          • Omaps
          • Directed-untranslate
          • Include-book-paths
          • Ubi
          • Checkpoint-list
          • Digits-any-base
          • Context-message-pair
          • Numbered-names
          • With-auto-termination
          • Theorems-about-true-list-lists
          • Make-termination-theorem
          • Sublis-expr+
          • Prove$
            • Defthm<w
            • System-utilities-non-built-in
            • Integer-range-fix
            • Add-const-to-untranslate-preprocess
            • Integers-from-to
            • Minimize-ruler-extenders
            • Unsigned-byte-fix
            • Signed-byte-fix
            • Defthmr
            • Paired-names
            • Unsigned-byte-list-fix
            • Signed-byte-list-fix
            • Show-books
            • Checkpoint-list-pretty
            • List-utilities
            • Skip-in-book
            • Typed-tuplep
            • Defunt
            • Keyword-value-list-to-alist
            • Magic-macroexpand
            • Top-command-number-fn
            • Bits-as-digits-in-base-2
            • Show-checkpoint-list
            • Ubyte11s-as-digits-in-base-2048
            • Named-formulas
            • Bytes-as-digits-in-base-256
            • String-utilities
            • Make-keyword-value-list-from-keys-and-value
            • Integer-range-listp
            • Defmacroq
            • Apply-fn-if-known
            • Trans-eval-error-triple
            • Checkpoint-info-list
            • Previous-subsumer-hints
            • Fms!-lst
            • Zp-listp
            • Doublets-to-alist
            • Trans-eval-state
            • Injections
            • Theorems-about-osets
            • Typed-list-utilities
            • Book-runes-alist
            • User-interface
            • Bits/ubyte11s-digit-grouping
            • Bits/bytes-digit-grouping
            • Message-utilities
            • Subsetp-eq-linear
            • Strict-merge-sort-<
            • Miscellaneous-enumerations
            • Maybe-unquote
            • Oset-utilities
            • Thm<w
            • Defthmd<w
          • Prime-field-constraint-systems
          • Soft
          • Bv
          • Imp-language
          • Event-macros
          • Bitcoin
          • Ethereum
          • Yul
          • Zcash
          • ACL2-programming-language
          • Prime-fields
          • Java
          • C
          • Syntheto
          • Number-theory
          • Cryptography
          • Lists-light
          • File-io-light
          • Json
          • Built-ins
          • Solidity
          • Axe
          • Std-extensions
          • Htclient
          • Typed-lists-light
          • Arithmetic-light
        • X86isa
        • Execloader
        • Axe
      • Testing-utilities
      • Math
    • Kestrel-utilities
    • System-utilities-non-built-in

    Prove$

    A way to call the prover from a program

    For examples, see community book books/tools/prove-dollar-tests.lisp.

    General Form:
    (prove$ term                    ; any term (translated or not)
            &key
            catch-hard-error        ; default t
            hints                   ; default nil
            ignore-ok               ; default t
            instructions            ; default nil
            otf-flg                 ; default nil
            prover-error-output-off ; default t
            skip-proofs             ; default :same
            step-limit              ; default nil
            time-limit              ; default nil
            with-output)            ; default (:off :all :on error :gag-mode nil)

    where all arguments except with-output are evaluated. The value of keyword :with-output, if supplied, should be a list containing arguments one would give to the macro, with-output, hence a list that satisfies keyword-value-listp. The hints, instructions, otf-flg, time-limit, and step-limit arguments are as one would expect for calls of the prover; see defthm. It is illegal to supply non-nil values for both hints and instructions. The ignore-ok option has the same effect as if set-ignore-ok were called with that same value, immediately preceding the call of prove$ — but of course warning and error messages may be suppressed, depending on with-output. The skip-proofs option defaults to :same, which causes prove$ to avoid proofs during include-book and, more generally, any time that (ld-skip-proofsp state) is not nil. When skip-proofs is not :same then proofs take place if and only if the value of skip-proofs is not nil, as though (set-ld-skip-proofsp state) were evaluated immediately preceding evaluation of the prove$ call. The value of prover-error-output-off must be either t, which represents the list ("Failure" "Step-limit"), or a list of strings; error messages arising during the proof whose type is one of these strings is to be suppressed, as though set-inhibit-er had been executed on these strings. Finally, the value of catch-hard-error is t by default, which causes hard errors from the prover — in particular, when there is a stack overflow in the rewriter — to be treated as ordinary proof failures; also, it suppresses the general error message from a hard error and it suppresses the error message from rewriter stack overflows.

    Prove$ returns an error-triple, (mv erp val state). If there is a syntax error (so-called ``translation error'') in the given term, hints, or instructions, then erp is non-nil. Otherwise, erp is nil and val is t when term is successfully proved, else nil.

    Note that after evaluation of a prove$ call, you can evaluate the form (last-prover-steps state) to get the number of prover steps that were taken — except, a negative number indicates a step-limit violation. See last-prover-steps.