• Top
  • Documentation
  • Books
  • Boolean-reasoning
  • Projects
  • Debugging
  • Std
  • Community
  • Proof-automation
  • Macro-libraries
  • ACL2
  • Interfacing-tools
  • Hardware-verification
    • Gl
    • Esim
    • Vl2014
    • Sv
    • Fgl
    • Vwsim
    • Vl
      • Syntax
      • Loader
      • Warnings
      • Getting-started
      • Utilities
      • Printer
      • Kit
      • Mlib
      • Transforms
        • Unparameterization
          • Vl-unparameterize-flow
          • Vl-unparam-inst
          • Vl-unparam-add-to-ledger
          • Vl-scopeinfo-resolve-params
          • Vl-scope-finalize-params
          • Vl-create-unparameterized-interface
          • Vl-create-unparameterized-module
          • Vl-unparam-actualkeys
          • Vl-make-paramdecloverrides
          • Vl-unparam-class
          • Vl-unparam-instlist
          • Vl-create-unparameterized-class
          • Vl-add-lost-interface-warnings
          • Vl-add-lost-module-warnings
          • Vl-unparam-classlist
          • Vl-interfacelist->orignames
          • Vl-user-signature
          • Vl-interfaceport-default-signature
          • Vl-modulelist->orignames
          • Vl-plainarglist-update-ifports
          • Vl-portlist-interface-signatures
          • Vl-user-signatures
          • Vl-plainarg-update-ifports
          • Vl-unparam-inst->instkey
          • Vl-toplevel-signatures
          • Vl-unparam-basename
          • Vl-genblob-resolve-rejoin-scopeitems
          • Vl-gencase-some-match
          • Vl-gencase-match
          • Vl-package-elaborate
          • Vl-unparam-signature
          • Vl-unparam-ledger
          • Vl-packagelist-elaborate
          • Vl-design-elaborate
          • Vl-unparam-actualkey
          • Vl-make-paramdecloverrides-named
          • Vl-unparameterize-main
          • Vl-recover-modules-lost-from-elaboration
          • Vl-finish-unparameterized-interface
          • Vl-paramdecl-set-default
          • Vl-genblob-rejoin-scopeitems
          • Vl-finish-unparameterized-interfaces
          • Vl-unparam-instkey
          • Vl-finish-unparameterized-module
          • Vl-finish-unparameterized-class
          • Vl-finish-unparameterized-modules
          • Vl-finish-unparameterized-classes
          • Vl-genblob-split-scopeitems
          • Vl-user-paramsettings-for-top-names
          • Vl-string/int-alist-to-namedargs
          • Vl-add-lost-interface-warning
          • Vl-unparam-basename-exprstring
          • Vl-add-lost-module-warning
          • Vl-paramdecllist-remove-defaults
          • Vl-ifport-alist
          • Vl-paramdecl-remove-default
          • Vl-ifportexpr->name
          • Vl-paramdecllist-all-localp
          • Vl-unparam-instkeymap
          • Vl-unparam-donelist
          • Vl-unparam-instkeylist
        • Elaborate
        • Addnames
        • Annotate
        • Clean-warnings
        • Eliminitial
        • Custom-transform-hooks
        • Problem-modules
    • X86isa
    • Svl
    • Rtl
  • Software-verification
  • Math
  • Testing-utilities

• Unparameterization

Vl-scope-finalize-params

Signature

(vl-scope-finalize-params formals 
                          actuals warnings elabindex outer-ss 
                          outer-scope-path &key (config 'config)) 
 
  → 
(mv successp warnings elabindex final-paramdecls)

Arguments

formals — Guard (vl-paramdecllist-p formals).

actuals — Guard (vl-paramargs-p actuals).

warnings — Guard (vl-warninglist-p warnings).

elabindex — in the scope of the instantiated module. Warning: this function returns an elabindex with a somewhat mangled scopestack.

outer-ss — Guard (vl-scopestack-p outer-ss).

outer-scope-path — How to get to the scopes for the override context.
    Guard (vl-elabtraversal-p outer-scope-path).

config — Guard (vl-simpconfig-p config).

Returns

warnings — Type (vl-warninglist-p warnings).

elabindex — with the overridden parameter values.

final-paramdecls — Type (vl-paramdecllist-p final-paramdecls).

Definitions and Theorems

Function: vl-scope-finalize-params-fn

(defun vl-scope-finalize-params-fn
       (formals actuals warnings elabindex
                outer-ss outer-scope-path config)
 (declare (xargs :stobjs (elabindex)))
 (declare (xargs :guard (and (vl-paramdecllist-p formals)
                             (vl-paramargs-p actuals)
                             (vl-warninglist-p warnings)
                             (vl-scopestack-p outer-ss)
                             (vl-elabtraversal-p outer-scope-path)
                             (vl-simpconfig-p config))))
 (let ((__function__ 'vl-scope-finalize-params))
  (declare (ignorable __function__))
  (b*
   (((mv ok warnings overrides)
     (vl-make-paramdecloverrides
          formals actuals
          (vl-simpconfig->unparam-bad-instance-fatalp config)
          warnings))
    ((unless ok)
     (mv nil warnings elabindex nil))
    (mod-ss (vl-elabindex->ss))
    ((mv err mod-scope no-mod-ss)
     (vl-scopestack-case
          mod-ss
          :local (mv nil mod-ss.top mod-ss.super)
          :global (mv nil mod-ss.design (vl-scopestack-null))
          :null (mv t nil nil)))
    ((when err)
     (mv
      nil
      (fatal
           :type :vl-programming-error
           :msg
           "Empty scopestack -- expected at least the design scope")
      elabindex nil))
    (elabindex (vl-elabindex-update-ss no-mod-ss elabindex))
    (scopeinfo (vl-scope->scopeinfo mod-scope
                                    (vl-scopestack->design mod-ss)))
    (scopeinfo-with-empty-params
     (change-vl-scopeinfo
        scopeinfo
        :locals (make-fast-alist
                     (vl-paramdecllist-alist
                          (vl-paramdecllist-remove-defaults formals)
                          (vl-scopeinfo->locals scopeinfo)))))
    ((mv ok warnings final-paramdecls elabindex)
     (vl-scopeinfo-resolve-params
          overrides scopeinfo-with-empty-params
          elabindex outer-ss
          outer-scope-path nil warnings)))
   (mv ok
       warnings elabindex final-paramdecls))))

Theorem: vl-warninglist-p-of-vl-scope-finalize-params.warnings

(defthm vl-warninglist-p-of-vl-scope-finalize-params.warnings
 (b*
  (((mv ?successp
        ?warnings ?elabindex ?final-paramdecls)
    (vl-scope-finalize-params-fn formals actuals warnings elabindex
                                 outer-ss outer-scope-path config)))
  (vl-warninglist-p warnings))
 :rule-classes :rewrite)

Theorem: vl-paramdecllist-p-of-vl-scope-finalize-params.final-paramdecls

(defthm
    vl-paramdecllist-p-of-vl-scope-finalize-params.final-paramdecls
 (b*
  (((mv ?successp
        ?warnings ?elabindex ?final-paramdecls)
    (vl-scope-finalize-params-fn formals actuals warnings elabindex
                                 outer-ss outer-scope-path config)))
  (vl-paramdecllist-p final-paramdecls))
 :rule-classes :rewrite)

Theorem: vl-scope-finalize-params-fn-of-vl-paramdecllist-fix-formals

(defthm vl-scope-finalize-params-fn-of-vl-paramdecllist-fix-formals
 (equal
    (vl-scope-finalize-params-fn (vl-paramdecllist-fix formals)
                                 actuals warnings elabindex
                                 outer-ss outer-scope-path config)
    (vl-scope-finalize-params-fn formals actuals warnings elabindex
                                 outer-ss outer-scope-path config)))

Theorem: vl-scope-finalize-params-fn-vl-paramdecllist-equiv-congruence-on-formals

(defthm
 vl-scope-finalize-params-fn-vl-paramdecllist-equiv-congruence-on-formals
 (implies
  (vl-paramdecllist-equiv formals formals-equiv)
  (equal
     (vl-scope-finalize-params-fn formals actuals warnings elabindex
                                  outer-ss outer-scope-path config)
     (vl-scope-finalize-params-fn
          formals-equiv actuals warnings elabindex
          outer-ss outer-scope-path config)))
 :rule-classes :congruence)

Theorem: vl-scope-finalize-params-fn-of-vl-paramargs-fix-actuals

(defthm vl-scope-finalize-params-fn-of-vl-paramargs-fix-actuals
 (equal
    (vl-scope-finalize-params-fn formals (vl-paramargs-fix actuals)
                                 warnings elabindex
                                 outer-ss outer-scope-path config)
    (vl-scope-finalize-params-fn formals actuals warnings elabindex
                                 outer-ss outer-scope-path config)))

Theorem: vl-scope-finalize-params-fn-vl-paramargs-equiv-congruence-on-actuals

(defthm
 vl-scope-finalize-params-fn-vl-paramargs-equiv-congruence-on-actuals
 (implies
  (vl-paramargs-equiv actuals actuals-equiv)
  (equal
     (vl-scope-finalize-params-fn formals actuals warnings elabindex
                                  outer-ss outer-scope-path config)
     (vl-scope-finalize-params-fn
          formals actuals-equiv warnings elabindex
          outer-ss outer-scope-path config)))
 :rule-classes :congruence)

Theorem: vl-scope-finalize-params-fn-of-vl-warninglist-fix-warnings

(defthm vl-scope-finalize-params-fn-of-vl-warninglist-fix-warnings
 (equal
  (vl-scope-finalize-params-fn formals
                               actuals (vl-warninglist-fix warnings)
                               elabindex
                               outer-ss outer-scope-path config)
  (vl-scope-finalize-params-fn formals actuals warnings elabindex
                               outer-ss outer-scope-path config)))

Theorem: vl-scope-finalize-params-fn-vl-warninglist-equiv-congruence-on-warnings

(defthm
 vl-scope-finalize-params-fn-vl-warninglist-equiv-congruence-on-warnings
 (implies
  (vl-warninglist-equiv warnings warnings-equiv)
  (equal
     (vl-scope-finalize-params-fn formals actuals warnings elabindex
                                  outer-ss outer-scope-path config)
     (vl-scope-finalize-params-fn
          formals actuals warnings-equiv elabindex
          outer-ss outer-scope-path config)))
 :rule-classes :congruence)

Theorem: vl-scope-finalize-params-fn-of-vl-scopestack-fix-outer-ss

(defthm vl-scope-finalize-params-fn-of-vl-scopestack-fix-outer-ss
 (equal
    (vl-scope-finalize-params-fn
         formals actuals warnings
         elabindex (vl-scopestack-fix outer-ss)
         outer-scope-path config)
    (vl-scope-finalize-params-fn formals actuals warnings elabindex
                                 outer-ss outer-scope-path config)))

Theorem: vl-scope-finalize-params-fn-vl-scopestack-equiv-congruence-on-outer-ss

(defthm
 vl-scope-finalize-params-fn-vl-scopestack-equiv-congruence-on-outer-ss
 (implies
  (vl-scopestack-equiv outer-ss outer-ss-equiv)
  (equal
     (vl-scope-finalize-params-fn formals actuals warnings elabindex
                                  outer-ss outer-scope-path config)
     (vl-scope-finalize-params-fn formals actuals
                                  warnings elabindex outer-ss-equiv
                                  outer-scope-path config)))
 :rule-classes :congruence)

Theorem: vl-scope-finalize-params-fn-of-vl-elabtraversal-fix-outer-scope-path

(defthm
 vl-scope-finalize-params-fn-of-vl-elabtraversal-fix-outer-scope-path
 (equal
    (vl-scope-finalize-params-fn
         formals
         actuals warnings elabindex outer-ss
         (vl-elabtraversal-fix outer-scope-path)
         config)
    (vl-scope-finalize-params-fn formals actuals warnings elabindex
                                 outer-ss outer-scope-path config)))

Theorem: vl-scope-finalize-params-fn-vl-elabtraversal-equiv-congruence-on-outer-scope-path

(defthm
 vl-scope-finalize-params-fn-vl-elabtraversal-equiv-congruence-on-outer-scope-path
 (implies
  (vl-elabtraversal-equiv outer-scope-path outer-scope-path-equiv)
  (equal
    (vl-scope-finalize-params-fn formals actuals warnings elabindex
                                 outer-ss outer-scope-path config)
    (vl-scope-finalize-params-fn formals
                                 actuals warnings elabindex outer-ss
                                 outer-scope-path-equiv config)))
 :rule-classes :congruence)

Theorem: vl-scope-finalize-params-fn-of-vl-simpconfig-fix-config

(defthm vl-scope-finalize-params-fn-of-vl-simpconfig-fix-config
 (equal
    (vl-scope-finalize-params-fn formals actuals warnings
                                 elabindex outer-ss outer-scope-path
                                 (vl-simpconfig-fix config))
    (vl-scope-finalize-params-fn formals actuals warnings elabindex
                                 outer-ss outer-scope-path config)))

Theorem: vl-scope-finalize-params-fn-vl-simpconfig-equiv-congruence-on-config

(defthm
 vl-scope-finalize-params-fn-vl-simpconfig-equiv-congruence-on-config
 (implies
  (vl-simpconfig-equiv config config-equiv)
  (equal
    (vl-scope-finalize-params-fn formals actuals warnings elabindex
                                 outer-ss outer-scope-path config)
    (vl-scope-finalize-params-fn formals
                                 actuals warnings elabindex outer-ss
                                 outer-scope-path config-equiv)))
 :rule-classes :congruence)