• Top
  • Documentation
  • Books
  • Boolean-reasoning
  • Projects
  • Debugging
  • Std
  • Proof-automation
  • Macro-libraries
  • ACL2
  • Interfacing-tools
  • Hardware-verification
    • Gl
    • Esim
    • Vl2014
    • Sv
    • Vwsim
    • Fgl
    • Vl
      • Syntax
      • Loader
        • Preprocessor
        • Vl-loadconfig
        • Vl-loadstate
        • Lexer
        • Parser
        • Vl-load-merge-descriptions
        • Vl-find-basename/extension
        • Vl-load-file
        • Vl-loadresult
        • Scope-of-defines
        • Vl-find-file
        • Vl-flush-out-descriptions
        • Vl-description
          • Vl-description-p
          • Vl-sort-descriptions
          • Vl-description-fix
          • Vl-find-description
          • Vl-description-equiv
          • Vl-description->origname
          • Vl-description->name
          • Vl-design-from-descriptions
          • Vl-make-descalist
          • Vl-design-descriptions
          • Vl-fast-filter-descriptions
          • Vl-fast-find-description
          • Vl-descalist
          • Vl-slow-delete-descriptions
        • Vl-read-file
        • Vl-includeskips-report-gather
        • Vl-load-main
        • Extended-characters
        • Vl-load
        • Vl-load-description
        • Vl-descriptions-left-to-load
        • Inject-warnings
        • Vl-preprocess-debug
        • Vl-write-preprocessor-debug-file
        • Vl-read-file-report-gather
        • Vl-load-descriptions
        • Vl-load-files
        • Translate-off
        • Vl-load-read-file-hook
        • Vl-read-file-report
        • Vl-loadstate-pad
        • Vl-load-summary
        • Vl-collect-modules-from-descriptions
        • Vl-loadstate->warnings
        • Vl-iskips-report
        • Vl-descriptionlist
      • Warnings
      • Getting-started
      • Utilities
      • Printer
      • Kit
      • Mlib
      • Transforms
    • X86isa
    • Svl
    • Rtl
  • Software-verification
  • Math
  • Testing-utilities

• Loader

Vl-description

Representation of an arbitrary, top-level element.

This is a ``transparent'' sum type introduced using deftranssum. It is simply any one of the following types:

• vl-module
• vl-udp
• vl-interface
• vl-package
• vl-program
• vl-class
• vl-config
• vl-bind
• vl-property
• vl-sequence
• vl-vardecl
• vl-taskdecl
• vl-fundecl
• vl-paramdecl
• vl-import
• vl-fwdtypedef
• vl-typedef
• vl-dpiimport
• vl-dpiexport

This corresponds to the description production in SystemVerilog. These are (the currently supported subset of) the items that can occur at the top level of a SystemVerilog design.

These are a temporary structure created by the loader. Most code in VL should never know or care about descriptions because, at the end of the loading process, we convert all of the descriptions into a vl-design-p.

Subtopics

Vl-description-p

Recognizer for vl-description.

Vl-sort-descriptions

Vl-description-fix

(vl-description-fix x) is a fty fixing function.

Vl-find-description

(vl-find-description name descs) retrieves the first description named x from descs.

Vl-description-equiv

Basic equivalence relation for vl-description structures.

Vl-description->origname

Get the name from most descriptions -- original version, i.e. not modified by unparameterization, in the cases of modules and interfaces.

Vl-description->name

Get the name from most descriptions, or nil if this description doesn't introduce a name (e.g., an import statement.

Vl-design-from-descriptions

Vl-make-descalist

Vl-design-descriptions

Vl-fast-filter-descriptions

Vl-fast-find-description

Vl-descalist

An alist mapping stringp to vl-description-p.

Vl-slow-delete-descriptions