• 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-unparam-add-to-ledger

Generate an instkey for an unparameterized module and add it to the ledger if it isn't there already.

Signature

(vl-unparam-add-to-ledger origname 
                          paramdecls ports ifportalist ledger 
                          inst-ss mod-ss &key (no-rename 'nil) 
                          user-name) 
 
  → 
(mv instkey ledger)

Arguments

origname — Original name of the module, e.g., my_adder.
    Guard (stringp origname).

paramdecls — Final, overridden paramdecls for the module.
    Guard (vl-paramdecllist-p paramdecls).

ports — Portlist including final interfaces for the module.
    Guard (vl-portlist-p ports).

ifportalist — Guard (vl-ifport-alist-p ifportalist).

ledger — Ledger for disambiguating generated module names.
    Guard (vl-unparam-ledger-p ledger).

inst-ss — Scopestack for the instantiating context.
    Guard (vl-scopestack-p inst-ss).

mod-ss — Scopestack for the instantiated module.
    Guard (vl-scopestack-p mod-ss).

user-name — Guard (maybe-stringp user-name).

Returns

instkey — Instance key uniquely identifying the module/parameter combo.
    Type (vl-unparam-instkey-p instkey).

ledger — Updated ledger whose instkeymap binds the instkey.
    Type (vl-unparam-ledger-p ledger).

Definitions and Theorems

Function: vl-unparam-add-to-ledger-fn

(defun vl-unparam-add-to-ledger-fn
       (origname paramdecls ports ifportalist ledger
                 inst-ss mod-ss no-rename user-name)
 (declare (xargs :guard (and (stringp origname)
                             (vl-paramdecllist-p paramdecls)
                             (vl-portlist-p ports)
                             (vl-ifport-alist-p ifportalist)
                             (vl-unparam-ledger-p ledger)
                             (vl-scopestack-p inst-ss)
                             (vl-scopestack-p mod-ss)
                             (maybe-stringp user-name))))
 (let ((__function__ 'vl-unparam-add-to-ledger))
  (declare (ignorable __function__))
  (b*
   (((vl-unparam-ledger ledger)
     (vl-unparam-ledger-fix ledger))
    (ifportalist (vl-ifport-alist-fix ifportalist))
    (origname (string-fix origname))
    (instkey (vl-unparam-inst->instkey
                  origname
                  paramdecls ifportalist inst-ss mod-ss))
    (existing (cdr (hons-get instkey ledger.instkeymap)))
    ((when existing) (mv instkey ledger))
    (basename
     (or user-name
         (if (or no-rename
                 (and (vl-paramdecllist-all-localp paramdecls)
                      (atom ifportalist)))
             origname
           (vl-unparam-basename origname paramdecls ifportalist
                                (not ledger.omit-default-params)))))
    ((mv newname ndb)
     (vl-namedb-plain-name basename ledger.ndb))
    (signature (make-vl-unparam-signature :modname origname
                                          :newname newname
                                          :final-params paramdecls
                                          :final-ports ports))
    (instkeymap (hons-acons instkey signature ledger.instkeymap)))
   (mv instkey
       (change-vl-unparam-ledger ledger
                                 :ndb ndb
                                 :instkeymap instkeymap)))))

Theorem: vl-unparam-instkey-p-of-vl-unparam-add-to-ledger.instkey

(defthm vl-unparam-instkey-p-of-vl-unparam-add-to-ledger.instkey
  (b* (((mv ?instkey ?ledger)
        (vl-unparam-add-to-ledger-fn
             origname
             paramdecls ports ifportalist ledger
             inst-ss mod-ss no-rename user-name)))
    (vl-unparam-instkey-p instkey))
  :rule-classes :rewrite)

Theorem: vl-unparam-ledger-p-of-vl-unparam-add-to-ledger.ledger

(defthm vl-unparam-ledger-p-of-vl-unparam-add-to-ledger.ledger
  (b* (((mv ?instkey ?ledger)
        (vl-unparam-add-to-ledger-fn
             origname
             paramdecls ports ifportalist ledger
             inst-ss mod-ss no-rename user-name)))
    (vl-unparam-ledger-p ledger))
  :rule-classes :rewrite)

Theorem: vl-unparam-add-to-ledger-binds-instkey

(defthm vl-unparam-add-to-ledger-binds-instkey
  (b* (((mv ?instkey ?ledger)
        (vl-unparam-add-to-ledger-fn
             origname
             paramdecls ports ifportalist ledger
             inst-ss mod-ss no-rename user-name)))
    (hons-assoc-equal instkey
                      (vl-unparam-ledger->instkeymap ledger))))

Theorem: vl-unparam-add-to-ledger-fn-of-str-fix-origname

(defthm vl-unparam-add-to-ledger-fn-of-str-fix-origname
 (equal
  (vl-unparam-add-to-ledger-fn (str-fix origname)
                               paramdecls ports ifportalist ledger
                               inst-ss mod-ss no-rename user-name)
  (vl-unparam-add-to-ledger-fn origname
                               paramdecls ports ifportalist ledger
                               inst-ss mod-ss no-rename user-name)))

Theorem: vl-unparam-add-to-ledger-fn-streqv-congruence-on-origname

(defthm vl-unparam-add-to-ledger-fn-streqv-congruence-on-origname
 (implies
  (streqv origname origname-equiv)
  (equal
    (vl-unparam-add-to-ledger-fn origname
                                 paramdecls ports ifportalist ledger
                                 inst-ss mod-ss no-rename user-name)
    (vl-unparam-add-to-ledger-fn
         origname-equiv
         paramdecls ports ifportalist ledger
         inst-ss mod-ss no-rename user-name)))
 :rule-classes :congruence)

Theorem: vl-unparam-add-to-ledger-fn-of-vl-paramdecllist-fix-paramdecls

(defthm
     vl-unparam-add-to-ledger-fn-of-vl-paramdecllist-fix-paramdecls
 (equal
  (vl-unparam-add-to-ledger-fn origname
                               (vl-paramdecllist-fix paramdecls)
                               ports ifportalist ledger
                               inst-ss mod-ss no-rename user-name)
  (vl-unparam-add-to-ledger-fn origname
                               paramdecls ports ifportalist ledger
                               inst-ss mod-ss no-rename user-name)))

Theorem: vl-unparam-add-to-ledger-fn-vl-paramdecllist-equiv-congruence-on-paramdecls

(defthm
 vl-unparam-add-to-ledger-fn-vl-paramdecllist-equiv-congruence-on-paramdecls
 (implies
  (vl-paramdecllist-equiv paramdecls paramdecls-equiv)
  (equal
    (vl-unparam-add-to-ledger-fn origname
                                 paramdecls ports ifportalist ledger
                                 inst-ss mod-ss no-rename user-name)
    (vl-unparam-add-to-ledger-fn
         origname paramdecls-equiv
         ports ifportalist ledger
         inst-ss mod-ss no-rename user-name)))
 :rule-classes :congruence)

Theorem: vl-unparam-add-to-ledger-fn-of-vl-portlist-fix-ports

(defthm vl-unparam-add-to-ledger-fn-of-vl-portlist-fix-ports
 (equal
  (vl-unparam-add-to-ledger-fn origname
                               paramdecls (vl-portlist-fix ports)
                               ifportalist ledger
                               inst-ss mod-ss no-rename user-name)
  (vl-unparam-add-to-ledger-fn origname
                               paramdecls ports ifportalist ledger
                               inst-ss mod-ss no-rename user-name)))

Theorem: vl-unparam-add-to-ledger-fn-vl-portlist-equiv-congruence-on-ports

(defthm
  vl-unparam-add-to-ledger-fn-vl-portlist-equiv-congruence-on-ports
 (implies
  (vl-portlist-equiv ports ports-equiv)
  (equal
    (vl-unparam-add-to-ledger-fn origname
                                 paramdecls ports ifportalist ledger
                                 inst-ss mod-ss no-rename user-name)
    (vl-unparam-add-to-ledger-fn
         origname paramdecls
         ports-equiv ifportalist ledger
         inst-ss mod-ss no-rename user-name)))
 :rule-classes :congruence)

Theorem: vl-unparam-add-to-ledger-fn-of-vl-ifport-alist-fix-ifportalist

(defthm
     vl-unparam-add-to-ledger-fn-of-vl-ifport-alist-fix-ifportalist
 (equal
  (vl-unparam-add-to-ledger-fn
       origname paramdecls
       ports (vl-ifport-alist-fix ifportalist)
       ledger
       inst-ss mod-ss no-rename user-name)
  (vl-unparam-add-to-ledger-fn origname
                               paramdecls ports ifportalist ledger
                               inst-ss mod-ss no-rename user-name)))

Theorem: vl-unparam-add-to-ledger-fn-vl-ifport-alist-equiv-congruence-on-ifportalist

(defthm
 vl-unparam-add-to-ledger-fn-vl-ifport-alist-equiv-congruence-on-ifportalist
 (implies
  (vl-ifport-alist-equiv ifportalist ifportalist-equiv)
  (equal
    (vl-unparam-add-to-ledger-fn origname
                                 paramdecls ports ifportalist ledger
                                 inst-ss mod-ss no-rename user-name)
    (vl-unparam-add-to-ledger-fn
         origname paramdecls
         ports ifportalist-equiv ledger
         inst-ss mod-ss no-rename user-name)))
 :rule-classes :congruence)

Theorem: vl-unparam-add-to-ledger-fn-of-vl-unparam-ledger-fix-ledger

(defthm vl-unparam-add-to-ledger-fn-of-vl-unparam-ledger-fix-ledger
 (equal
  (vl-unparam-add-to-ledger-fn origname paramdecls ports ifportalist
                               (vl-unparam-ledger-fix ledger)
                               inst-ss mod-ss no-rename user-name)
  (vl-unparam-add-to-ledger-fn origname
                               paramdecls ports ifportalist ledger
                               inst-ss mod-ss no-rename user-name)))

Theorem: vl-unparam-add-to-ledger-fn-vl-unparam-ledger-equiv-congruence-on-ledger

(defthm
 vl-unparam-add-to-ledger-fn-vl-unparam-ledger-equiv-congruence-on-ledger
 (implies
  (vl-unparam-ledger-equiv ledger ledger-equiv)
  (equal
    (vl-unparam-add-to-ledger-fn origname
                                 paramdecls ports ifportalist ledger
                                 inst-ss mod-ss no-rename user-name)
    (vl-unparam-add-to-ledger-fn
         origname paramdecls
         ports ifportalist ledger-equiv
         inst-ss mod-ss no-rename user-name)))
 :rule-classes :congruence)

Theorem: vl-unparam-add-to-ledger-fn-of-vl-scopestack-fix-inst-ss

(defthm vl-unparam-add-to-ledger-fn-of-vl-scopestack-fix-inst-ss
 (equal
  (vl-unparam-add-to-ledger-fn origname paramdecls ports ifportalist
                               ledger (vl-scopestack-fix inst-ss)
                               mod-ss no-rename user-name)
  (vl-unparam-add-to-ledger-fn origname
                               paramdecls ports ifportalist ledger
                               inst-ss mod-ss no-rename user-name)))

Theorem: vl-unparam-add-to-ledger-fn-vl-scopestack-equiv-congruence-on-inst-ss

(defthm
 vl-unparam-add-to-ledger-fn-vl-scopestack-equiv-congruence-on-inst-ss
 (implies
  (vl-scopestack-equiv inst-ss inst-ss-equiv)
  (equal
    (vl-unparam-add-to-ledger-fn origname
                                 paramdecls ports ifportalist ledger
                                 inst-ss mod-ss no-rename user-name)
    (vl-unparam-add-to-ledger-fn
         origname paramdecls
         ports ifportalist ledger inst-ss-equiv
         mod-ss no-rename user-name)))
 :rule-classes :congruence)

Theorem: vl-unparam-add-to-ledger-fn-of-vl-scopestack-fix-mod-ss

(defthm vl-unparam-add-to-ledger-fn-of-vl-scopestack-fix-mod-ss
 (equal
  (vl-unparam-add-to-ledger-fn origname
                               paramdecls ports ifportalist ledger
                               inst-ss (vl-scopestack-fix mod-ss)
                               no-rename user-name)
  (vl-unparam-add-to-ledger-fn origname
                               paramdecls ports ifportalist ledger
                               inst-ss mod-ss no-rename user-name)))

Theorem: vl-unparam-add-to-ledger-fn-vl-scopestack-equiv-congruence-on-mod-ss

(defthm
 vl-unparam-add-to-ledger-fn-vl-scopestack-equiv-congruence-on-mod-ss
 (implies
  (vl-scopestack-equiv mod-ss mod-ss-equiv)
  (equal
    (vl-unparam-add-to-ledger-fn origname
                                 paramdecls ports ifportalist ledger
                                 inst-ss mod-ss no-rename user-name)
    (vl-unparam-add-to-ledger-fn origname paramdecls
                                 ports ifportalist ledger inst-ss
                                 mod-ss-equiv no-rename user-name)))
 :rule-classes :congruence)

Theorem: vl-unparam-add-to-ledger-fn-of-maybe-string-fix-user-name

(defthm vl-unparam-add-to-ledger-fn-of-maybe-string-fix-user-name
 (equal
  (vl-unparam-add-to-ledger-fn
       origname paramdecls
       ports ifportalist ledger inst-ss mod-ss
       no-rename (maybe-string-fix user-name))
  (vl-unparam-add-to-ledger-fn origname
                               paramdecls ports ifportalist ledger
                               inst-ss mod-ss no-rename user-name)))

Theorem: vl-unparam-add-to-ledger-fn-maybe-string-equiv-congruence-on-user-name

(defthm
 vl-unparam-add-to-ledger-fn-maybe-string-equiv-congruence-on-user-name
 (implies
  (maybe-string-equiv user-name user-name-equiv)
  (equal
    (vl-unparam-add-to-ledger-fn origname
                                 paramdecls ports ifportalist ledger
                                 inst-ss mod-ss no-rename user-name)
    (vl-unparam-add-to-ledger-fn origname paramdecls
                                 ports ifportalist ledger inst-ss
                                 mod-ss no-rename user-name-equiv)))
 :rule-classes :congruence)