Loading [MathJax]/extensions/tex2jax.js
CIRCT 21.0.0git
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ImportVerilog.h
Go to the documentation of this file.
1//===- ImportVerilog.h - Slang Verilog frontend integration ---------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// Defines the interface to the Verilog frontend.
10//
11//===----------------------------------------------------------------------===//
12
13#ifndef CIRCT_CONVERSION_IMPORTVERILOG_H
14#define CIRCT_CONVERSION_IMPORTVERILOG_H
15
16#include "circt/Support/LLVM.h"
17#include <cstdint>
18#include <optional>
19#include <string>
20#include <vector>
21
22namespace llvm {
23class SourceMgr;
24} // namespace llvm
25
26namespace mlir {
27class LocationAttr;
28class TimingScope;
29} // namespace mlir
30
31namespace circt {
32
33/// Options that control how Verilog input files are parsed and processed.
34///
35/// See `slang::driver::Driver::Options` for inspiration. Also check out
36/// `Driver::addStandardArgs()` for some inspiration on how to expose these on
37/// the command line.
39 /// Limit importing to linting or parsing only.
40 enum class Mode {
41 /// Only lint the input, without elaboration and lowering to CIRCT IR.
43 /// Only parse and elaborate the input, without mapping to CIRCT IR.
45 /// Perform a full import and mapping to CIRCT IR.
46 Full
47 };
49
50 /// Generate debug information in the form of debug dialect ops in the IR.
51 bool debugInfo = false;
52
53 /// Interpret `always @(*)` as `always_comb`.
55
56 //===--------------------------------------------------------------------===//
57 // Include paths
58 //===--------------------------------------------------------------------===//
59
60 /// A list of include directories in which to search for files.
61 std::vector<std::string> includeDirs;
62
63 /// A list of system include directories in which to search for files.
64 std::vector<std::string> includeSystemDirs;
65
66 /// A list of library directories in which to search for missing modules.
67 std::vector<std::string> libDirs;
68
69 /// A list of extensions that will be used to search for library files.
70 std::vector<std::string> libExts;
71
72 /// A list of extensions that will be used to exclude files.
73 std::vector<std::string> excludeExts;
74
75 /// A list of preprocessor directives to be ignored.
76 std::vector<std::string> ignoreDirectives;
77
78 //===--------------------------------------------------------------------===//
79 // Preprocessing
80 //===--------------------------------------------------------------------===//
81
82 /// The maximum depth of included files before an error is issued.
83 std::optional<uint32_t> maxIncludeDepth;
84
85 /// A list of macros that should be defined in each compilation unit.
86 std::vector<std::string> defines;
87
88 /// A list of macros that should be undefined in each compilation unit.
89 std::vector<std::string> undefines;
90
91 /// If true, library files will inherit macro definitions from primary source
92 /// files.
93 std::optional<bool> librariesInheritMacros;
94
95 //===--------------------------------------------------------------------===//
96 // Compilation
97 //===--------------------------------------------------------------------===//
98
99 /// A string that indicates the default time scale to use for any design
100 /// elements that don't specify one explicitly.
101 std::optional<std::string> timeScale;
102
103 /// If true, allow various to be referenced before they are declared.
104 std::optional<bool> allowUseBeforeDeclare;
105
106 /// If true, ignore errors about unknown modules.
107 std::optional<bool> ignoreUnknownModules;
108
109 /// If non-empty, specifies the list of modules that should serve as the top
110 /// modules in the design. If empty, this will be automatically determined
111 /// based on which modules are unreferenced elsewhere.
112 std::vector<std::string> topModules;
113
114 /// A list of top-level module parameters to override, of the form
115 /// `<name>=<value>`.
116 std::vector<std::string> paramOverrides;
117
118 //===--------------------------------------------------------------------===//
119 // Diagnostics Control
120 //===--------------------------------------------------------------------===//
121
122 /// The maximum number of errors to print before giving up.
123 std::optional<uint32_t> errorLimit;
124
125 /// A list of warning options that will be passed to the DiagnosticEngine.
126 std::vector<std::string> warningOptions;
127
128 /// A list of paths in which to suppress warnings.
129 std::vector<std::string> suppressWarningsPaths;
130
131 //===--------------------------------------------------------------------===//
132 // File lists
133 //===--------------------------------------------------------------------===//
134
135 /// If set to true, all source files will be treated as part of a single
136 /// compilation unit, meaning all of their text will be merged together.
137 std::optional<bool> singleUnit;
138
139 /// A list of library files to include in the compilation.
140 std::vector<std::string> libraryFiles;
141};
142
143/// Parse files in a source manager as Verilog source code and populate the
144/// given MLIR `module` with corresponding ops.
145mlir::LogicalResult
146importVerilog(llvm::SourceMgr &sourceMgr, mlir::MLIRContext *context,
147 mlir::TimingScope &ts, mlir::ModuleOp module,
148 const ImportVerilogOptions *options = nullptr);
149
150/// Run the files in a source manager through Slang's Verilog preprocessor and
151/// emit the result to the given output stream.
152mlir::LogicalResult
153preprocessVerilog(llvm::SourceMgr &sourceMgr, mlir::MLIRContext *context,
154 mlir::TimingScope &ts, llvm::raw_ostream &os,
155 const ImportVerilogOptions *options = nullptr);
156
157/// Register the `import-verilog` MLIR translation.
159
160/// Return a human-readable string describing the slang frontend version linked
161/// into CIRCT.
162std::string getSlangVersion();
163
164} // namespace circt
165
166#endif // CIRCT_CONVERSION_IMPORTVERILOG_H
The InstanceGraph op interface, see InstanceGraphInterface.td for more details.
std::string getSlangVersion()
Return a human-readable string describing the slang frontend version linked into CIRCT.
mlir::LogicalResult importVerilog(llvm::SourceMgr &sourceMgr, mlir::MLIRContext *context, mlir::TimingScope &ts, mlir::ModuleOp module, const ImportVerilogOptions *options=nullptr)
Parse files in a source manager as Verilog source code and populate the given MLIR module with corres...
mlir::LogicalResult preprocessVerilog(llvm::SourceMgr &sourceMgr, mlir::MLIRContext *context, mlir::TimingScope &ts, llvm::raw_ostream &os, const ImportVerilogOptions *options=nullptr)
Run the files in a source manager through Slang's Verilog preprocessor and emit the result to the giv...
void registerFromVerilogTranslation()
Register the import-verilog MLIR translation.
Options that control how Verilog input files are parsed and processed.
std::vector< std::string > libraryFiles
A list of library files to include in the compilation.
std::optional< bool > allowUseBeforeDeclare
If true, allow various to be referenced before they are declared.
std::optional< uint32_t > maxIncludeDepth
The maximum depth of included files before an error is issued.
std::vector< std::string > warningOptions
A list of warning options that will be passed to the DiagnosticEngine.
std::vector< std::string > ignoreDirectives
A list of preprocessor directives to be ignored.
std::vector< std::string > libExts
A list of extensions that will be used to search for library files.
std::optional< bool > librariesInheritMacros
If true, library files will inherit macro definitions from primary source files.
std::vector< std::string > defines
A list of macros that should be defined in each compilation unit.
bool lowerAlwaysAtStarAsComb
Interpret always @(*) as always_comb.
std::optional< bool > singleUnit
If set to true, all source files will be treated as part of a single compilation unit,...
std::vector< std::string > libDirs
A list of library directories in which to search for missing modules.
std::vector< std::string > suppressWarningsPaths
A list of paths in which to suppress warnings.
std::vector< std::string > includeSystemDirs
A list of system include directories in which to search for files.
std::vector< std::string > includeDirs
A list of include directories in which to search for files.
Mode
Limit importing to linting or parsing only.
@ OnlyLint
Only lint the input, without elaboration and lowering to CIRCT IR.
@ OnlyParse
Only parse and elaborate the input, without mapping to CIRCT IR.
@ Full
Perform a full import and mapping to CIRCT IR.
std::vector< std::string > undefines
A list of macros that should be undefined in each compilation unit.
std::vector< std::string > excludeExts
A list of extensions that will be used to exclude files.
std::vector< std::string > paramOverrides
A list of top-level module parameters to override, of the form <name>=<value>.
bool debugInfo
Generate debug information in the form of debug dialect ops in the IR.
std::optional< bool > ignoreUnknownModules
If true, ignore errors about unknown modules.
std::optional< std::string > timeScale
A string that indicates the default time scale to use for any design elements that don't specify one ...
std::vector< std::string > topModules
If non-empty, specifies the list of modules that should serve as the top modules in the design.
std::optional< uint32_t > errorLimit
The maximum number of errors to print before giving up.