1 //===- AttrOrTypeDef.cpp - AttrOrTypeDef wrapper classes ------------------===//
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 #include "mlir/TableGen/AttrOrTypeDef.h"
10 #include "mlir/TableGen/Dialect.h"
11 #include "llvm/ADT/SmallPtrSet.h"
12 #include "llvm/ADT/StringExtras.h"
13 #include "llvm/TableGen/Error.h"
14 #include "llvm/TableGen/Record.h"
15 
16 using namespace mlir;
17 using namespace mlir::tblgen;
18 
19 //===----------------------------------------------------------------------===//
20 // AttrOrTypeBuilder
21 //===----------------------------------------------------------------------===//
22 
23 Optional<StringRef> AttrOrTypeBuilder::getReturnType() const {
24   Optional<StringRef> type = def->getValueAsOptionalString("returnType");
25   return type && !type->empty() ? type : llvm::None;
26 }
27 
28 bool AttrOrTypeBuilder::hasInferredContextParameter() const {
29   return def->getValueAsBit("hasInferredContextParam");
30 }
31 
32 //===----------------------------------------------------------------------===//
33 // AttrOrTypeDef
34 //===----------------------------------------------------------------------===//
35 
36 AttrOrTypeDef::AttrOrTypeDef(const llvm::Record *def) : def(def) {
37   // Populate the builders.
38   auto *builderList =
39       dyn_cast_or_null<llvm::ListInit>(def->getValueInit("builders"));
40   if (builderList && !builderList->empty()) {
41     for (llvm::Init *init : builderList->getValues()) {
42       AttrOrTypeBuilder builder(cast<llvm::DefInit>(init)->getDef(),
43                                 def->getLoc());
44 
45       // Ensure that all parameters have names.
46       for (const AttrOrTypeBuilder::Parameter &param :
47            builder.getParameters()) {
48         if (!param.getName())
49           PrintFatalError(def->getLoc(), "builder parameters must have a name");
50       }
51       builders.emplace_back(builder);
52     }
53   }
54 
55   // Populate the traits.
56   if (auto *traitList = def->getValueAsListInit("traits")) {
57     SmallPtrSet<const llvm::Init *, 32> traitSet;
58     traits.reserve(traitSet.size());
59     for (auto *traitInit : *traitList)
60       if (traitSet.insert(traitInit).second)
61         traits.push_back(Trait::create(traitInit));
62   }
63 
64   // Populate the parameters.
65   if (auto *parametersDag = def->getValueAsDag("parameters")) {
66     for (unsigned i = 0, e = parametersDag->getNumArgs(); i < e; ++i)
67       parameters.push_back(AttrOrTypeParameter(parametersDag, i));
68   }
69 
70   // Verify the use of the mnemonic field.
71   bool hasCppFormat = hasCustomAssemblyFormat();
72   bool hasDeclarativeFormat = getAssemblyFormat().has_value();
73   if (getMnemonic()) {
74     if (hasCppFormat && hasDeclarativeFormat) {
75       PrintFatalError(getLoc(), "cannot specify both 'assemblyFormat' "
76                                 "and 'hasCustomAssemblyFormat'");
77     }
78     if (!parameters.empty() && !hasCppFormat && !hasDeclarativeFormat) {
79       PrintFatalError(getLoc(),
80                       "must specify either 'assemblyFormat' or "
81                       "'hasCustomAssemblyFormat' when 'mnemonic' is set");
82     }
83   } else if (hasCppFormat || hasDeclarativeFormat) {
84     PrintFatalError(getLoc(),
85                     "'assemblyFormat' or 'hasCustomAssemblyFormat' can only be "
86                     "used when 'mnemonic' is set");
87   }
88   // Assembly format printer requires accessors to be generated.
89   if (hasDeclarativeFormat && !genAccessors()) {
90     PrintFatalError(getLoc(),
91                     "'assemblyFormat' requires 'genAccessors' to be true");
92   }
93 }
94 
95 Dialect AttrOrTypeDef::getDialect() const {
96   auto *dialect = dyn_cast<llvm::DefInit>(def->getValue("dialect")->getValue());
97   return Dialect(dialect ? dialect->getDef() : nullptr);
98 }
99 
100 StringRef AttrOrTypeDef::getName() const { return def->getName(); }
101 
102 StringRef AttrOrTypeDef::getCppClassName() const {
103   return def->getValueAsString("cppClassName");
104 }
105 
106 StringRef AttrOrTypeDef::getCppBaseClassName() const {
107   return def->getValueAsString("cppBaseClassName");
108 }
109 
110 bool AttrOrTypeDef::hasDescription() const {
111   const llvm::RecordVal *desc = def->getValue("description");
112   return desc && isa<llvm::StringInit>(desc->getValue());
113 }
114 
115 StringRef AttrOrTypeDef::getDescription() const {
116   return def->getValueAsString("description");
117 }
118 
119 bool AttrOrTypeDef::hasSummary() const {
120   const llvm::RecordVal *summary = def->getValue("summary");
121   return summary && isa<llvm::StringInit>(summary->getValue());
122 }
123 
124 StringRef AttrOrTypeDef::getSummary() const {
125   return def->getValueAsString("summary");
126 }
127 
128 StringRef AttrOrTypeDef::getStorageClassName() const {
129   return def->getValueAsString("storageClass");
130 }
131 
132 StringRef AttrOrTypeDef::getStorageNamespace() const {
133   return def->getValueAsString("storageNamespace");
134 }
135 
136 bool AttrOrTypeDef::genStorageClass() const {
137   return def->getValueAsBit("genStorageClass");
138 }
139 
140 bool AttrOrTypeDef::hasStorageCustomConstructor() const {
141   return def->getValueAsBit("hasStorageCustomConstructor");
142 }
143 
144 unsigned AttrOrTypeDef::getNumParameters() const {
145   auto *parametersDag = def->getValueAsDag("parameters");
146   return parametersDag ? parametersDag->getNumArgs() : 0;
147 }
148 
149 Optional<StringRef> AttrOrTypeDef::getMnemonic() const {
150   return def->getValueAsOptionalString("mnemonic");
151 }
152 
153 bool AttrOrTypeDef::hasCustomAssemblyFormat() const {
154   return def->getValueAsBit("hasCustomAssemblyFormat");
155 }
156 
157 Optional<StringRef> AttrOrTypeDef::getAssemblyFormat() const {
158   return def->getValueAsOptionalString("assemblyFormat");
159 }
160 
161 bool AttrOrTypeDef::genAccessors() const {
162   return def->getValueAsBit("genAccessors");
163 }
164 
165 bool AttrOrTypeDef::genVerifyDecl() const {
166   return def->getValueAsBit("genVerifyDecl");
167 }
168 
169 Optional<StringRef> AttrOrTypeDef::getExtraDecls() const {
170   auto value = def->getValueAsString("extraClassDeclaration");
171   return value.empty() ? Optional<StringRef>() : value;
172 }
173 
174 Optional<StringRef> AttrOrTypeDef::getExtraDefs() const {
175   auto value = def->getValueAsString("extraClassDefinition");
176   return value.empty() ? Optional<StringRef>() : value;
177 }
178 
179 ArrayRef<SMLoc> AttrOrTypeDef::getLoc() const { return def->getLoc(); }
180 
181 bool AttrOrTypeDef::skipDefaultBuilders() const {
182   return def->getValueAsBit("skipDefaultBuilders");
183 }
184 
185 bool AttrOrTypeDef::operator==(const AttrOrTypeDef &other) const {
186   return def == other.def;
187 }
188 
189 bool AttrOrTypeDef::operator<(const AttrOrTypeDef &other) const {
190   return getName() < other.getName();
191 }
192 
193 //===----------------------------------------------------------------------===//
194 // AttrDef
195 //===----------------------------------------------------------------------===//
196 
197 Optional<StringRef> AttrDef::getTypeBuilder() const {
198   return def->getValueAsOptionalString("typeBuilder");
199 }
200 
201 bool AttrDef::classof(const AttrOrTypeDef *def) {
202   return def->getDef()->isSubClassOf("AttrDef");
203 }
204 
205 //===----------------------------------------------------------------------===//
206 // AttrOrTypeParameter
207 //===----------------------------------------------------------------------===//
208 
209 template <typename InitT>
210 auto AttrOrTypeParameter::getDefValue(StringRef name) const {
211   Optional<decltype(std::declval<InitT>().getValue())> result;
212   if (auto *param = dyn_cast<llvm::DefInit>(getDef()))
213     if (auto *init = param->getDef()->getValue(name))
214       if (auto *value = dyn_cast_or_null<InitT>(init->getValue()))
215         result = value->getValue();
216   return result;
217 }
218 
219 bool AttrOrTypeParameter::isAnonymous() const {
220   return !def->getArgName(index);
221 }
222 
223 StringRef AttrOrTypeParameter::getName() const {
224   return def->getArgName(index)->getValue();
225 }
226 
227 std::string AttrOrTypeParameter::getAccessorName() const {
228   return "get" +
229          llvm::convertToCamelFromSnakeCase(getName(), /*capitalizeFirst=*/true);
230 }
231 
232 Optional<StringRef> AttrOrTypeParameter::getAllocator() const {
233   return getDefValue<llvm::StringInit>("allocator");
234 }
235 
236 StringRef AttrOrTypeParameter::getComparator() const {
237   return getDefValue<llvm::StringInit>("comparator").value_or("$_lhs == $_rhs");
238 }
239 
240 StringRef AttrOrTypeParameter::getCppType() const {
241   if (auto *stringType = dyn_cast<llvm::StringInit>(getDef()))
242     return stringType->getValue();
243   return getDefValue<llvm::StringInit>("cppType").value();
244 }
245 
246 StringRef AttrOrTypeParameter::getCppAccessorType() const {
247   return getDefValue<llvm::StringInit>("cppAccessorType")
248       .value_or(getCppType());
249 }
250 
251 StringRef AttrOrTypeParameter::getCppStorageType() const {
252   return getDefValue<llvm::StringInit>("cppStorageType").value_or(getCppType());
253 }
254 
255 StringRef AttrOrTypeParameter::getConvertFromStorage() const {
256   return getDefValue<llvm::StringInit>("convertFromStorage").value_or("$_self");
257 }
258 
259 Optional<StringRef> AttrOrTypeParameter::getParser() const {
260   return getDefValue<llvm::StringInit>("parser");
261 }
262 
263 Optional<StringRef> AttrOrTypeParameter::getPrinter() const {
264   return getDefValue<llvm::StringInit>("printer");
265 }
266 
267 Optional<StringRef> AttrOrTypeParameter::getSummary() const {
268   return getDefValue<llvm::StringInit>("summary");
269 }
270 
271 StringRef AttrOrTypeParameter::getSyntax() const {
272   if (auto *stringType = dyn_cast<llvm::StringInit>(getDef()))
273     return stringType->getValue();
274   return getDefValue<llvm::StringInit>("syntax").value_or(getCppType());
275 }
276 
277 bool AttrOrTypeParameter::isOptional() const {
278   // Parameters with default values are automatically optional.
279   return getDefValue<llvm::BitInit>("isOptional").value_or(false) ||
280          getDefaultValue();
281 }
282 
283 Optional<StringRef> AttrOrTypeParameter::getDefaultValue() const {
284   return getDefValue<llvm::StringInit>("defaultValue");
285 }
286 
287 llvm::Init *AttrOrTypeParameter::getDef() const { return def->getArg(index); }
288 
289 //===----------------------------------------------------------------------===//
290 // AttributeSelfTypeParameter
291 //===----------------------------------------------------------------------===//
292 
293 bool AttributeSelfTypeParameter::classof(const AttrOrTypeParameter *param) {
294   llvm::Init *paramDef = param->getDef();
295   if (auto *paramDefInit = dyn_cast<llvm::DefInit>(paramDef))
296     return paramDefInit->getDef()->isSubClassOf("AttributeSelfTypeParameter");
297   return false;
298 }
299