• 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
      • Lint
      • Mlib
      • Server
      • Kit
        • Vl-model
        • Vl-json
        • Vl-gather
          • Vl-gather-opts-p
        • Vl-server
        • Vl-pp
        • Vl-lint
        • Vl-main
        • Vl-toolkit-other-command
        • Vl-help
      • Printer
      • Esim-vl
      • Well-formedness
    • Sv
    • Fgl
    • Vwsim
    • Vl
    • X86isa
    • Svl
    • Rtl
  • Software-verification
  • Math
  • Testing-utilities

• Kit

Vl-gather

The vl gather command.

Signature

(vl-gather argv &key (state 'state)) → state

Arguments

argv — Guard (string-listp argv).

Definitions and Theorems

Function: vl-gather-fn

(defun vl-gather-fn (argv state)
  (declare (xargs :stobjs (state)))
  (declare (xargs :guard (string-listp argv)))
  (let ((__function__ 'vl-gather))
    (declare (ignorable __function__))
    (b* (((mv errmsg opts start-files)
          (parse-vl-gather-opts argv))
         ((when errmsg)
          (die "~@0~%" errmsg)
          state)
         (opts (change-vl-gather-opts opts
                                      :start-files start-files))
         ((vl-gather-opts opts) opts)
         ((when opts.help)
          (vl-cw-ps-seq (vl-print *vl-gather-help*))
          (exit-ok)
          state)
         ((when opts.readme)
          (vl-cw-ps-seq (vl-print *vl-gather-readme*))
          (exit-ok)
          state)
         ((unless (consp opts.start-files))
          (die "No files to process.")
          state)
         (- (cw "VL Gather Configuration:~%"))
         (- (cw " - start files: ~x0~%"
                opts.start-files))
         (state (must-be-regular-files! opts.start-files))
         (- (cw " - search path: ~x0~%"
                opts.search-path))
         (state (must-be-directories! opts.search-path))
         (- (cw " - include directories: ~x0~%"
                opts.include-dirs))
         (state (must-be-directories! opts.include-dirs))
         (- (and opts.defines
                 (cw "; defines: ~x0~%" opts.defines)))
         (- (cw " - output file: ~x0~%" opts.output))
         (- (cw "; Soft heap size ceiling: ~x0 GB~%"
                opts.mem))
         (- (acl2::set-max-mem (* (expt 2 30) opts.mem)))
         (state (vl-gather-main opts)))
      (exit-ok)
      state)))

Subtopics

Vl-gather-opts-p

Options for running vl gather.