DVT SystemVerilog IDE User Guide
Rev. 19.1.39, 7 November 2019

DVT SystemVerilog IDE User Guide

Table of Contents

1. Installation Checklist
1.1. Install DVT Using a pre-packed Distribution
1.2. Install DVT Using the Update Site
1.3. Check the DVT License
2. Predefined Projects
3. Getting Started
3.1. What is a Workspace
3.2. What is a Project
3.3. Project Natures
3.4. Workspace and Workbench
3.5. Refresh
3.6. Linked Resources
3.7. Backup and Local History
3.8. Basic Tutorial
3.8.1. Switch to the DVT Perspective
3.8.2. Open a Project
3.8.3. Configure the Build
3.8.4. Build the Project
3.8.5. Inspect the Compilation Errors
3.8.6. See Comments in Tooltips
3.8.7. Use Hyperlinks to Move Around in the Code
3.8.8. Quickly Open a Type (Class, Module, Interface)
3.8.9. Quickly Inspect the Class Hierarchy
3.8.10. Quickly Open a File
3.8.11. Quickly Move Inside the Editor
3.8.12. Inspect the Class Hierarchy and Class Members
3.8.13. Inspect the Design Hierarchy
3.8.14. Inspect the Verification Hierarchy
3.8.15. Browse Through All the Available Types (Classes, Modules, Interfaces)
3.8.16. Look for the Implementation of an Extern Function or Task
3.8.17. Search for Entities
3.8.18. Use Content Assist (Autocomplete)
3.8.19. Use Code Templates
3.8.20. Use Module Auto Instance
3.8.21. Expand Macros (Apply Preprocessing)
3.8.22. Trace Macro Errors
3.8.23. Track Tasks using TODO Markers
3.8.24. Quickly See the Current Scope in the Status Bar
3.8.25. Fold Code Regions in Order to Improve Readability
3.8.26. Access the Context Sensitive Help
4. Build Configurations
4.1. Non-top files
4.2. default.build
4.3. Auto-config
4.4. Emulating compiler invocations
4.5. Multiple .build Files
4.6. Compatibility Modes
4.6.1. Default DVT Compatibility Mode
4.6.2. vcs.vlogan Compatibility Mode
4.6.3. vcs.vhdlan Compatibility Mode
4.6.4. ius.irun Compatibility Mode
4.6.5. ius.perspec Compatibility Mode
4.6.6. questa.vlog Compatibility Mode
4.6.7. questa.vcom Compatibility Mode
4.6.8. gcc Compatibility Mode
4.7. Paths
4.8. Strings
4.9. Comments
4.10. Environment Variables
4.11. Including Other Argument Files
4.12. Build Persistence
4.13. DVT Auto-Linked
4.14. Run a Script Before Build
4.15. All Build Directives
4.16. e Language Test Files
4.17. e Language SPECMAN_PATH
4.18. SystemVerilog OVM or UVM Library Compilation
4.19. Xilinx Libraries Compilation
4.20. Intel(Altera) Quartus Libraries Compilation
5. Compile Checks
5.1. Compile Waivers
5.2. Semantic Checks
5.3. Non Standard Checks
6. Content Assist (Autocomplete)
6.1. Content assist for CamelCase and Underscore
6.2. Code Templates
6.3. Module Automatic Instantiation
6.4. Override Functions Using Autocomplete
7. Quick Fix Proposals
7.1. Add Parameter to Module
7.2. Add Port to Module
7.3. Add Signal to Sensitivity List
7.4. Add Virtual Qualifier to Interface Type
7.5. Correct Spelling In Comments and Strings
7.6. Create File From Build Config Editor
7.7. Create Included File
7.8. Declare Method
7.9. Declare Variable
7.10. Did You Mean
7.11. Fully Qualify Type
7.12. Implement Extern Method
7.13. Implement Missing Pure Virtual Methods
7.14. Import Type
7.15. Remove 'local' or 'protected' Qualifier
7.16. Remove Signal from Sensitivity List
7.17. Remove Signal Never Used
7.18. Update Extern Prototype/Implementation
7.19. Update Module Instance
7.20. Update Virtual Method Signature
7.21. Waive Compilation Problems
8. Quick Assist Proposals
8.1. Bind Method Call Arguments by Name
8.2. Bind Method Call Arguments by Position
8.3. Connect Instance Ports by Name
8.4. Connect Instance Ports by Position
8.5. Expand .* Port Connections
8.6. Explicitly Declare
8.7. Extract to Variable
8.8. Extract to Method
8.9. Join Extern and Implementation
8.10. Split to Extern and Implementation
8.11. Rename in File
9. Content Filters
9.1. Content Filters XML syntax
9.2. Filtering by element type
9.3. Content Filters Examples
9.4. Predefined Content Filters
10. Code Templates
10.1. Code Templates in Autocomplete
10.2. Global Code Templates
10.3. Project Level Code Templates
10.4. Code Templates View
11. File Templates
12. Project Templates
12.1. What is a project template?
12.2. How to generate code from a project template
12.2.1. Step 1. Specify Directories
12.2.2. Step 2. Specify Parameters
12.3. Template Configuration
12.3.1. template-config.xml
12.3.2. template.config
12.4. Add from Template
13. Code Formatting
13.1. Whitespace
13.2. Indentation
13.3. Vertical Alignment
13.4. Line Wrapping
13.5. Disable Format for Code Sections
13.6. Format Multiple Files
13.7. External
14. Override Functions
14.1. Override Annotation
14.2. Inspect Overrides in the Quick Type Hierarchy View
14.3. Inspect Overrides in the Layers View
14.4. Override Using the Dialog
14.5. Override Using Autocomplete
14.6. Override Using the Type Hierarchy View
15. Generate Getters and Setters
16. Module Automatic Instantiation
16.1. Autoinstance Using Autocomplete
16.2. Autoinstance Using Drag and Drop
17. Semantic Search
18. Show Usages, Readers or Writers
19. Favorite Searches
20. Show Constraints
21. Show Instances
22. Quick Search in Views
22.1. CamelCase
22.2. Simple Regex
22.3. Hierarchical Search
22.4. Search for Members
22.5. Search Port in Design Hierarchy
22.6. Search Port in Verification Hierarchy
22.7. Search all UVM Phase Overrides
22.8. Search Global API
23. Trace Connections
23.1. Trace Connections from Design Hierarchy
23.2. Trace Connections from Editor
23.3. Trace Connections View
23.4. Trace Path
24. Breadcrumb Navigation Bar
24.1. Design Breadcrumb
24.2. Verification Breadcrumb
24.3. Scope Breadcrumb
25. Code Factory
26. Refactoring
26.1. Rename Refactoring
26.2. Bind Method Call Arguments by Name
26.3. Bind Method Call Arguments by Position
26.4. Expand .* Port Connections
26.5. Extract to Variable
26.6. Extract to Method
26.7. Join Extern and Implementation
26.8. Split to Extern and Implementation
26.9. Connect Instances Across the Design Hierarchy
26.9.1. Connect Instances Using New Ports
26.9.2. Connect Instances Using Existing Ports
26.9.3. Preview Structural Changes in the Design Hierarchy
26.9.4. Connect Instances Toolbar
26.10. Add Port to Module from Selected Field
26.11. Add New Port to Module
26.12. Add New Parameter to Module
26.13. Refactoring Scripts
26.13.1. Writing a Refactoring Script
26.13.2. Applying a Refactoring Script
27. Diagrams
27.1. UML Diagrams
27.1.1. UML Diagrams - Select Types
27.1.2. UML Diagrams - Preferences
27.1.3. UML Diagrams - Legend
27.2. Architecture UML Diagrams
27.3. Sequences UML Diagrams
27.4. Design Diagrams
27.4.1. Schematic Diagrams
27.4.2. Flow Diagrams
27.4.3. Block Diagrams
27.4.4. Finite-State Machine Diagrams
27.4.5. Diagram Filters
27.4.6. Design Diagram Actions
27.4.7. Breadcrumb Navigation Bar
27.4.8. Low Power Format Support
27.5. UVM Components Diagrams
27.5.1. Component Diagrams from Verification Hierarchy
27.5.2. Component Diagrams from Simulation
27.5.3. Diagram Filters
27.6. Diagram Actions
27.7. Diagram Toolbar
27.8. WaveDrom Timing Diagrams
28. Low Power Format Support
28.1. Supply Network Diagram
29. Export HTML Documentation
29.1. Export HTML Documentation Wizard
29.2. Comments Formatting
29.2.1. JavaDoc
29.2.2. NaturalDocs
29.3. Customizing Documentation
30. External Tools Integration
30.1. Run Configurations
30.1.1. Run Configuration Session Type
30.1.2. Custom Shortcut and Button for a Run Configuration
30.1.3. Using environment variables in DVT Generic Run Configurations
30.1.4. Using an alias in a DVT Generic Run Configuration
30.1.5. DVT Generic Run Configuration Variables
30.2. Smart Log
30.2.1. Smart Log - Filters
30.2.2. Smart Log - Hyperlinks
30.2.3. Smart Log - Styles
30.3. External Builders
30.3.1. How to define a new external builder
30.3.2. How to invoke external builders
30.3.3. External Builder Output
30.3.4. Source Code Markers - errors warnings
30.4. External Documentation
30.4.1. Configure External Documentation
30.4.2. Browse External Documentation
30.4.3. Search External Documentation
31. Debugger Integration
31.1. Simulation Prerequisites
31.2. Launch a Debug Simulation
31.3. Connect to an Existing Simulation
31.4. Breakpoints
31.5. Threads, Call Stack, Stepping
31.6. Variables
31.7. Watch Expressions
31.8. Debug Specific Configurations
32. Custom Dialogs
32.1. Quick Steps
32.2. Customizing the Dialog Output
32.3. SWT/XML Reference
32.3.1. Layouts
32.3.2. Widgets
32.4. Custom Dialog Snapshots
32.4.1. Custom Dialog Snapshots File Syntax (XML)
33. Command Line Interface
33.1. dvt_cli.sh
33.2. Syntax
33.3. Notes
33.4. Examples
33.5. Makefile Example
33.6. Commands
33.6.1. Create a Project (Mixed-Language Capable)
33.6.2. Create a Project From an Existing Template
33.6.3. Import an Existing Project
33.6.4. List Compiled Files
33.6.5. Compare Files
33.6.6. Launch a Run Configuration
33.6.7. Open a File
33.6.8. Close a File
33.6.9. Open a Custom Dialog
33.6.10. Refresh a Project
33.6.11. Rebuild a Project
33.6.12. Print Edited File
33.6.13. Quit
33.6.14. Query the running status
33.6.15. Print version
34. Macros Support
34.1. Inactive Code Highlight
34.1.1. Overview
34.1.2. Settings
34.2. Macro Expansion
34.2.1. Overview
34.2.2. Triggering
34.2.3. Tips
34.2.4. IMPORTANT NOTE
34.3. Macros and Quick Macros Views
35. Reminders (TODO Markers)
36. OVM Support
36.1. OVM Compliance Review
36.1.1. Architecture Tab
36.1.2. Checks Tab
36.1.3. Statistics Tab
36.1.4. Waivers Tab
36.1.5. HTML Report
36.1.6. Problems View Integration
36.2. OVM Field Editor
36.2.1. Triggering
36.2.2. Interface
36.2.3. Problems
36.2.4. Tips
36.3. OVM Smart Log
36.4. Quick OVM Documentation Access
36.5. OVM Templates
37. UVM Support
37.1. UVM Browser
37.2. UVM Compliance Review
37.2.1. Architecture Tab
37.2.2. Checks Tab
37.2.3. Statistics Tab
37.2.4. Waivers Tab
37.2.5. HTML Report
37.2.6. Problems View Integration
37.3. UVM Content Filters
37.4. UVM Factory Queries
37.5. UVM Field Editor
37.5.1. Triggering
37.5.2. Interface
37.5.3. Problems
37.5.4. Tips
37.6. UVM Sequence Tree
37.7. UVM Smart Log
37.8. UVM Templates
37.9. UVM Verification Hierarchy
37.10. OVM to UVM Migration
37.10.1. Triggering
37.10.2. Preferences
37.10.3. Review changes
38. VMM Support
38.1. VMM Smart Log
38.2. Quick VMM Documentation Access
38.3. VMM Templates
39. Settings Management
39.1. Managed Settings
39.2. Unmanaged Settings
39.3. User and Common Settings Location
39.4. Use Cases
39.4.1. Memory Allocation Thresholds
39.4.2. Workspace Preferences
39.4.3. Run Configurations
39.4.4. Compile Waivers
39.4.5. Content Filters
39.4.6. External Builders
39.4.7. Export HTML Documentation
39.4.8. Custom Pragmas
39.5. Examples
39.6. Deprecated Settings Management (before DVT 3.5)
39.6.1. Workspace Settings
39.6.2. Project Settings
39.6.3. Other Settings
39.6.4. Importing Preferences From a Different Workspace
39.6.5. Customizing Default Settings Using dvt.ini
40. Reference
40.1. Common Shortcuts
40.2. Custom Pragmas
40.3. Editor Right Click Menu
40.3.1. Folding
40.3.2. Macros
40.3.3. Source
40.3.4. Code Factory
40.3.5. Show
40.3.6. References
40.3.7. Trace
40.3.8. Refactor
40.4. Hyperlinks
40.4.1. Hyperlinks in Comments
40.5. Icons and Decorations
40.5.1. Icons
40.5.2. Decorations
40.5.3. Changing Icon Colors
40.5.4. Project Colors
40.6. Scripts
40.6.1. dvt.sh
40.6.2. dvt_cli.sh
40.6.3. dvt_from_rawtokens.sh
40.6.4. dvt_kit_installer.sh
40.6.5. dvt_plugin_installer.sh
40.6.6. dvt_build.sh
40.7. Syntax Coloring
40.8. Toolbar Actions
40.9. Tooltips
40.10. Views
40.10.1. Checks View
40.10.2. Code Templates View
40.10.3. Compile Order View
40.10.4. Console View
40.10.5. Coverage View
40.10.6. Call Hierarchy View
40.10.7. Design Hierarchy View
40.10.8. Inspect View
40.10.9. Layers View
40.10.10. Macros View
40.10.11. Outline View
40.10.12. Problems View
40.10.13. Tasks View
40.10.14. Trace Connections View
40.10.15. Types View
40.10.16. Type Hierarchy View
40.10.17. UVM Browser View
40.10.18. UVM Sequence Tree View
40.10.19. Verification Hierarchy View
41. Application Notes
41.1. C/C++ support
41.2. Encrypted VIP Support
41.3. Preprocessed Files Support
41.4. FPGA Support
41.4.1. Intel(Altera) Quartus
41.4.2. Xilinx ISE/Vivado
41.5. Generating External Tool Scripts from the DVT Build Configuration
42. Tips and Tricks
43. Q & A
43.1. I am new to Eclipse, where should I start from?
43.2. Where can I find DVT Help?
43.3. How do I see and configure the key shortcuts?
43.4. Are there any backup files in Eclipse?
43.5. Workspace in use, cannot launch eclipse...
43.6. Locking is not possible in the directory...
43.7. How to start DVT Eclipse with a different eclipse.ini
43.8. Save could not be completed
43.9. IBM Clearcase Plugin
43.10. Non existing package mti_fli
43.11. DVT is crashing with "Problematic frame ld-linux-x86-64.so.2 _dl_rtld_di_serinfo
43.12. libxul.so undefined symbol
43.13. How to use Working Sets for filtering Problems/Task/Search views?
43.14. Diagram error - image has not been created
43.15. How to handle Simulator and Command Line Macros
43.16. How do I Access Files Outside Project Dir - Working with Linked Resources
43.17. Mapping Linux to Windows (/proj/ to Z:\proj\)
43.18. Subversive vs Subclipse
43.19. How do I associate a project with both DVT and CDT?
43.20. Can I use vi/vim along with DVT?
43.21. Can I perform dos2unix or unix2dos from DVT?
43.22. How can I configure Eclipse to use a local CVS repository?
43.23. I am using the Common Desktop Environment via Citrix and experiencing crashes. What can I do?
43.24. How do I change the background color of the Editor?
43.25. How to apply the dark color theme or other themes?
43.26. How do I change the tooltip colors?
43.27. How do I change Internet Proxy Settings?
43.28. Eclipse does not start, there is no Workspace, metadata or log file created
43.29. Workspace permissions
43.30. How do I link mylyn with Bugzilla?
43.31. How do I print source code?
43.32. How do I disable Eclipse Software Sites?
43.33. How do I revert to a previous version?
43.34. What are the most common shortcuts in DVT?
43.35. How does DVT integrate with emacs?
43.36. How does DVT integrate with CVS?
43.37. How to set an environment variable within a Run Configuration?
43.38. How to run a remote Unix commnad from DVT Eclipse for Windows?
43.39. Rebuild shortcut (Ctrl + Alt + R) does not work
43.40. Sometimes I experience DVT GUI hangs, what should I do?
43.41. Sometimes I experience DVT GUI hangs when switching from another X application to DVT
43.42. I want to use an alias in a DVT Generic Run Configuration, but it's not recognized
43.43. How to set multiple paths as sources of predefined projects ?
43.44. Lines are suddenly changing indentation when I edit text or move the cursor through the editor.
43.45. How to change the directory where the build log file is saved ?
43.46. How to find the DVT logs on Linux/Unix ?
43.47. How to create resource filters ?
43.48. How to create custom shortcut and button for a Run Configuration?
43.49. I know that file.foo is present in the project location, but I can't see it in the Navigator View
43.50. How to copy the full path to the file in the current editor?
43.51. How to adjust the console logs filters matching parameters?
43.52. When I switch to Block (Column) Selection mode the font changes
43.53. In Block (Column) Selection mode I see strange editng artifacts
43.54. How to modify the font size in the code editors?
43.55. How to automatically checkout/lock files from the revision control system ?
43.56. How can I see if a file is read-only?
43.57. How can I open a file in DVT from the terminal?
43.58. How can I open a file in DVT from Questa?
43.59. How do I change the name of the xterm opened by a DVT Generic Run Configuration?
44. What is New?
45. How to Report an Issue?
46. Legal Notices
47. Third Party Licenses