• Top
    • Documentation
    • Books
    • Boolean-reasoning
    • Projects
    • Debugging
    • Community
    • Std
    • 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
          • Elaborate
          • Addnames
          • Annotate
            • Increment-elim
            • Make-implicit-wires
            • Basic-bind-elim
            • Argresolve
              • Vl-convert-namedargs
                • Vl-expand-dotstar-arguments
                  • Vl-create-namedarg-for-dotstar
                    • Vl-create-namedargs-for-dotstar
                  • Vl-convert-namedargs-aux
                  • Vl-find-namedarg
                  • Vl-convert-namedargs-aux-fal
                • Vl-unhierarchicalize-interfaceport
                • Vl-interfacelist-argresolve
                • Vl-modulelist-argresolve
                • Vl-gateinst-dirassign
                • Vl-arguments-argresolve
                • Vl-unhierarchicalize-interfaceports
                • Vl-check-blankargs
                • Vl-annotate-plainargs
                • Vl-modinst-maybe-argresolve
                • Vl-modinst-argresolve
                • Vl-modinstlist-argresolve
                • Vl-gateinstlist-dirassign
                • Vl-interface-argresolve
                • Vl-module-argresolve
                • Vl-namedarglist-alist
                • Vl-make-namedarg-alist
                • Vl-design-argresolve
                • Vl-fast-find-namedarg
                • Vl-namedarg-alist
                • Vl-scopeitem-modport-p
                • Vl-scopeitem-modinst-p
                • Vl-scopeitem-interfaceport-p
                • Vl-port-interface-p
              • Basicsanity
              • Portdecl-sign
              • Enum-names
              • Port-resolve
              • Udp-elim
              • Vl-annotate-design
              • Vl-annotate-module
            • Clean-warnings
            • Eliminitial
            • Custom-transform-hooks
            • Problem-modules
        • X86isa
        • Svl
        • Rtl
      • Software-verification
      • Math
      • Testing-utilities
    • Vl-expand-dotstar-arguments

    Vl-create-namedarg-for-dotstar

    Create a single missing argument for a .* connection.

    Signature
    (vl-create-namedarg-for-dotstar name ss warnings inst) 
      → 
    (mv successp warnings new-args)
    Arguments
    name — Name of the submodule port that is implicitly connected by .*.
        Guard (stringp name).
    ss — Scopestack for the superior module.
        Guard (vl-scopestack-p ss).
    warnings — Warnings accumulator.
        Guard (vl-warninglist-p warnings).
    inst — Context for warnings.
        Guard (vl-modinst-p inst).
    Returns
    successp — Type (booleanp successp).
    warnings — Type (vl-warninglist-p warnings).
    new-args — Type (vl-namedarglist-p new-args).

    Definitions and Theorems

    Function: vl-create-namedarg-for-dotstar

    (defun vl-create-namedarg-for-dotstar (name ss warnings inst)
     (declare (xargs :guard (and (stringp name)
                                 (vl-scopestack-p ss)
                                 (vl-warninglist-p warnings)
                                 (vl-modinst-p inst))))
     (let ((__function__ 'vl-create-namedarg-for-dotstar))
      (declare (ignorable __function__))
      (b*
       ((name (string-fix name))
        ((vl-modinst inst)
         (vl-modinst-fix inst))
        (look (vl-scopestack-find-item name ss))
        ((unless look)
         (mv
          nil
          (fatal
           :type :vl-dotstar-missing-var
           :msg
           "~a0: using .* syntax to instantiate ~m1, but there is ~
                             no declaration for port ~s2."
           :args (list inst inst.modname name))
          nil))
        ((when (eq (tag look) :vl-vardecl))
         (b* ((new-arg (make-vl-namedarg :name name
                                         :expr (vl-idexpr name)
                                         :nameonly-p t
                                         :atts nil)))
           (mv t (ok) (list new-arg))))
        ((when (eq (tag look) :vl-modinst))
         (b*
          (((vl-modinst look))
           (mod/if (vl-scopestack-find-definition look.modname ss))
           ((unless mod/if)
            (mv
             nil
             (fatal
              :type :vl-dotstar-missing-intfc
              :msg
              "~a0: trying to resolve .* connection for ~
                                   ~w1 (type ~m2): but ~m2 is not defined."
              :args (list inst name look.modname))
             nil))
           ((when (eq (tag mod/if) :vl-interface))
            (b* ((new-arg (make-vl-namedarg :name name
                                            :expr (vl-idexpr name)
                                            :nameonly-p t
                                            :atts nil)))
              (mv t (ok) (list new-arg)))))
          (mv
           nil
           (fatal
            :type :vl-dotstar-bad-intfc
            :msg
            "~a0: using .* syntax to instantiate ~m1 would ~
                               result in connecting port ~s2 to ~a3, which is ~
                               an instance of a ~x4."
            :args (list inst
                        inst.modname name look (tag mod/if)))
           nil)))
        ((when (eq (tag look) :vl-interfaceport))
         (b* ((new-arg (make-vl-namedarg :name name
                                         :expr (vl-idexpr name)
                                         :nameonly-p t
                                         :atts nil)))
           (mv t (ok) (list new-arg)))))
       (mv
        nil
        (fatal
         :type :vl-dotstar-bad-port-connection
         :msg
         "~a0: using .* syntax to instantiate ~m1 would result in ~
                         connecting port ~s2 to ~a3, which has unsupported type ~
                         ~x4."
         :args (list inst inst.modname name look (tag look)))
        nil))))

    Theorem: booleanp-of-vl-create-namedarg-for-dotstar.successp

    (defthm booleanp-of-vl-create-namedarg-for-dotstar.successp
      (b* (((mv ?successp ?warnings ?new-args)
            (vl-create-namedarg-for-dotstar name ss warnings inst)))
        (booleanp successp))
      :rule-classes :type-prescription)

    Theorem: vl-warninglist-p-of-vl-create-namedarg-for-dotstar.warnings

    (defthm vl-warninglist-p-of-vl-create-namedarg-for-dotstar.warnings
      (b* (((mv ?successp ?warnings ?new-args)
            (vl-create-namedarg-for-dotstar name ss warnings inst)))
        (vl-warninglist-p warnings))
      :rule-classes :rewrite)

    Theorem: vl-namedarglist-p-of-vl-create-namedarg-for-dotstar.new-args

    (defthm vl-namedarglist-p-of-vl-create-namedarg-for-dotstar.new-args
      (b* (((mv ?successp ?warnings ?new-args)
            (vl-create-namedarg-for-dotstar name ss warnings inst)))
        (vl-namedarglist-p new-args))
      :rule-classes :rewrite)

    Theorem: true-listp-of-vl-create-namedarg-for-dotstar.new-args

    (defthm true-listp-of-vl-create-namedarg-for-dotstar.new-args
      (b* (((mv ?successp ?warnings ?new-args)
            (vl-create-namedarg-for-dotstar name ss warnings inst)))
        (true-listp new-args))
      :rule-classes :type-prescription)

    Theorem: vl-create-namedarg-for-dotstar-of-str-fix-name

    (defthm vl-create-namedarg-for-dotstar-of-str-fix-name
      (equal (vl-create-namedarg-for-dotstar (str-fix name)
                                             ss warnings inst)
             (vl-create-namedarg-for-dotstar name ss warnings inst)))

    Theorem: vl-create-namedarg-for-dotstar-streqv-congruence-on-name

    (defthm vl-create-namedarg-for-dotstar-streqv-congruence-on-name
     (implies
      (streqv name name-equiv)
      (equal
          (vl-create-namedarg-for-dotstar name ss warnings inst)
          (vl-create-namedarg-for-dotstar name-equiv ss warnings inst)))
     :rule-classes :congruence)

    Theorem: vl-create-namedarg-for-dotstar-of-vl-scopestack-fix-ss

    (defthm vl-create-namedarg-for-dotstar-of-vl-scopestack-fix-ss
      (equal (vl-create-namedarg-for-dotstar name (vl-scopestack-fix ss)
                                             warnings inst)
             (vl-create-namedarg-for-dotstar name ss warnings inst)))

    Theorem: vl-create-namedarg-for-dotstar-vl-scopestack-equiv-congruence-on-ss

    (defthm
     vl-create-namedarg-for-dotstar-vl-scopestack-equiv-congruence-on-ss
     (implies
      (vl-scopestack-equiv ss ss-equiv)
      (equal
          (vl-create-namedarg-for-dotstar name ss warnings inst)
          (vl-create-namedarg-for-dotstar name ss-equiv warnings inst)))
     :rule-classes :congruence)

    Theorem: vl-create-namedarg-for-dotstar-of-vl-warninglist-fix-warnings

    (defthm
          vl-create-namedarg-for-dotstar-of-vl-warninglist-fix-warnings
      (equal (vl-create-namedarg-for-dotstar
                  name ss (vl-warninglist-fix warnings)
                  inst)
             (vl-create-namedarg-for-dotstar name ss warnings inst)))

    Theorem: vl-create-namedarg-for-dotstar-vl-warninglist-equiv-congruence-on-warnings

    (defthm
     vl-create-namedarg-for-dotstar-vl-warninglist-equiv-congruence-on-warnings
     (implies
      (vl-warninglist-equiv warnings warnings-equiv)
      (equal
          (vl-create-namedarg-for-dotstar name ss warnings inst)
          (vl-create-namedarg-for-dotstar name ss warnings-equiv inst)))
     :rule-classes :congruence)

    Theorem: vl-create-namedarg-for-dotstar-of-vl-modinst-fix-inst

    (defthm vl-create-namedarg-for-dotstar-of-vl-modinst-fix-inst
      (equal (vl-create-namedarg-for-dotstar
                  name ss warnings (vl-modinst-fix inst))
             (vl-create-namedarg-for-dotstar name ss warnings inst)))

    Theorem: vl-create-namedarg-for-dotstar-vl-modinst-equiv-congruence-on-inst

    (defthm
     vl-create-namedarg-for-dotstar-vl-modinst-equiv-congruence-on-inst
     (implies
      (vl-modinst-equiv inst inst-equiv)
      (equal
          (vl-create-namedarg-for-dotstar name ss warnings inst)
          (vl-create-namedarg-for-dotstar name ss warnings inst-equiv)))
     :rule-classes :congruence)