• Top
  • Documentation
  • Books
  • Boolean-reasoning
  • Projects
  • Debugging
  • Std
  • Proof-automation
  • Macro-libraries
  • ACL2
  • Interfacing-tools
  • Hardware-verification
    • Gl
    • Esim
    • Vl2014
      • Warnings
      • Primitives
      • Use-set
      • Syntax
      • Getting-started
      • Utilities
      • Loader
      • Transforms
        • Expression-sizing
        • Occform
        • Oprewrite
        • Expand-functions
        • Delayredux
        • Unparameterization
          • Scopesubst
          • Vl-scopeinfo-resolve-params
          • Vl-make-paramdecloverrides
          • Vl-unparam-inst
          • Vl-scope-finalize-params
          • Vl-override-parameter-value
          • Vl-unparam-instlist
          • Vl-create-unparameterized-module
          • Vl-module-default-signature
          • Vl-modulelist-default-signatures
          • Vl-gencase-some-match
          • Vl-gencase-match
          • Vl-make-paramdecloverrides-named
          • Vl-unparam-newname
          • Vl-paramdecl-set-default
          • Vl-unparam-signature
          • Vl-genblob-collect-modinst-paramsigs
          • Vl-design-unparameterize
          • Vl-paramdecllist-remove-defaults
          • Vl-unparam-newname-exprstring
          • Vl-paramdecl-remove-default
          • Vl-unparam-sigalist
          • Vl-unparam-signaturelist
        • Caseelim
        • Split
        • Selresolve
        • Weirdint-elim
        • Vl-delta
        • Replicate-insts
        • Rangeresolve
        • Propagate
        • Clean-selects
        • Clean-params
        • Blankargs
        • Inline-mods
        • Expr-simp
        • Trunc
        • Always-top
        • Gatesplit
        • Gate-elim
        • Expression-optimization
        • Elim-supplies
        • Wildelim
        • Drop-blankports
        • Clean-warnings
        • Addinstnames
        • Custom-transform-hooks
        • Annotate
        • Latchcode
        • Elim-unused-vars
        • Problem-modules
      • Lint
      • Mlib
      • Server
      • Kit
      • Printer
      • Esim-vl
      • Well-formedness
    • Sv
    • Fgl
    • Vwsim
    • Vl
    • X86isa
    • Svl
    • Rtl
  • Software-verification
  • Math
  • Testing-utilities

• Unparameterization

Vl-unparam-inst

Try to unparameterize a single module instance.

Signature

(vl-unparam-inst inst ss warnings modname) 
  → 
(mv successp warnings inst needed-sigs mod-ss)

Arguments

inst — Instance of some module. The module being instantiated may or may not have parameters.
    Guard (vl-modinst-p inst).

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

warnings — Warnings accumulator for the submodule.
    Guard (vl-warninglist-p warnings).

modname — Containing module name, for context.
    Guard (stringp modname).

Returns

successp — Type (booleanp successp).

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

inst — Updated module instance, perhaps instantiating a new module like my_adder$width=5 instead of my_adder.
    Type (vl-modinst-p inst).

needed-sigs — An unparam-signature for the instantiated module, if needed.
    Type (iff (vl-unparam-signature-p needed-sigs) needed-sigs).

mod-ss — Scopestack which (on success) contains the module with its final parameters.
    Type (vl-scopestack-p mod-ss).

Definitions and Theorems

Function: vl-unparam-inst

(defun vl-unparam-inst (inst ss warnings modname)
 (declare (xargs :guard (and (vl-modinst-p inst)
                             (vl-scopestack-p ss)
                             (vl-warninglist-p warnings)
                             (stringp modname))))
 (let ((__function__ 'vl-unparam-inst))
  (declare (ignorable __function__))
  (b*
   (((vl-modinst inst)
     (vl-modinst-fix inst))
    (mod (vl-scopestack-find-definition inst.modname ss))
    (ss (vl-scopestack-fix ss))
    ((unless (and mod
                  (or (eq (tag mod) :vl-module)
                      (eq (tag mod) :vl-interface))))
     (vl-unparam-debug "~a0: can't find module ~a1.~%"
                       inst inst.modname)
     (mv
      nil
      (fatal :type :vl-bad-instance
             :msg "~a0: trying to instantiate undefined module ~s1."
             :args (list inst inst.modname))
      inst nil ss))
    ((when (eq (tag mod) :vl-interface))
     (mv t (ok) inst nil ss))
    ((vl-module mod) mod)
    ((when (atom mod.paramdecls))
     (if (vl-paramargs-empty-p inst.paramargs)
         (mv t (ok)
             inst
             (make-vl-unparam-signature :modname inst.modname)
             (vl-scopestack-push mod ss))
      (mv
       nil
       (fatal
        :type :vl-bad-instance
        :msg
        "~a0: parameter arguments given to ~s1, but ~s1 ~
                           does not take any parameters."
        :args (list inst inst.modname))
       inst nil ss)))
    (ctx (make-vl-context :mod modname
                          :elem inst))
    ((mv ok warnings mod-ss final-paramdecls)
     (vl-scope-finalize-params mod mod.paramdecls
                               inst.paramargs warnings ss ctx))
    ((unless ok)
     (vl-unparam-debug "~a0: failed to finalize params~%" inst)
     (mv nil warnings inst nil ss))
    (new-modname (vl-unparam-newname inst.modname final-paramdecls))
    (new-inst (change-vl-modinst
                   inst
                   :modname new-modname
                   :paramargs (make-vl-paramargs-plain :args nil)))
    (unparam-signature
        (make-vl-unparam-signature :modname inst.modname
                                   :final-params final-paramdecls)))
   (vl-unparam-debug "~a0: success, new instance is ~a1.~%"
                     inst new-inst)
   (mv t warnings
       new-inst unparam-signature mod-ss))))

Theorem: booleanp-of-vl-unparam-inst.successp

(defthm booleanp-of-vl-unparam-inst.successp
  (b* (((mv ?successp
            ?warnings ?inst ?needed-sigs ?mod-ss)
        (vl-unparam-inst inst ss warnings modname)))
    (booleanp successp))
  :rule-classes :type-prescription)

Theorem: vl-warninglist-p-of-vl-unparam-inst.warnings

(defthm vl-warninglist-p-of-vl-unparam-inst.warnings
  (b* (((mv ?successp
            ?warnings ?inst ?needed-sigs ?mod-ss)
        (vl-unparam-inst inst ss warnings modname)))
    (vl-warninglist-p warnings))
  :rule-classes :rewrite)

Theorem: vl-modinst-p-of-vl-unparam-inst.inst

(defthm vl-modinst-p-of-vl-unparam-inst.inst
  (b* (((mv ?successp
            ?warnings ?inst ?needed-sigs ?mod-ss)
        (vl-unparam-inst inst ss warnings modname)))
    (vl-modinst-p inst))
  :rule-classes :rewrite)

Theorem: return-type-of-vl-unparam-inst.needed-sigs

(defthm return-type-of-vl-unparam-inst.needed-sigs
  (b* (((mv ?successp
            ?warnings ?inst ?needed-sigs ?mod-ss)
        (vl-unparam-inst inst ss warnings modname)))
    (iff (vl-unparam-signature-p needed-sigs)
         needed-sigs))
  :rule-classes :rewrite)

Theorem: vl-scopestack-p-of-vl-unparam-inst.mod-ss

(defthm vl-scopestack-p-of-vl-unparam-inst.mod-ss
  (b* (((mv ?successp
            ?warnings ?inst ?needed-sigs ?mod-ss)
        (vl-unparam-inst inst ss warnings modname)))
    (vl-scopestack-p mod-ss))
  :rule-classes :rewrite)

Theorem: vl-unparam-inst-of-vl-modinst-fix-inst

(defthm vl-unparam-inst-of-vl-modinst-fix-inst
  (equal (vl-unparam-inst (vl-modinst-fix inst)
                          ss warnings modname)
         (vl-unparam-inst inst ss warnings modname)))

Theorem: vl-unparam-inst-vl-modinst-equiv-congruence-on-inst

(defthm vl-unparam-inst-vl-modinst-equiv-congruence-on-inst
  (implies (vl-modinst-equiv inst inst-equiv)
           (equal (vl-unparam-inst inst ss warnings modname)
                  (vl-unparam-inst inst-equiv ss warnings modname)))
  :rule-classes :congruence)

Theorem: vl-unparam-inst-of-vl-scopestack-fix-ss

(defthm vl-unparam-inst-of-vl-scopestack-fix-ss
  (equal (vl-unparam-inst inst (vl-scopestack-fix ss)
                          warnings modname)
         (vl-unparam-inst inst ss warnings modname)))

Theorem: vl-unparam-inst-vl-scopestack-equiv-congruence-on-ss

(defthm vl-unparam-inst-vl-scopestack-equiv-congruence-on-ss
  (implies (vl-scopestack-equiv ss ss-equiv)
           (equal (vl-unparam-inst inst ss warnings modname)
                  (vl-unparam-inst inst ss-equiv warnings modname)))
  :rule-classes :congruence)

Theorem: vl-unparam-inst-of-vl-warninglist-fix-warnings

(defthm vl-unparam-inst-of-vl-warninglist-fix-warnings
  (equal (vl-unparam-inst inst ss (vl-warninglist-fix warnings)
                          modname)
         (vl-unparam-inst inst ss warnings modname)))

Theorem: vl-unparam-inst-vl-warninglist-equiv-congruence-on-warnings

(defthm vl-unparam-inst-vl-warninglist-equiv-congruence-on-warnings
  (implies (vl-warninglist-equiv warnings warnings-equiv)
           (equal (vl-unparam-inst inst ss warnings modname)
                  (vl-unparam-inst inst ss warnings-equiv modname)))
  :rule-classes :congruence)

Theorem: vl-unparam-inst-of-str-fix-modname

(defthm vl-unparam-inst-of-str-fix-modname
  (equal (vl-unparam-inst inst ss warnings (str-fix modname))
         (vl-unparam-inst inst ss warnings modname)))

Theorem: vl-unparam-inst-streqv-congruence-on-modname

(defthm vl-unparam-inst-streqv-congruence-on-modname
  (implies (streqv modname modname-equiv)
           (equal (vl-unparam-inst inst ss warnings modname)
                  (vl-unparam-inst inst ss warnings modname-equiv)))
  :rule-classes :congruence)