• Top
  • Documentation
  • Books
  • Boolean-reasoning
  • Projects
  • Debugging
  • Community
  • Std
  • Proof-automation
  • Macro-libraries
  • ACL2
  • Interfacing-tools
  • Hardware-verification
  • Software-verification
    • Kestrel-books
      • Crypto-hdwallet
      • Apt
      • Error-checking
      • Fty-extensions
      • Isar
      • Kestrel-utilities
      • Set
      • C
        • Syntax-for-tools
        • Atc
        • Transformation-tools
          • Simpadd0
          • Proof-generation
          • Split-gso
          • Wrap-fn
            • Wrap-fn-implementation
              • Initdeclor-list-wrap-fn-add-wrapper-def
              • Declor-wrap-fn-add-wrapper-def
              • Fundef-wrap-fn-add-wrapper-def
              • Extdecl-wrap-fn-add-wrapper-def
              • Decl-wrap-fn-add-wrapper-def
              • Extdecl-list-wrap-fn
              • Wrap-fn-process-param-declon-list-loop
              • Filepath-transunit-map-wrap-fn
              • Wrap-fn-process-param-declon-list
              • Transunit-wrap-fn
              • Transunit-ensemble-wrap-fn
              • Code-ensemble-wrap-fn
              • Code-ensemble-wrap-fn-multiple
              • Declor-wrap-fn-make-wrapper
              • Dirdeclor-wrap-fn-make-wrapper
              • Wrap-fn-input-processing
              • Wrap-fn-event-generation
          • Constant-propagation
          • Specialize
          • Split-fn
          • Split-fn-when
          • Split-all-gso
          • Copy-fn
          • Variables-in-computation-states
          • Rename
          • Utilities
          • Proof-generation-theorems
          • Input-processing
        • Language
        • Representation
        • Insertion-sort
        • Pack
      • Soft
      • Bv
      • Imp-language
      • Ethereum
      • Event-macros
      • Java
      • Riscv
      • Bitcoin
      • Zcash
      • Yul
      • ACL2-programming-language
      • Prime-fields
      • Json
      • Syntheto
      • File-io-light
      • Cryptography
      • Number-theory
      • Axe
      • Lists-light
      • Builtins
      • Solidity
      • Helpers
      • Htclient
      • Typed-lists-light
      • Arithmetic-light
    • X86isa
    • Axe
    • Execloader
  • Math
  • Testing-utilities

• Wrap-fn-implementation

Fundef-wrap-fn-add-wrapper-def

Check if a function definition matches the target, and create the function wrapper if so.

Signature

(fundef-wrap-fn-add-wrapper-def fundef 
                                target-name wrapper-name? blacklist) 
 
  → 
(mv er? uid? wrapper? wrapper-name?$)

Arguments

fundef — Guard (fundefp fundef).

target-name — Guard (identp target-name).

wrapper-name? — Guard (ident-optionp wrapper-name?).

blacklist — Guard (ident-setp blacklist).

Returns

er? — Type (maybe-msgp er?).

uid? — Type (c$::uid-optionp uid?).

wrapper? — Type (fundef-optionp wrapper?).

wrapper-name?$ — Type (ident-optionp wrapper-name?$).

The returned uid? value, if it is not nil, is the c$::uid of the matched function.

If uid? return value is non-nil but wrapper? is nil, that means the function definition matched the target, but some aspect of it is unsupported by the current implementation.

Definitions and Theorems

Function: fundef-wrap-fn-add-wrapper-def

(defun fundef-wrap-fn-add-wrapper-def
       (fundef target-name wrapper-name? blacklist)
 (declare (xargs :guard (and (fundefp fundef)
                             (identp target-name)
                             (ident-optionp wrapper-name?)
                             (ident-setp blacklist))))
 (declare (xargs :guard (fundef-annop fundef)))
 (b*
  (((reterr) nil nil nil)
   ((fundef fundef) fundef)
   ((erp foundp wrapper? wrapper-name?)
    (declor-wrap-fn-add-wrapper-def
         fundef.declor target-name
         wrapper-name? blacklist fundef.spec))
   ((erp uid?)
    (b*
     (((reterr) nil)
      ((unless foundp) (retok nil))
      ((unless (fundef-infop (c$::fundef->info fundef)))
       (retmsg$
        "Function definition does not have ~
                        fundef-info metadata: ~x0"
        (fundef-fix fundef))))
     (retok (c$::fundef-info->uid (c$::fundef->info fundef))))))
  (retok uid? wrapper? wrapper-name?)))

Theorem: maybe-msgp-of-fundef-wrap-fn-add-wrapper-def.er?

(defthm maybe-msgp-of-fundef-wrap-fn-add-wrapper-def.er?
  (b* (((mv ?er? ?uid? ?wrapper? ?wrapper-name?$)
        (fundef-wrap-fn-add-wrapper-def
             fundef
             target-name wrapper-name? blacklist)))
    (maybe-msgp er?))
  :rule-classes :rewrite)

Theorem: uid-optionp-of-fundef-wrap-fn-add-wrapper-def.uid?

(defthm uid-optionp-of-fundef-wrap-fn-add-wrapper-def.uid?
  (b* (((mv ?er? ?uid? ?wrapper? ?wrapper-name?$)
        (fundef-wrap-fn-add-wrapper-def
             fundef
             target-name wrapper-name? blacklist)))
    (c$::uid-optionp uid?))
  :rule-classes :rewrite)

Theorem: fundef-optionp-of-fundef-wrap-fn-add-wrapper-def.wrapper?

(defthm fundef-optionp-of-fundef-wrap-fn-add-wrapper-def.wrapper?
  (b* (((mv ?er? ?uid? ?wrapper? ?wrapper-name?$)
        (fundef-wrap-fn-add-wrapper-def
             fundef
             target-name wrapper-name? blacklist)))
    (fundef-optionp wrapper?))
  :rule-classes :rewrite)

Theorem: ident-optionp-of-fundef-wrap-fn-add-wrapper-def.wrapper-name?$

(defthm
     ident-optionp-of-fundef-wrap-fn-add-wrapper-def.wrapper-name?$
  (b* (((mv ?er? ?uid? ?wrapper? ?wrapper-name?$)
        (fundef-wrap-fn-add-wrapper-def
             fundef
             target-name wrapper-name? blacklist)))
    (ident-optionp wrapper-name?$))
  :rule-classes :rewrite)

Theorem: fundefp-of-fundef-wrap-fn-add-wrapper-def.wrapper?-under-iff

(defthm fundefp-of-fundef-wrap-fn-add-wrapper-def.wrapper?-under-iff
  (b* (((mv ?er? ?uid? ?wrapper? ?wrapper-name?$)
        (fundef-wrap-fn-add-wrapper-def
             fundef
             target-name wrapper-name? blacklist)))
    (iff (fundefp wrapper?) wrapper?)))

Theorem: identp-of-fundef-wrap-fn-add-wrapper-def.wrapper-name?$

(defthm identp-of-fundef-wrap-fn-add-wrapper-def.wrapper-name?$
  (b* (((mv ?er? ?uid? ?wrapper? ?wrapper-name?$)
        (fundef-wrap-fn-add-wrapper-def
             fundef
             target-name wrapper-name? blacklist)))
    (equal (identp wrapper-name?$)
           (fundefp wrapper?))))

Theorem: fundef-wrap-fn-add-wrapper-def-of-fundef-fix-fundef

(defthm fundef-wrap-fn-add-wrapper-def-of-fundef-fix-fundef
  (equal (fundef-wrap-fn-add-wrapper-def
              (fundef-fix fundef)
              target-name wrapper-name? blacklist)
         (fundef-wrap-fn-add-wrapper-def
              fundef
              target-name wrapper-name? blacklist)))

Theorem: fundef-wrap-fn-add-wrapper-def-fundef-equiv-congruence-on-fundef

(defthm
   fundef-wrap-fn-add-wrapper-def-fundef-equiv-congruence-on-fundef
  (implies (c$::fundef-equiv fundef fundef-equiv)
           (equal (fundef-wrap-fn-add-wrapper-def
                       fundef
                       target-name wrapper-name? blacklist)
                  (fundef-wrap-fn-add-wrapper-def
                       fundef-equiv
                       target-name wrapper-name? blacklist)))
  :rule-classes :congruence)

Theorem: fundef-wrap-fn-add-wrapper-def-of-ident-fix-target-name

(defthm fundef-wrap-fn-add-wrapper-def-of-ident-fix-target-name
 (equal
      (fundef-wrap-fn-add-wrapper-def fundef (ident-fix target-name)
                                      wrapper-name? blacklist)
      (fundef-wrap-fn-add-wrapper-def
           fundef
           target-name wrapper-name? blacklist)))

Theorem: fundef-wrap-fn-add-wrapper-def-ident-equiv-congruence-on-target-name

(defthm
 fundef-wrap-fn-add-wrapper-def-ident-equiv-congruence-on-target-name
 (implies
   (c$::ident-equiv target-name target-name-equiv)
   (equal (fundef-wrap-fn-add-wrapper-def
               fundef
               target-name wrapper-name? blacklist)
          (fundef-wrap-fn-add-wrapper-def fundef target-name-equiv
                                          wrapper-name? blacklist)))
 :rule-classes :congruence)

Theorem: fundef-wrap-fn-add-wrapper-def-of-ident-option-fix-wrapper-name?

(defthm
   fundef-wrap-fn-add-wrapper-def-of-ident-option-fix-wrapper-name?
 (equal
    (fundef-wrap-fn-add-wrapper-def fundef target-name
                                    (ident-option-fix wrapper-name?)
                                    blacklist)
    (fundef-wrap-fn-add-wrapper-def
         fundef
         target-name wrapper-name? blacklist)))

Theorem: fundef-wrap-fn-add-wrapper-def-ident-option-equiv-congruence-on-wrapper-name?

(defthm
 fundef-wrap-fn-add-wrapper-def-ident-option-equiv-congruence-on-wrapper-name?
 (implies
  (c$::ident-option-equiv wrapper-name? wrapper-name?-equiv)
  (equal
    (fundef-wrap-fn-add-wrapper-def
         fundef
         target-name wrapper-name? blacklist)
    (fundef-wrap-fn-add-wrapper-def fundef target-name
                                    wrapper-name?-equiv blacklist)))
 :rule-classes :congruence)

Theorem: fundef-wrap-fn-add-wrapper-def-of-ident-set-fix-blacklist

(defthm fundef-wrap-fn-add-wrapper-def-of-ident-set-fix-blacklist
  (equal (fundef-wrap-fn-add-wrapper-def
              fundef target-name
              wrapper-name? (ident-set-fix blacklist))
         (fundef-wrap-fn-add-wrapper-def
              fundef
              target-name wrapper-name? blacklist)))

Theorem: fundef-wrap-fn-add-wrapper-def-ident-set-equiv-congruence-on-blacklist

(defthm
 fundef-wrap-fn-add-wrapper-def-ident-set-equiv-congruence-on-blacklist
 (implies
  (c$::ident-set-equiv blacklist blacklist-equiv)
  (equal
    (fundef-wrap-fn-add-wrapper-def
         fundef
         target-name wrapper-name? blacklist)
    (fundef-wrap-fn-add-wrapper-def fundef target-name
                                    wrapper-name? blacklist-equiv)))
 :rule-classes :congruence)