1 //===- TableGen.cpp - Top-Level TableGen implementation for Clang ---------===//
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 // This file contains the main function for Clang's TableGen.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "TableGenBackends.h" // Declares all backends.
14 #include "ASTTableGen.h"
15 #include "llvm/Support/CommandLine.h"
16 #include "llvm/Support/PrettyStackTrace.h"
17 #include "llvm/Support/Signals.h"
18 #include "llvm/TableGen/Error.h"
19 #include "llvm/TableGen/Main.h"
20 #include "llvm/TableGen/Record.h"
21 
22 using namespace llvm;
23 using namespace clang;
24 
25 enum ActionType {
26   PrintRecords,
27   DumpJSON,
28   GenClangAttrClasses,
29   GenClangAttrParserStringSwitches,
30   GenClangAttrSubjectMatchRulesParserStringSwitches,
31   GenClangAttrImpl,
32   GenClangAttrList,
33   GenClangAttrSubjectMatchRuleList,
34   GenClangAttrPCHRead,
35   GenClangAttrPCHWrite,
36   GenClangAttrHasAttributeImpl,
37   GenClangAttrSpellingListIndex,
38   GenClangAttrASTVisitor,
39   GenClangAttrTemplateInstantiate,
40   GenClangAttrParsedAttrList,
41   GenClangAttrParsedAttrImpl,
42   GenClangAttrParsedAttrKinds,
43   GenClangAttrTextNodeDump,
44   GenClangAttrNodeTraverse,
45   GenClangBasicReader,
46   GenClangBasicWriter,
47   GenClangDiagsDefs,
48   GenClangDiagGroups,
49   GenClangDiagsIndexName,
50   GenClangCommentNodes,
51   GenClangDeclNodes,
52   GenClangStmtNodes,
53   GenClangTypeNodes,
54   GenClangTypeReader,
55   GenClangTypeWriter,
56   GenClangOpcodes,
57   GenClangSACheckers,
58   GenClangCommentHTMLTags,
59   GenClangCommentHTMLTagsProperties,
60   GenClangCommentHTMLNamedCharacterReferences,
61   GenClangCommentCommandInfo,
62   GenClangCommentCommandList,
63   GenClangOpenCLBuiltins,
64   GenArmNeon,
65   GenArmFP16,
66   GenArmNeonSema,
67   GenArmNeonTest,
68   GenArmMveHeader,
69   GenArmMveBuiltinDef,
70   GenArmMveBuiltinSema,
71   GenArmMveBuiltinCG,
72   GenArmMveBuiltinAliases,
73   GenArmSveHeader,
74   GenArmCdeHeader,
75   GenArmCdeBuiltinDef,
76   GenArmCdeBuiltinSema,
77   GenArmCdeBuiltinCG,
78   GenArmCdeBuiltinAliases,
79   GenAttrDocs,
80   GenDiagDocs,
81   GenOptDocs,
82   GenDataCollectors,
83   GenTestPragmaAttributeSupportedAttributes
84 };
85 
86 namespace {
87 cl::opt<ActionType> Action(
88     cl::desc("Action to perform:"),
89     cl::values(
90         clEnumValN(PrintRecords, "print-records",
91                    "Print all records to stdout (default)"),
92         clEnumValN(DumpJSON, "dump-json",
93                    "Dump all records as machine-readable JSON"),
94         clEnumValN(GenClangAttrClasses, "gen-clang-attr-classes",
95                    "Generate clang attribute clases"),
96         clEnumValN(GenClangAttrParserStringSwitches,
97                    "gen-clang-attr-parser-string-switches",
98                    "Generate all parser-related attribute string switches"),
99         clEnumValN(GenClangAttrSubjectMatchRulesParserStringSwitches,
100                    "gen-clang-attr-subject-match-rules-parser-string-switches",
101                    "Generate all parser-related attribute subject match rule"
102                    "string switches"),
103         clEnumValN(GenClangAttrImpl, "gen-clang-attr-impl",
104                    "Generate clang attribute implementations"),
105         clEnumValN(GenClangAttrList, "gen-clang-attr-list",
106                    "Generate a clang attribute list"),
107         clEnumValN(GenClangAttrSubjectMatchRuleList,
108                    "gen-clang-attr-subject-match-rule-list",
109                    "Generate a clang attribute subject match rule list"),
110         clEnumValN(GenClangAttrPCHRead, "gen-clang-attr-pch-read",
111                    "Generate clang PCH attribute reader"),
112         clEnumValN(GenClangAttrPCHWrite, "gen-clang-attr-pch-write",
113                    "Generate clang PCH attribute writer"),
114         clEnumValN(GenClangAttrHasAttributeImpl,
115                    "gen-clang-attr-has-attribute-impl",
116                    "Generate a clang attribute spelling list"),
117         clEnumValN(GenClangAttrSpellingListIndex,
118                    "gen-clang-attr-spelling-index",
119                    "Generate a clang attribute spelling index"),
120         clEnumValN(GenClangAttrASTVisitor, "gen-clang-attr-ast-visitor",
121                    "Generate a recursive AST visitor for clang attributes"),
122         clEnumValN(GenClangAttrTemplateInstantiate,
123                    "gen-clang-attr-template-instantiate",
124                    "Generate a clang template instantiate code"),
125         clEnumValN(GenClangAttrParsedAttrList,
126                    "gen-clang-attr-parsed-attr-list",
127                    "Generate a clang parsed attribute list"),
128         clEnumValN(GenClangAttrParsedAttrImpl,
129                    "gen-clang-attr-parsed-attr-impl",
130                    "Generate the clang parsed attribute helpers"),
131         clEnumValN(GenClangAttrParsedAttrKinds,
132                    "gen-clang-attr-parsed-attr-kinds",
133                    "Generate a clang parsed attribute kinds"),
134         clEnumValN(GenClangAttrTextNodeDump, "gen-clang-attr-text-node-dump",
135                    "Generate clang attribute text node dumper"),
136         clEnumValN(GenClangAttrNodeTraverse, "gen-clang-attr-node-traverse",
137                    "Generate clang attribute traverser"),
138         clEnumValN(GenClangDiagsDefs, "gen-clang-diags-defs",
139                    "Generate Clang diagnostics definitions"),
140         clEnumValN(GenClangDiagGroups, "gen-clang-diag-groups",
141                    "Generate Clang diagnostic groups"),
142         clEnumValN(GenClangDiagsIndexName, "gen-clang-diags-index-name",
143                    "Generate Clang diagnostic name index"),
144         clEnumValN(GenClangBasicReader, "gen-clang-basic-reader",
145                    "Generate Clang BasicReader classes"),
146         clEnumValN(GenClangBasicWriter, "gen-clang-basic-writer",
147                    "Generate Clang BasicWriter classes"),
148         clEnumValN(GenClangCommentNodes, "gen-clang-comment-nodes",
149                    "Generate Clang AST comment nodes"),
150         clEnumValN(GenClangDeclNodes, "gen-clang-decl-nodes",
151                    "Generate Clang AST declaration nodes"),
152         clEnumValN(GenClangStmtNodes, "gen-clang-stmt-nodes",
153                    "Generate Clang AST statement nodes"),
154         clEnumValN(GenClangTypeNodes, "gen-clang-type-nodes",
155                    "Generate Clang AST type nodes"),
156         clEnumValN(GenClangTypeReader, "gen-clang-type-reader",
157                    "Generate Clang AbstractTypeReader class"),
158         clEnumValN(GenClangTypeWriter, "gen-clang-type-writer",
159                    "Generate Clang AbstractTypeWriter class"),
160         clEnumValN(GenClangOpcodes, "gen-clang-opcodes",
161                    "Generate Clang constexpr interpreter opcodes"),
162         clEnumValN(GenClangSACheckers, "gen-clang-sa-checkers",
163                    "Generate Clang Static Analyzer checkers"),
164         clEnumValN(GenClangCommentHTMLTags, "gen-clang-comment-html-tags",
165                    "Generate efficient matchers for HTML tag "
166                    "names that are used in documentation comments"),
167         clEnumValN(GenClangCommentHTMLTagsProperties,
168                    "gen-clang-comment-html-tags-properties",
169                    "Generate efficient matchers for HTML tag "
170                    "properties"),
171         clEnumValN(GenClangCommentHTMLNamedCharacterReferences,
172                    "gen-clang-comment-html-named-character-references",
173                    "Generate function to translate named character "
174                    "references to UTF-8 sequences"),
175         clEnumValN(GenClangCommentCommandInfo, "gen-clang-comment-command-info",
176                    "Generate command properties for commands that "
177                    "are used in documentation comments"),
178         clEnumValN(GenClangCommentCommandList, "gen-clang-comment-command-list",
179                    "Generate list of commands that are used in "
180                    "documentation comments"),
181         clEnumValN(GenClangOpenCLBuiltins, "gen-clang-opencl-builtins",
182                    "Generate OpenCL builtin declaration handlers"),
183         clEnumValN(GenArmNeon, "gen-arm-neon", "Generate arm_neon.h for clang"),
184         clEnumValN(GenArmFP16, "gen-arm-fp16", "Generate arm_fp16.h for clang"),
185         clEnumValN(GenArmNeonSema, "gen-arm-neon-sema",
186                    "Generate ARM NEON sema support for clang"),
187         clEnumValN(GenArmNeonTest, "gen-arm-neon-test",
188                    "Generate ARM NEON tests for clang"),
189         clEnumValN(GenArmSveHeader, "gen-arm-sve-header",
190                    "Generate arm_sve.h for clang"),
191         clEnumValN(GenArmMveHeader, "gen-arm-mve-header",
192                    "Generate arm_mve.h for clang"),
193         clEnumValN(GenArmMveBuiltinDef, "gen-arm-mve-builtin-def",
194                    "Generate ARM MVE builtin definitions for clang"),
195         clEnumValN(GenArmMveBuiltinSema, "gen-arm-mve-builtin-sema",
196                    "Generate ARM MVE builtin sema checks for clang"),
197         clEnumValN(GenArmMveBuiltinCG, "gen-arm-mve-builtin-codegen",
198                    "Generate ARM MVE builtin code-generator for clang"),
199         clEnumValN(GenArmMveBuiltinAliases, "gen-arm-mve-builtin-aliases",
200                    "Generate list of valid ARM MVE builtin aliases for clang"),
201         clEnumValN(GenArmCdeHeader, "gen-arm-cde-header",
202                    "Generate arm_cde.h for clang"),
203         clEnumValN(GenArmCdeBuiltinDef, "gen-arm-cde-builtin-def",
204                    "Generate ARM CDE builtin definitions for clang"),
205         clEnumValN(GenArmCdeBuiltinSema, "gen-arm-cde-builtin-sema",
206                    "Generate ARM CDE builtin sema checks for clang"),
207         clEnumValN(GenArmCdeBuiltinCG, "gen-arm-cde-builtin-codegen",
208                    "Generate ARM CDE builtin code-generator for clang"),
209         clEnumValN(GenArmCdeBuiltinAliases, "gen-arm-cde-builtin-aliases",
210                    "Generate list of valid ARM CDE builtin aliases for clang"),
211         clEnumValN(GenAttrDocs, "gen-attr-docs",
212                    "Generate attribute documentation"),
213         clEnumValN(GenDiagDocs, "gen-diag-docs",
214                    "Generate diagnostic documentation"),
215         clEnumValN(GenOptDocs, "gen-opt-docs", "Generate option documentation"),
216         clEnumValN(GenDataCollectors, "gen-clang-data-collectors",
217                    "Generate data collectors for AST nodes"),
218         clEnumValN(GenTestPragmaAttributeSupportedAttributes,
219                    "gen-clang-test-pragma-attribute-supported-attributes",
220                    "Generate a list of attributes supported by #pragma clang "
221                    "attribute for testing purposes")));
222 
223 cl::opt<std::string>
224 ClangComponent("clang-component",
225                cl::desc("Only use warnings from specified component"),
226                cl::value_desc("component"), cl::Hidden);
227 
228 bool ClangTableGenMain(raw_ostream &OS, RecordKeeper &Records) {
229   switch (Action) {
230   case PrintRecords:
231     OS << Records;           // No argument, dump all contents
232     break;
233   case DumpJSON:
234     EmitJSON(Records, OS);
235     break;
236   case GenClangAttrClasses:
237     EmitClangAttrClass(Records, OS);
238     break;
239   case GenClangAttrParserStringSwitches:
240     EmitClangAttrParserStringSwitches(Records, OS);
241     break;
242   case GenClangAttrSubjectMatchRulesParserStringSwitches:
243     EmitClangAttrSubjectMatchRulesParserStringSwitches(Records, OS);
244     break;
245   case GenClangAttrImpl:
246     EmitClangAttrImpl(Records, OS);
247     break;
248   case GenClangAttrList:
249     EmitClangAttrList(Records, OS);
250     break;
251   case GenClangAttrSubjectMatchRuleList:
252     EmitClangAttrSubjectMatchRuleList(Records, OS);
253     break;
254   case GenClangAttrPCHRead:
255     EmitClangAttrPCHRead(Records, OS);
256     break;
257   case GenClangAttrPCHWrite:
258     EmitClangAttrPCHWrite(Records, OS);
259     break;
260   case GenClangAttrHasAttributeImpl:
261     EmitClangAttrHasAttrImpl(Records, OS);
262     break;
263   case GenClangAttrSpellingListIndex:
264     EmitClangAttrSpellingListIndex(Records, OS);
265     break;
266   case GenClangAttrASTVisitor:
267     EmitClangAttrASTVisitor(Records, OS);
268     break;
269   case GenClangAttrTemplateInstantiate:
270     EmitClangAttrTemplateInstantiate(Records, OS);
271     break;
272   case GenClangAttrParsedAttrList:
273     EmitClangAttrParsedAttrList(Records, OS);
274     break;
275   case GenClangAttrParsedAttrImpl:
276     EmitClangAttrParsedAttrImpl(Records, OS);
277     break;
278   case GenClangAttrParsedAttrKinds:
279     EmitClangAttrParsedAttrKinds(Records, OS);
280     break;
281   case GenClangAttrTextNodeDump:
282     EmitClangAttrTextNodeDump(Records, OS);
283     break;
284   case GenClangAttrNodeTraverse:
285     EmitClangAttrNodeTraverse(Records, OS);
286     break;
287   case GenClangDiagsDefs:
288     EmitClangDiagsDefs(Records, OS, ClangComponent);
289     break;
290   case GenClangDiagGroups:
291     EmitClangDiagGroups(Records, OS);
292     break;
293   case GenClangDiagsIndexName:
294     EmitClangDiagsIndexName(Records, OS);
295     break;
296   case GenClangCommentNodes:
297     EmitClangASTNodes(Records, OS, CommentNodeClassName, "");
298     break;
299   case GenClangDeclNodes:
300     EmitClangASTNodes(Records, OS, DeclNodeClassName, "Decl");
301     EmitClangDeclContext(Records, OS);
302     break;
303   case GenClangStmtNodes:
304     EmitClangASTNodes(Records, OS, StmtNodeClassName, "");
305     break;
306   case GenClangTypeNodes:
307     EmitClangTypeNodes(Records, OS);
308     break;
309   case GenClangTypeReader:
310     EmitClangTypeReader(Records, OS);
311     break;
312   case GenClangTypeWriter:
313     EmitClangTypeWriter(Records, OS);
314     break;
315   case GenClangBasicReader:
316     EmitClangBasicReader(Records, OS);
317     break;
318   case GenClangBasicWriter:
319     EmitClangBasicWriter(Records, OS);
320     break;
321   case GenClangOpcodes:
322     EmitClangOpcodes(Records, OS);
323     break;
324   case GenClangSACheckers:
325     EmitClangSACheckers(Records, OS);
326     break;
327   case GenClangCommentHTMLTags:
328     EmitClangCommentHTMLTags(Records, OS);
329     break;
330   case GenClangCommentHTMLTagsProperties:
331     EmitClangCommentHTMLTagsProperties(Records, OS);
332     break;
333   case GenClangCommentHTMLNamedCharacterReferences:
334     EmitClangCommentHTMLNamedCharacterReferences(Records, OS);
335     break;
336   case GenClangCommentCommandInfo:
337     EmitClangCommentCommandInfo(Records, OS);
338     break;
339   case GenClangCommentCommandList:
340     EmitClangCommentCommandList(Records, OS);
341     break;
342   case GenClangOpenCLBuiltins:
343     EmitClangOpenCLBuiltins(Records, OS);
344     break;
345   case GenArmNeon:
346     EmitNeon(Records, OS);
347     break;
348   case GenArmFP16:
349     EmitFP16(Records, OS);
350     break;
351   case GenArmNeonSema:
352     EmitNeonSema(Records, OS);
353     break;
354   case GenArmNeonTest:
355     EmitNeonTest(Records, OS);
356     break;
357   case GenArmMveHeader:
358     EmitMveHeader(Records, OS);
359     break;
360   case GenArmMveBuiltinDef:
361     EmitMveBuiltinDef(Records, OS);
362     break;
363   case GenArmMveBuiltinSema:
364     EmitMveBuiltinSema(Records, OS);
365     break;
366   case GenArmMveBuiltinCG:
367     EmitMveBuiltinCG(Records, OS);
368     break;
369   case GenArmMveBuiltinAliases:
370     EmitMveBuiltinAliases(Records, OS);
371     break;
372   case GenArmSveHeader:
373     EmitSveHeader(Records, OS);
374     break;
375   case GenArmCdeHeader:
376     EmitCdeHeader(Records, OS);
377     break;
378   case GenArmCdeBuiltinDef:
379     EmitCdeBuiltinDef(Records, OS);
380     break;
381   case GenArmCdeBuiltinSema:
382     EmitCdeBuiltinSema(Records, OS);
383     break;
384   case GenArmCdeBuiltinCG:
385     EmitCdeBuiltinCG(Records, OS);
386     break;
387   case GenArmCdeBuiltinAliases:
388     EmitCdeBuiltinAliases(Records, OS);
389     break;
390   case GenAttrDocs:
391     EmitClangAttrDocs(Records, OS);
392     break;
393   case GenDiagDocs:
394     EmitClangDiagDocs(Records, OS);
395     break;
396   case GenOptDocs:
397     EmitClangOptDocs(Records, OS);
398     break;
399   case GenDataCollectors:
400     EmitClangDataCollectors(Records, OS);
401     break;
402   case GenTestPragmaAttributeSupportedAttributes:
403     EmitTestPragmaAttributeSupportedAttributes(Records, OS);
404     break;
405   }
406 
407   return false;
408 }
409 }
410 
411 int main(int argc, char **argv) {
412   sys::PrintStackTraceOnErrorSignal(argv[0]);
413   PrettyStackTraceProgram X(argc, argv);
414   cl::ParseCommandLineOptions(argc, argv);
415 
416   llvm_shutdown_obj Y;
417 
418   return TableGenMain(argv[0], &ClangTableGenMain);
419 }
420 
421 #ifdef __has_feature
422 #if __has_feature(address_sanitizer)
423 #include <sanitizer/lsan_interface.h>
424 // Disable LeakSanitizer for this binary as it has too many leaks that are not
425 // very interesting to fix. See compiler-rt/include/sanitizer/lsan_interface.h .
426 int __lsan_is_turned_off() { return 1; }
427 #endif  // __has_feature(address_sanitizer)
428 #endif  // defined(__has_feature)
429